appmesh.d.ts 134 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class AppMesh extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: AppMesh.Types.ClientConfiguration)
  13. config: Config & AppMesh.Types.ClientConfiguration;
  14. /**
  15. * Creates a gateway route. A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service. For more information about gateway routes, see Gateway routes.
  16. */
  17. createGatewayRoute(params: AppMesh.Types.CreateGatewayRouteInput, callback?: (err: AWSError, data: AppMesh.Types.CreateGatewayRouteOutput) => void): Request<AppMesh.Types.CreateGatewayRouteOutput, AWSError>;
  18. /**
  19. * Creates a gateway route. A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service. For more information about gateway routes, see Gateway routes.
  20. */
  21. createGatewayRoute(callback?: (err: AWSError, data: AppMesh.Types.CreateGatewayRouteOutput) => void): Request<AppMesh.Types.CreateGatewayRouteOutput, AWSError>;
  22. /**
  23. * Creates a service mesh. A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. For more information about service meshes, see Service meshes.
  24. */
  25. createMesh(params: AppMesh.Types.CreateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
  26. /**
  27. * Creates a service mesh. A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. For more information about service meshes, see Service meshes.
  28. */
  29. createMesh(callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
  30. /**
  31. * Creates a route that is associated with a virtual router. You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes. For more information about routes, see Routes.
  32. */
  33. createRoute(params: AppMesh.Types.CreateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
  34. /**
  35. * Creates a route that is associated with a virtual router. You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes. For more information about routes, see Routes.
  36. */
  37. createRoute(callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
  38. /**
  39. * Creates a virtual gateway. A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself. For more information about virtual gateways, see Virtual gateways.
  40. */
  41. createVirtualGateway(params: AppMesh.Types.CreateVirtualGatewayInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualGatewayOutput) => void): Request<AppMesh.Types.CreateVirtualGatewayOutput, AWSError>;
  42. /**
  43. * Creates a virtual gateway. A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself. For more information about virtual gateways, see Virtual gateways.
  44. */
  45. createVirtualGateway(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualGatewayOutput) => void): Request<AppMesh.Types.CreateVirtualGatewayOutput, AWSError>;
  46. /**
  47. * Creates a virtual node within a service mesh. A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS). You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend. The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters. By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name. For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the App Mesh User Guide.
  48. */
  49. createVirtualNode(params: AppMesh.Types.CreateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
  50. /**
  51. * Creates a virtual node within a service mesh. A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS). You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend. The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters. By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name. For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the App Mesh User Guide.
  52. */
  53. createVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
  54. /**
  55. * Creates a virtual router within a service mesh. Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes. For more information about virtual routers, see Virtual routers.
  56. */
  57. createVirtualRouter(params: AppMesh.Types.CreateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
  58. /**
  59. * Creates a virtual router within a service mesh. Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes. For more information about virtual routers, see Virtual routers.
  60. */
  61. createVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
  62. /**
  63. * Creates a virtual service within a service mesh. A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. For more information about virtual services, see Virtual services.
  64. */
  65. createVirtualService(params: AppMesh.Types.CreateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
  66. /**
  67. * Creates a virtual service within a service mesh. A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. For more information about virtual services, see Virtual services.
  68. */
  69. createVirtualService(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
  70. /**
  71. * Deletes an existing gateway route.
  72. */
  73. deleteGatewayRoute(params: AppMesh.Types.DeleteGatewayRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteGatewayRouteOutput) => void): Request<AppMesh.Types.DeleteGatewayRouteOutput, AWSError>;
  74. /**
  75. * Deletes an existing gateway route.
  76. */
  77. deleteGatewayRoute(callback?: (err: AWSError, data: AppMesh.Types.DeleteGatewayRouteOutput) => void): Request<AppMesh.Types.DeleteGatewayRouteOutput, AWSError>;
  78. /**
  79. * Deletes an existing service mesh. You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
  80. */
  81. deleteMesh(params: AppMesh.Types.DeleteMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
  82. /**
  83. * Deletes an existing service mesh. You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
  84. */
  85. deleteMesh(callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
  86. /**
  87. * Deletes an existing route.
  88. */
  89. deleteRoute(params: AppMesh.Types.DeleteRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
  90. /**
  91. * Deletes an existing route.
  92. */
  93. deleteRoute(callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
  94. /**
  95. * Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
  96. */
  97. deleteVirtualGateway(params: AppMesh.Types.DeleteVirtualGatewayInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualGatewayOutput) => void): Request<AppMesh.Types.DeleteVirtualGatewayOutput, AWSError>;
  98. /**
  99. * Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
  100. */
  101. deleteVirtualGateway(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualGatewayOutput) => void): Request<AppMesh.Types.DeleteVirtualGatewayOutput, AWSError>;
  102. /**
  103. * Deletes an existing virtual node. You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
  104. */
  105. deleteVirtualNode(params: AppMesh.Types.DeleteVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
  106. /**
  107. * Deletes an existing virtual node. You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
  108. */
  109. deleteVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
  110. /**
  111. * Deletes an existing virtual router. You must delete any routes associated with the virtual router before you can delete the router itself.
  112. */
  113. deleteVirtualRouter(params: AppMesh.Types.DeleteVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
  114. /**
  115. * Deletes an existing virtual router. You must delete any routes associated with the virtual router before you can delete the router itself.
  116. */
  117. deleteVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
  118. /**
  119. * Deletes an existing virtual service.
  120. */
  121. deleteVirtualService(params: AppMesh.Types.DeleteVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
  122. /**
  123. * Deletes an existing virtual service.
  124. */
  125. deleteVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
  126. /**
  127. * Describes an existing gateway route.
  128. */
  129. describeGatewayRoute(params: AppMesh.Types.DescribeGatewayRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeGatewayRouteOutput) => void): Request<AppMesh.Types.DescribeGatewayRouteOutput, AWSError>;
  130. /**
  131. * Describes an existing gateway route.
  132. */
  133. describeGatewayRoute(callback?: (err: AWSError, data: AppMesh.Types.DescribeGatewayRouteOutput) => void): Request<AppMesh.Types.DescribeGatewayRouteOutput, AWSError>;
  134. /**
  135. * Describes an existing service mesh.
  136. */
  137. describeMesh(params: AppMesh.Types.DescribeMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
  138. /**
  139. * Describes an existing service mesh.
  140. */
  141. describeMesh(callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
  142. /**
  143. * Describes an existing route.
  144. */
  145. describeRoute(params: AppMesh.Types.DescribeRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
  146. /**
  147. * Describes an existing route.
  148. */
  149. describeRoute(callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
  150. /**
  151. * Describes an existing virtual gateway.
  152. */
  153. describeVirtualGateway(params: AppMesh.Types.DescribeVirtualGatewayInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualGatewayOutput) => void): Request<AppMesh.Types.DescribeVirtualGatewayOutput, AWSError>;
  154. /**
  155. * Describes an existing virtual gateway.
  156. */
  157. describeVirtualGateway(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualGatewayOutput) => void): Request<AppMesh.Types.DescribeVirtualGatewayOutput, AWSError>;
  158. /**
  159. * Describes an existing virtual node.
  160. */
  161. describeVirtualNode(params: AppMesh.Types.DescribeVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
  162. /**
  163. * Describes an existing virtual node.
  164. */
  165. describeVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
  166. /**
  167. * Describes an existing virtual router.
  168. */
  169. describeVirtualRouter(params: AppMesh.Types.DescribeVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
  170. /**
  171. * Describes an existing virtual router.
  172. */
  173. describeVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
  174. /**
  175. * Describes an existing virtual service.
  176. */
  177. describeVirtualService(params: AppMesh.Types.DescribeVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
  178. /**
  179. * Describes an existing virtual service.
  180. */
  181. describeVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
  182. /**
  183. * Returns a list of existing gateway routes that are associated to a virtual gateway.
  184. */
  185. listGatewayRoutes(params: AppMesh.Types.ListGatewayRoutesInput, callback?: (err: AWSError, data: AppMesh.Types.ListGatewayRoutesOutput) => void): Request<AppMesh.Types.ListGatewayRoutesOutput, AWSError>;
  186. /**
  187. * Returns a list of existing gateway routes that are associated to a virtual gateway.
  188. */
  189. listGatewayRoutes(callback?: (err: AWSError, data: AppMesh.Types.ListGatewayRoutesOutput) => void): Request<AppMesh.Types.ListGatewayRoutesOutput, AWSError>;
  190. /**
  191. * Returns a list of existing service meshes.
  192. */
  193. listMeshes(params: AppMesh.Types.ListMeshesInput, callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
  194. /**
  195. * Returns a list of existing service meshes.
  196. */
  197. listMeshes(callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
  198. /**
  199. * Returns a list of existing routes in a service mesh.
  200. */
  201. listRoutes(params: AppMesh.Types.ListRoutesInput, callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
  202. /**
  203. * Returns a list of existing routes in a service mesh.
  204. */
  205. listRoutes(callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
  206. /**
  207. * List the tags for an App Mesh resource.
  208. */
  209. listTagsForResource(params: AppMesh.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
  210. /**
  211. * List the tags for an App Mesh resource.
  212. */
  213. listTagsForResource(callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
  214. /**
  215. * Returns a list of existing virtual gateways in a service mesh.
  216. */
  217. listVirtualGateways(params: AppMesh.Types.ListVirtualGatewaysInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualGatewaysOutput) => void): Request<AppMesh.Types.ListVirtualGatewaysOutput, AWSError>;
  218. /**
  219. * Returns a list of existing virtual gateways in a service mesh.
  220. */
  221. listVirtualGateways(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualGatewaysOutput) => void): Request<AppMesh.Types.ListVirtualGatewaysOutput, AWSError>;
  222. /**
  223. * Returns a list of existing virtual nodes.
  224. */
  225. listVirtualNodes(params: AppMesh.Types.ListVirtualNodesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
  226. /**
  227. * Returns a list of existing virtual nodes.
  228. */
  229. listVirtualNodes(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
  230. /**
  231. * Returns a list of existing virtual routers in a service mesh.
  232. */
  233. listVirtualRouters(params: AppMesh.Types.ListVirtualRoutersInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
  234. /**
  235. * Returns a list of existing virtual routers in a service mesh.
  236. */
  237. listVirtualRouters(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
  238. /**
  239. * Returns a list of existing virtual services in a service mesh.
  240. */
  241. listVirtualServices(params: AppMesh.Types.ListVirtualServicesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
  242. /**
  243. * Returns a list of existing virtual services in a service mesh.
  244. */
  245. listVirtualServices(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
  246. /**
  247. * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
  248. */
  249. tagResource(params: AppMesh.Types.TagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
  250. /**
  251. * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
  252. */
  253. tagResource(callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
  254. /**
  255. * Deletes specified tags from a resource.
  256. */
  257. untagResource(params: AppMesh.Types.UntagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
  258. /**
  259. * Deletes specified tags from a resource.
  260. */
  261. untagResource(callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
  262. /**
  263. * Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
  264. */
  265. updateGatewayRoute(params: AppMesh.Types.UpdateGatewayRouteInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateGatewayRouteOutput) => void): Request<AppMesh.Types.UpdateGatewayRouteOutput, AWSError>;
  266. /**
  267. * Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
  268. */
  269. updateGatewayRoute(callback?: (err: AWSError, data: AppMesh.Types.UpdateGatewayRouteOutput) => void): Request<AppMesh.Types.UpdateGatewayRouteOutput, AWSError>;
  270. /**
  271. * Updates an existing service mesh.
  272. */
  273. updateMesh(params: AppMesh.Types.UpdateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
  274. /**
  275. * Updates an existing service mesh.
  276. */
  277. updateMesh(callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
  278. /**
  279. * Updates an existing route for a specified service mesh and virtual router.
  280. */
  281. updateRoute(params: AppMesh.Types.UpdateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
  282. /**
  283. * Updates an existing route for a specified service mesh and virtual router.
  284. */
  285. updateRoute(callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
  286. /**
  287. * Updates an existing virtual gateway in a specified service mesh.
  288. */
  289. updateVirtualGateway(params: AppMesh.Types.UpdateVirtualGatewayInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualGatewayOutput) => void): Request<AppMesh.Types.UpdateVirtualGatewayOutput, AWSError>;
  290. /**
  291. * Updates an existing virtual gateway in a specified service mesh.
  292. */
  293. updateVirtualGateway(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualGatewayOutput) => void): Request<AppMesh.Types.UpdateVirtualGatewayOutput, AWSError>;
  294. /**
  295. * Updates an existing virtual node in a specified service mesh.
  296. */
  297. updateVirtualNode(params: AppMesh.Types.UpdateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
  298. /**
  299. * Updates an existing virtual node in a specified service mesh.
  300. */
  301. updateVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
  302. /**
  303. * Updates an existing virtual router in a specified service mesh.
  304. */
  305. updateVirtualRouter(params: AppMesh.Types.UpdateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
  306. /**
  307. * Updates an existing virtual router in a specified service mesh.
  308. */
  309. updateVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
  310. /**
  311. * Updates an existing virtual service in a specified service mesh.
  312. */
  313. updateVirtualService(params: AppMesh.Types.UpdateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
  314. /**
  315. * Updates an existing virtual service in a specified service mesh.
  316. */
  317. updateVirtualService(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
  318. }
  319. declare namespace AppMesh {
  320. export interface AccessLog {
  321. /**
  322. * The file object to send virtual node access logs to.
  323. */
  324. file?: FileAccessLog;
  325. }
  326. export type AccountId = string;
  327. export type Arn = string;
  328. export interface AwsCloudMapInstanceAttribute {
  329. /**
  330. * The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
  331. */
  332. key: AwsCloudMapInstanceAttributeKey;
  333. /**
  334. * The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
  335. */
  336. value: AwsCloudMapInstanceAttributeValue;
  337. }
  338. export type AwsCloudMapInstanceAttributeKey = string;
  339. export type AwsCloudMapInstanceAttributeValue = string;
  340. export type AwsCloudMapInstanceAttributes = AwsCloudMapInstanceAttribute[];
  341. export type AwsCloudMapName = string;
  342. export interface AwsCloudMapServiceDiscovery {
  343. /**
  344. * A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
  345. */
  346. attributes?: AwsCloudMapInstanceAttributes;
  347. /**
  348. * The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
  349. */
  350. ipPreference?: IpPreference;
  351. /**
  352. * The name of the Cloud Map namespace to use.
  353. */
  354. namespaceName: AwsCloudMapName;
  355. /**
  356. * The name of the Cloud Map service to use.
  357. */
  358. serviceName: AwsCloudMapName;
  359. }
  360. export interface Backend {
  361. /**
  362. * Specifies a virtual service to use as a backend.
  363. */
  364. virtualService?: VirtualServiceBackend;
  365. }
  366. export interface BackendDefaults {
  367. /**
  368. * A reference to an object that represents a client policy.
  369. */
  370. clientPolicy?: ClientPolicy;
  371. }
  372. export type Backends = Backend[];
  373. export type Boolean = boolean;
  374. export type CertificateAuthorityArns = Arn[];
  375. export interface ClientPolicy {
  376. /**
  377. * A reference to an object that represents a Transport Layer Security (TLS) client policy.
  378. */
  379. tls?: ClientPolicyTls;
  380. }
  381. export interface ClientPolicyTls {
  382. /**
  383. * A reference to an object that represents a client's TLS certificate.
  384. */
  385. certificate?: ClientTlsCertificate;
  386. /**
  387. * Whether the policy is enforced. The default is True, if a value isn't specified.
  388. */
  389. enforce?: Boolean;
  390. /**
  391. * One or more ports that the policy is enforced for.
  392. */
  393. ports?: PortSet;
  394. /**
  395. * A reference to an object that represents a TLS validation context.
  396. */
  397. validation: TlsValidationContext;
  398. }
  399. export interface ClientTlsCertificate {
  400. /**
  401. * An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
  402. */
  403. file?: ListenerTlsFileCertificate;
  404. /**
  405. * A reference to an object that represents a client's TLS Secret Discovery Service certificate.
  406. */
  407. sds?: ListenerTlsSdsCertificate;
  408. }
  409. export interface CreateGatewayRouteInput {
  410. /**
  411. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  412. */
  413. clientToken?: String;
  414. /**
  415. * The name to use for the gateway route.
  416. */
  417. gatewayRouteName: ResourceName;
  418. /**
  419. * The name of the service mesh to create the gateway route in.
  420. */
  421. meshName: ResourceName;
  422. /**
  423. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  424. */
  425. meshOwner?: AccountId;
  426. /**
  427. * The gateway route specification to apply.
  428. */
  429. spec: GatewayRouteSpec;
  430. /**
  431. * Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  432. */
  433. tags?: TagList;
  434. /**
  435. * The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
  436. */
  437. virtualGatewayName: ResourceName;
  438. }
  439. export interface CreateGatewayRouteOutput {
  440. /**
  441. * The full description of your gateway route following the create call.
  442. */
  443. gatewayRoute: GatewayRouteData;
  444. }
  445. export interface CreateMeshInput {
  446. /**
  447. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  448. */
  449. clientToken?: String;
  450. /**
  451. * The name to use for the service mesh.
  452. */
  453. meshName: ResourceName;
  454. /**
  455. * The service mesh specification to apply.
  456. */
  457. spec?: MeshSpec;
  458. /**
  459. * Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  460. */
  461. tags?: TagList;
  462. }
  463. export interface CreateMeshOutput {
  464. /**
  465. * The full description of your service mesh following the create call.
  466. */
  467. mesh: MeshData;
  468. }
  469. export interface CreateRouteInput {
  470. /**
  471. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  472. */
  473. clientToken?: String;
  474. /**
  475. * The name of the service mesh to create the route in.
  476. */
  477. meshName: ResourceName;
  478. /**
  479. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  480. */
  481. meshOwner?: AccountId;
  482. /**
  483. * The name to use for the route.
  484. */
  485. routeName: ResourceName;
  486. /**
  487. * The route specification to apply.
  488. */
  489. spec: RouteSpec;
  490. /**
  491. * Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  492. */
  493. tags?: TagList;
  494. /**
  495. * The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.
  496. */
  497. virtualRouterName: ResourceName;
  498. }
  499. export interface CreateRouteOutput {
  500. /**
  501. * The full description of your mesh following the create call.
  502. */
  503. route: RouteData;
  504. }
  505. export interface CreateVirtualGatewayInput {
  506. /**
  507. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  508. */
  509. clientToken?: String;
  510. /**
  511. * The name of the service mesh to create the virtual gateway in.
  512. */
  513. meshName: ResourceName;
  514. /**
  515. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  516. */
  517. meshOwner?: AccountId;
  518. /**
  519. * The virtual gateway specification to apply.
  520. */
  521. spec: VirtualGatewaySpec;
  522. /**
  523. * Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  524. */
  525. tags?: TagList;
  526. /**
  527. * The name to use for the virtual gateway.
  528. */
  529. virtualGatewayName: ResourceName;
  530. }
  531. export interface CreateVirtualGatewayOutput {
  532. /**
  533. * The full description of your virtual gateway following the create call.
  534. */
  535. virtualGateway: VirtualGatewayData;
  536. }
  537. export interface CreateVirtualNodeInput {
  538. /**
  539. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  540. */
  541. clientToken?: String;
  542. /**
  543. * The name of the service mesh to create the virtual node in.
  544. */
  545. meshName: ResourceName;
  546. /**
  547. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  548. */
  549. meshOwner?: AccountId;
  550. /**
  551. * The virtual node specification to apply.
  552. */
  553. spec: VirtualNodeSpec;
  554. /**
  555. * Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  556. */
  557. tags?: TagList;
  558. /**
  559. * The name to use for the virtual node.
  560. */
  561. virtualNodeName: ResourceName;
  562. }
  563. export interface CreateVirtualNodeOutput {
  564. /**
  565. * The full description of your virtual node following the create call.
  566. */
  567. virtualNode: VirtualNodeData;
  568. }
  569. export interface CreateVirtualRouterInput {
  570. /**
  571. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  572. */
  573. clientToken?: String;
  574. /**
  575. * The name of the service mesh to create the virtual router in.
  576. */
  577. meshName: ResourceName;
  578. /**
  579. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  580. */
  581. meshOwner?: AccountId;
  582. /**
  583. * The virtual router specification to apply.
  584. */
  585. spec: VirtualRouterSpec;
  586. /**
  587. * Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  588. */
  589. tags?: TagList;
  590. /**
  591. * The name to use for the virtual router.
  592. */
  593. virtualRouterName: ResourceName;
  594. }
  595. export interface CreateVirtualRouterOutput {
  596. /**
  597. * The full description of your virtual router following the create call.
  598. */
  599. virtualRouter: VirtualRouterData;
  600. }
  601. export interface CreateVirtualServiceInput {
  602. /**
  603. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  604. */
  605. clientToken?: String;
  606. /**
  607. * The name of the service mesh to create the virtual service in.
  608. */
  609. meshName: ResourceName;
  610. /**
  611. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  612. */
  613. meshOwner?: AccountId;
  614. /**
  615. * The virtual service specification to apply.
  616. */
  617. spec: VirtualServiceSpec;
  618. /**
  619. * Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  620. */
  621. tags?: TagList;
  622. /**
  623. * The name to use for the virtual service.
  624. */
  625. virtualServiceName: ServiceName;
  626. }
  627. export interface CreateVirtualServiceOutput {
  628. /**
  629. * The full description of your virtual service following the create call.
  630. */
  631. virtualService: VirtualServiceData;
  632. }
  633. export type DefaultGatewayRouteRewrite = "ENABLED"|"DISABLED"|string;
  634. export interface DeleteGatewayRouteInput {
  635. /**
  636. * The name of the gateway route to delete.
  637. */
  638. gatewayRouteName: ResourceName;
  639. /**
  640. * The name of the service mesh to delete the gateway route from.
  641. */
  642. meshName: ResourceName;
  643. /**
  644. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  645. */
  646. meshOwner?: AccountId;
  647. /**
  648. * The name of the virtual gateway to delete the route from.
  649. */
  650. virtualGatewayName: ResourceName;
  651. }
  652. export interface DeleteGatewayRouteOutput {
  653. /**
  654. * The gateway route that was deleted.
  655. */
  656. gatewayRoute: GatewayRouteData;
  657. }
  658. export interface DeleteMeshInput {
  659. /**
  660. * The name of the service mesh to delete.
  661. */
  662. meshName: ResourceName;
  663. }
  664. export interface DeleteMeshOutput {
  665. /**
  666. * The service mesh that was deleted.
  667. */
  668. mesh: MeshData;
  669. }
  670. export interface DeleteRouteInput {
  671. /**
  672. * The name of the service mesh to delete the route in.
  673. */
  674. meshName: ResourceName;
  675. /**
  676. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  677. */
  678. meshOwner?: AccountId;
  679. /**
  680. * The name of the route to delete.
  681. */
  682. routeName: ResourceName;
  683. /**
  684. * The name of the virtual router to delete the route in.
  685. */
  686. virtualRouterName: ResourceName;
  687. }
  688. export interface DeleteRouteOutput {
  689. /**
  690. * The route that was deleted.
  691. */
  692. route: RouteData;
  693. }
  694. export interface DeleteVirtualGatewayInput {
  695. /**
  696. * The name of the service mesh to delete the virtual gateway from.
  697. */
  698. meshName: ResourceName;
  699. /**
  700. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  701. */
  702. meshOwner?: AccountId;
  703. /**
  704. * The name of the virtual gateway to delete.
  705. */
  706. virtualGatewayName: ResourceName;
  707. }
  708. export interface DeleteVirtualGatewayOutput {
  709. /**
  710. * The virtual gateway that was deleted.
  711. */
  712. virtualGateway: VirtualGatewayData;
  713. }
  714. export interface DeleteVirtualNodeInput {
  715. /**
  716. * The name of the service mesh to delete the virtual node in.
  717. */
  718. meshName: ResourceName;
  719. /**
  720. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  721. */
  722. meshOwner?: AccountId;
  723. /**
  724. * The name of the virtual node to delete.
  725. */
  726. virtualNodeName: ResourceName;
  727. }
  728. export interface DeleteVirtualNodeOutput {
  729. /**
  730. * The virtual node that was deleted.
  731. */
  732. virtualNode: VirtualNodeData;
  733. }
  734. export interface DeleteVirtualRouterInput {
  735. /**
  736. * The name of the service mesh to delete the virtual router in.
  737. */
  738. meshName: ResourceName;
  739. /**
  740. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  741. */
  742. meshOwner?: AccountId;
  743. /**
  744. * The name of the virtual router to delete.
  745. */
  746. virtualRouterName: ResourceName;
  747. }
  748. export interface DeleteVirtualRouterOutput {
  749. /**
  750. * The virtual router that was deleted.
  751. */
  752. virtualRouter: VirtualRouterData;
  753. }
  754. export interface DeleteVirtualServiceInput {
  755. /**
  756. * The name of the service mesh to delete the virtual service in.
  757. */
  758. meshName: ResourceName;
  759. /**
  760. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  761. */
  762. meshOwner?: AccountId;
  763. /**
  764. * The name of the virtual service to delete.
  765. */
  766. virtualServiceName: ServiceName;
  767. }
  768. export interface DeleteVirtualServiceOutput {
  769. /**
  770. * The virtual service that was deleted.
  771. */
  772. virtualService: VirtualServiceData;
  773. }
  774. export interface DescribeGatewayRouteInput {
  775. /**
  776. * The name of the gateway route to describe.
  777. */
  778. gatewayRouteName: ResourceName;
  779. /**
  780. * The name of the service mesh that the gateway route resides in.
  781. */
  782. meshName: ResourceName;
  783. /**
  784. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  785. */
  786. meshOwner?: AccountId;
  787. /**
  788. * The name of the virtual gateway that the gateway route is associated with.
  789. */
  790. virtualGatewayName: ResourceName;
  791. }
  792. export interface DescribeGatewayRouteOutput {
  793. /**
  794. * The full description of your gateway route.
  795. */
  796. gatewayRoute: GatewayRouteData;
  797. }
  798. export interface DescribeMeshInput {
  799. /**
  800. * The name of the service mesh to describe.
  801. */
  802. meshName: ResourceName;
  803. /**
  804. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  805. */
  806. meshOwner?: AccountId;
  807. }
  808. export interface DescribeMeshOutput {
  809. /**
  810. * The full description of your service mesh.
  811. */
  812. mesh: MeshData;
  813. }
  814. export interface DescribeRouteInput {
  815. /**
  816. * The name of the service mesh that the route resides in.
  817. */
  818. meshName: ResourceName;
  819. /**
  820. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  821. */
  822. meshOwner?: AccountId;
  823. /**
  824. * The name of the route to describe.
  825. */
  826. routeName: ResourceName;
  827. /**
  828. * The name of the virtual router that the route is associated with.
  829. */
  830. virtualRouterName: ResourceName;
  831. }
  832. export interface DescribeRouteOutput {
  833. /**
  834. * The full description of your route.
  835. */
  836. route: RouteData;
  837. }
  838. export interface DescribeVirtualGatewayInput {
  839. /**
  840. * The name of the service mesh that the gateway route resides in.
  841. */
  842. meshName: ResourceName;
  843. /**
  844. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  845. */
  846. meshOwner?: AccountId;
  847. /**
  848. * The name of the virtual gateway to describe.
  849. */
  850. virtualGatewayName: ResourceName;
  851. }
  852. export interface DescribeVirtualGatewayOutput {
  853. /**
  854. * The full description of your virtual gateway.
  855. */
  856. virtualGateway: VirtualGatewayData;
  857. }
  858. export interface DescribeVirtualNodeInput {
  859. /**
  860. * The name of the service mesh that the virtual node resides in.
  861. */
  862. meshName: ResourceName;
  863. /**
  864. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  865. */
  866. meshOwner?: AccountId;
  867. /**
  868. * The name of the virtual node to describe.
  869. */
  870. virtualNodeName: ResourceName;
  871. }
  872. export interface DescribeVirtualNodeOutput {
  873. /**
  874. * The full description of your virtual node.
  875. */
  876. virtualNode: VirtualNodeData;
  877. }
  878. export interface DescribeVirtualRouterInput {
  879. /**
  880. * The name of the service mesh that the virtual router resides in.
  881. */
  882. meshName: ResourceName;
  883. /**
  884. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  885. */
  886. meshOwner?: AccountId;
  887. /**
  888. * The name of the virtual router to describe.
  889. */
  890. virtualRouterName: ResourceName;
  891. }
  892. export interface DescribeVirtualRouterOutput {
  893. /**
  894. * The full description of your virtual router.
  895. */
  896. virtualRouter: VirtualRouterData;
  897. }
  898. export interface DescribeVirtualServiceInput {
  899. /**
  900. * The name of the service mesh that the virtual service resides in.
  901. */
  902. meshName: ResourceName;
  903. /**
  904. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  905. */
  906. meshOwner?: AccountId;
  907. /**
  908. * The name of the virtual service to describe.
  909. */
  910. virtualServiceName: ServiceName;
  911. }
  912. export interface DescribeVirtualServiceOutput {
  913. /**
  914. * The full description of your virtual service.
  915. */
  916. virtualService: VirtualServiceData;
  917. }
  918. export type DnsResponseType = "LOADBALANCER"|"ENDPOINTS"|string;
  919. export interface DnsServiceDiscovery {
  920. /**
  921. * Specifies the DNS service discovery hostname for the virtual node.
  922. */
  923. hostname: Hostname;
  924. /**
  925. * The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
  926. */
  927. ipPreference?: IpPreference;
  928. /**
  929. * Specifies the DNS response type for the virtual node.
  930. */
  931. responseType?: DnsResponseType;
  932. }
  933. export interface Duration {
  934. /**
  935. * A unit of time.
  936. */
  937. unit?: DurationUnit;
  938. /**
  939. * A number of time units.
  940. */
  941. value?: DurationValue;
  942. }
  943. export type DurationUnit = "s"|"ms"|string;
  944. export type DurationValue = number;
  945. export interface EgressFilter {
  946. /**
  947. * The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
  948. */
  949. type: EgressFilterType;
  950. }
  951. export type EgressFilterType = "ALLOW_ALL"|"DROP_ALL"|string;
  952. export type ExactHostName = string;
  953. export interface FileAccessLog {
  954. /**
  955. * The specified format for the logs. The format is either json_format or text_format.
  956. */
  957. format?: LoggingFormat;
  958. /**
  959. * The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk. The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
  960. */
  961. path: FilePath;
  962. }
  963. export type FilePath = string;
  964. export interface GatewayRouteData {
  965. /**
  966. * The name of the gateway route.
  967. */
  968. gatewayRouteName: ResourceName;
  969. /**
  970. * The name of the service mesh that the resource resides in.
  971. */
  972. meshName: ResourceName;
  973. metadata: ResourceMetadata;
  974. /**
  975. * The specifications of the gateway route.
  976. */
  977. spec: GatewayRouteSpec;
  978. /**
  979. * The status of the gateway route.
  980. */
  981. status: GatewayRouteStatus;
  982. /**
  983. * The virtual gateway that the gateway route is associated with.
  984. */
  985. virtualGatewayName: ResourceName;
  986. }
  987. export interface GatewayRouteHostnameMatch {
  988. /**
  989. * The exact host name to match on.
  990. */
  991. exact?: ExactHostName;
  992. /**
  993. * The specified ending characters of the host name to match on.
  994. */
  995. suffix?: SuffixHostname;
  996. }
  997. export interface GatewayRouteHostnameRewrite {
  998. /**
  999. * The default target host name to write to.
  1000. */
  1001. defaultTargetHostname?: DefaultGatewayRouteRewrite;
  1002. }
  1003. export type GatewayRouteList = GatewayRouteRef[];
  1004. export type GatewayRoutePriority = number;
  1005. export interface GatewayRouteRef {
  1006. /**
  1007. * The full Amazon Resource Name (ARN) for the gateway route.
  1008. */
  1009. arn: Arn;
  1010. /**
  1011. * The Unix epoch timestamp in seconds for when the resource was created.
  1012. */
  1013. createdAt: Timestamp;
  1014. /**
  1015. * The name of the gateway route.
  1016. */
  1017. gatewayRouteName: ResourceName;
  1018. /**
  1019. * The Unix epoch timestamp in seconds for when the resource was last updated.
  1020. */
  1021. lastUpdatedAt: Timestamp;
  1022. /**
  1023. * The name of the service mesh that the resource resides in.
  1024. */
  1025. meshName: ResourceName;
  1026. /**
  1027. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1028. */
  1029. meshOwner: AccountId;
  1030. /**
  1031. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  1032. */
  1033. resourceOwner: AccountId;
  1034. /**
  1035. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  1036. */
  1037. version: Long;
  1038. /**
  1039. * The virtual gateway that the gateway route is associated with.
  1040. */
  1041. virtualGatewayName: ResourceName;
  1042. }
  1043. export interface GatewayRouteSpec {
  1044. /**
  1045. * An object that represents the specification of a gRPC gateway route.
  1046. */
  1047. grpcRoute?: GrpcGatewayRoute;
  1048. /**
  1049. * An object that represents the specification of an HTTP/2 gateway route.
  1050. */
  1051. http2Route?: HttpGatewayRoute;
  1052. /**
  1053. * An object that represents the specification of an HTTP gateway route.
  1054. */
  1055. httpRoute?: HttpGatewayRoute;
  1056. /**
  1057. * The ordering of the gateway routes spec.
  1058. */
  1059. priority?: GatewayRoutePriority;
  1060. }
  1061. export interface GatewayRouteStatus {
  1062. /**
  1063. * The current status for the gateway route.
  1064. */
  1065. status: GatewayRouteStatusCode;
  1066. }
  1067. export type GatewayRouteStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  1068. export interface GatewayRouteTarget {
  1069. /**
  1070. * The port number of the gateway route target.
  1071. */
  1072. port?: ListenerPort;
  1073. /**
  1074. * An object that represents a virtual service gateway route target.
  1075. */
  1076. virtualService: GatewayRouteVirtualService;
  1077. }
  1078. export interface GatewayRouteVirtualService {
  1079. /**
  1080. * The name of the virtual service that traffic is routed to.
  1081. */
  1082. virtualServiceName: ResourceName;
  1083. }
  1084. export interface GrpcGatewayRoute {
  1085. /**
  1086. * An object that represents the action to take if a match is determined.
  1087. */
  1088. action: GrpcGatewayRouteAction;
  1089. /**
  1090. * An object that represents the criteria for determining a request match.
  1091. */
  1092. match: GrpcGatewayRouteMatch;
  1093. }
  1094. export interface GrpcGatewayRouteAction {
  1095. /**
  1096. * The gateway route action to rewrite.
  1097. */
  1098. rewrite?: GrpcGatewayRouteRewrite;
  1099. /**
  1100. * An object that represents the target that traffic is routed to when a request matches the gateway route.
  1101. */
  1102. target: GatewayRouteTarget;
  1103. }
  1104. export interface GrpcGatewayRouteMatch {
  1105. /**
  1106. * The gateway route host name to be matched on.
  1107. */
  1108. hostname?: GatewayRouteHostnameMatch;
  1109. /**
  1110. * The gateway route metadata to be matched on.
  1111. */
  1112. metadata?: GrpcGatewayRouteMetadataList;
  1113. /**
  1114. * The gateway route port to be matched on.
  1115. */
  1116. port?: ListenerPort;
  1117. /**
  1118. * The fully qualified domain name for the service to match from the request.
  1119. */
  1120. serviceName?: ServiceName;
  1121. }
  1122. export interface GrpcGatewayRouteMetadata {
  1123. /**
  1124. * Specify True to match anything except the match criteria. The default value is False.
  1125. */
  1126. invert?: Boolean;
  1127. /**
  1128. * The criteria for determining a metadata match.
  1129. */
  1130. match?: GrpcMetadataMatchMethod;
  1131. /**
  1132. * A name for the gateway route metadata.
  1133. */
  1134. name: HeaderName;
  1135. }
  1136. export type GrpcGatewayRouteMetadataList = GrpcGatewayRouteMetadata[];
  1137. export interface GrpcGatewayRouteRewrite {
  1138. /**
  1139. * The host name of the gateway route to rewrite.
  1140. */
  1141. hostname?: GatewayRouteHostnameRewrite;
  1142. }
  1143. export interface GrpcMetadataMatchMethod {
  1144. /**
  1145. * The exact method header to be matched on.
  1146. */
  1147. exact?: HeaderMatch;
  1148. /**
  1149. * The specified beginning characters of the method header to be matched on.
  1150. */
  1151. prefix?: HeaderMatch;
  1152. range?: MatchRange;
  1153. /**
  1154. * The regex used to match the method header.
  1155. */
  1156. regex?: HeaderMatch;
  1157. /**
  1158. * The specified ending characters of the method header to match on.
  1159. */
  1160. suffix?: HeaderMatch;
  1161. }
  1162. export interface GrpcRetryPolicy {
  1163. /**
  1164. * Specify at least one of the valid values.
  1165. */
  1166. grpcRetryEvents?: GrpcRetryPolicyEvents;
  1167. /**
  1168. * Specify at least one of the following values. server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 gateway-error – HTTP status codes 502, 503, and 504 client-error – HTTP status code 409 stream-error – Retry on refused stream
  1169. */
  1170. httpRetryEvents?: HttpRetryPolicyEvents;
  1171. /**
  1172. * The maximum number of retry attempts.
  1173. */
  1174. maxRetries: MaxRetries;
  1175. /**
  1176. * The timeout for each retry attempt.
  1177. */
  1178. perRetryTimeout: Duration;
  1179. /**
  1180. * Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
  1181. */
  1182. tcpRetryEvents?: TcpRetryPolicyEvents;
  1183. }
  1184. export type GrpcRetryPolicyEvent = "cancelled"|"deadline-exceeded"|"internal"|"resource-exhausted"|"unavailable"|string;
  1185. export type GrpcRetryPolicyEvents = GrpcRetryPolicyEvent[];
  1186. export interface GrpcRoute {
  1187. /**
  1188. * An object that represents the action to take if a match is determined.
  1189. */
  1190. action: GrpcRouteAction;
  1191. /**
  1192. * An object that represents the criteria for determining a request match.
  1193. */
  1194. match: GrpcRouteMatch;
  1195. /**
  1196. * An object that represents a retry policy.
  1197. */
  1198. retryPolicy?: GrpcRetryPolicy;
  1199. /**
  1200. * An object that represents types of timeouts.
  1201. */
  1202. timeout?: GrpcTimeout;
  1203. }
  1204. export interface GrpcRouteAction {
  1205. /**
  1206. * An object that represents the targets that traffic is routed to when a request matches the route.
  1207. */
  1208. weightedTargets: WeightedTargets;
  1209. }
  1210. export interface GrpcRouteMatch {
  1211. /**
  1212. * An object that represents the data to match from the request.
  1213. */
  1214. metadata?: GrpcRouteMetadataList;
  1215. /**
  1216. * The method name to match from the request. If you specify a name, you must also specify a serviceName.
  1217. */
  1218. methodName?: MethodName;
  1219. /**
  1220. * The port number to match on.
  1221. */
  1222. port?: ListenerPort;
  1223. /**
  1224. * The fully qualified domain name for the service to match from the request.
  1225. */
  1226. serviceName?: ServiceName;
  1227. }
  1228. export interface GrpcRouteMetadata {
  1229. /**
  1230. * Specify True to match anything except the match criteria. The default value is False.
  1231. */
  1232. invert?: Boolean;
  1233. /**
  1234. * An object that represents the data to match from the request.
  1235. */
  1236. match?: GrpcRouteMetadataMatchMethod;
  1237. /**
  1238. * The name of the route.
  1239. */
  1240. name: HeaderName;
  1241. }
  1242. export type GrpcRouteMetadataList = GrpcRouteMetadata[];
  1243. export interface GrpcRouteMetadataMatchMethod {
  1244. /**
  1245. * The value sent by the client must match the specified value exactly.
  1246. */
  1247. exact?: HeaderMatch;
  1248. /**
  1249. * The value sent by the client must begin with the specified characters.
  1250. */
  1251. prefix?: HeaderMatch;
  1252. /**
  1253. * An object that represents the range of values to match on.
  1254. */
  1255. range?: MatchRange;
  1256. /**
  1257. * The value sent by the client must include the specified characters.
  1258. */
  1259. regex?: HeaderMatch;
  1260. /**
  1261. * The value sent by the client must end with the specified characters.
  1262. */
  1263. suffix?: HeaderMatch;
  1264. }
  1265. export interface GrpcTimeout {
  1266. /**
  1267. * An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
  1268. */
  1269. idle?: Duration;
  1270. /**
  1271. * An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
  1272. */
  1273. perRequest?: Duration;
  1274. }
  1275. export type HeaderMatch = string;
  1276. export interface HeaderMatchMethod {
  1277. /**
  1278. * The value sent by the client must match the specified value exactly.
  1279. */
  1280. exact?: HeaderMatch;
  1281. /**
  1282. * The value sent by the client must begin with the specified characters.
  1283. */
  1284. prefix?: HeaderMatch;
  1285. /**
  1286. * An object that represents the range of values to match on.
  1287. */
  1288. range?: MatchRange;
  1289. /**
  1290. * The value sent by the client must include the specified characters.
  1291. */
  1292. regex?: HeaderMatch;
  1293. /**
  1294. * The value sent by the client must end with the specified characters.
  1295. */
  1296. suffix?: HeaderMatch;
  1297. }
  1298. export type HeaderName = string;
  1299. export type HealthCheckIntervalMillis = number;
  1300. export interface HealthCheckPolicy {
  1301. /**
  1302. * The number of consecutive successful health checks that must occur before declaring listener healthy.
  1303. */
  1304. healthyThreshold: HealthCheckThreshold;
  1305. /**
  1306. * The time period in milliseconds between each health check execution.
  1307. */
  1308. intervalMillis: HealthCheckIntervalMillis;
  1309. /**
  1310. * The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
  1311. */
  1312. path?: String;
  1313. /**
  1314. * The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
  1315. */
  1316. port?: PortNumber;
  1317. /**
  1318. * The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
  1319. */
  1320. protocol: PortProtocol;
  1321. /**
  1322. * The amount of time to wait when receiving a response from the health check, in milliseconds.
  1323. */
  1324. timeoutMillis: HealthCheckTimeoutMillis;
  1325. /**
  1326. * The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
  1327. */
  1328. unhealthyThreshold: HealthCheckThreshold;
  1329. }
  1330. export type HealthCheckThreshold = number;
  1331. export type HealthCheckTimeoutMillis = number;
  1332. export type Hostname = string;
  1333. export interface HttpGatewayRoute {
  1334. /**
  1335. * An object that represents the action to take if a match is determined.
  1336. */
  1337. action: HttpGatewayRouteAction;
  1338. /**
  1339. * An object that represents the criteria for determining a request match.
  1340. */
  1341. match: HttpGatewayRouteMatch;
  1342. }
  1343. export interface HttpGatewayRouteAction {
  1344. /**
  1345. * The gateway route action to rewrite.
  1346. */
  1347. rewrite?: HttpGatewayRouteRewrite;
  1348. /**
  1349. * An object that represents the target that traffic is routed to when a request matches the gateway route.
  1350. */
  1351. target: GatewayRouteTarget;
  1352. }
  1353. export interface HttpGatewayRouteHeader {
  1354. /**
  1355. * Specify True to match anything except the match criteria. The default value is False.
  1356. */
  1357. invert?: Boolean;
  1358. /**
  1359. * An object that represents the method and value to match with the header value sent in a request. Specify one match method.
  1360. */
  1361. match?: HeaderMatchMethod;
  1362. /**
  1363. * A name for the HTTP header in the gateway route that will be matched on.
  1364. */
  1365. name: HeaderName;
  1366. }
  1367. export type HttpGatewayRouteHeaders = HttpGatewayRouteHeader[];
  1368. export interface HttpGatewayRouteMatch {
  1369. /**
  1370. * The client request headers to match on.
  1371. */
  1372. headers?: HttpGatewayRouteHeaders;
  1373. /**
  1374. * The host name to match on.
  1375. */
  1376. hostname?: GatewayRouteHostnameMatch;
  1377. /**
  1378. * The method to match on.
  1379. */
  1380. method?: HttpMethod;
  1381. /**
  1382. * The path to match on.
  1383. */
  1384. path?: HttpPathMatch;
  1385. /**
  1386. * The port number to match on.
  1387. */
  1388. port?: ListenerPort;
  1389. /**
  1390. * Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
  1391. */
  1392. prefix?: String;
  1393. /**
  1394. * The query parameter to match on.
  1395. */
  1396. queryParameters?: HttpQueryParameters;
  1397. }
  1398. export interface HttpGatewayRoutePathRewrite {
  1399. /**
  1400. * The exact path to rewrite.
  1401. */
  1402. exact?: HttpPathExact;
  1403. }
  1404. export type HttpGatewayRoutePrefix = string;
  1405. export interface HttpGatewayRoutePrefixRewrite {
  1406. /**
  1407. * The default prefix used to replace the incoming route prefix when rewritten.
  1408. */
  1409. defaultPrefix?: DefaultGatewayRouteRewrite;
  1410. /**
  1411. * The value used to replace the incoming route prefix when rewritten.
  1412. */
  1413. value?: HttpGatewayRoutePrefix;
  1414. }
  1415. export interface HttpGatewayRouteRewrite {
  1416. /**
  1417. * The host name to rewrite.
  1418. */
  1419. hostname?: GatewayRouteHostnameRewrite;
  1420. /**
  1421. * The path to rewrite.
  1422. */
  1423. path?: HttpGatewayRoutePathRewrite;
  1424. /**
  1425. * The specified beginning characters to rewrite.
  1426. */
  1427. prefix?: HttpGatewayRoutePrefixRewrite;
  1428. }
  1429. export type HttpMethod = "GET"|"HEAD"|"POST"|"PUT"|"DELETE"|"CONNECT"|"OPTIONS"|"TRACE"|"PATCH"|string;
  1430. export type HttpPathExact = string;
  1431. export interface HttpPathMatch {
  1432. /**
  1433. * The exact path to match on.
  1434. */
  1435. exact?: HttpPathExact;
  1436. /**
  1437. * The regex used to match the path.
  1438. */
  1439. regex?: HttpPathRegex;
  1440. }
  1441. export type HttpPathRegex = string;
  1442. export interface HttpQueryParameter {
  1443. /**
  1444. * The query parameter to match on.
  1445. */
  1446. match?: QueryParameterMatch;
  1447. /**
  1448. * A name for the query parameter that will be matched on.
  1449. */
  1450. name: QueryParameterName;
  1451. }
  1452. export type HttpQueryParameters = HttpQueryParameter[];
  1453. export interface HttpRetryPolicy {
  1454. /**
  1455. * Specify at least one of the following values. server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 gateway-error – HTTP status codes 502, 503, and 504 client-error – HTTP status code 409 stream-error – Retry on refused stream
  1456. */
  1457. httpRetryEvents?: HttpRetryPolicyEvents;
  1458. /**
  1459. * The maximum number of retry attempts.
  1460. */
  1461. maxRetries: MaxRetries;
  1462. /**
  1463. * The timeout for each retry attempt.
  1464. */
  1465. perRetryTimeout: Duration;
  1466. /**
  1467. * Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
  1468. */
  1469. tcpRetryEvents?: TcpRetryPolicyEvents;
  1470. }
  1471. export type HttpRetryPolicyEvent = string;
  1472. export type HttpRetryPolicyEvents = HttpRetryPolicyEvent[];
  1473. export interface HttpRoute {
  1474. /**
  1475. * An object that represents the action to take if a match is determined.
  1476. */
  1477. action: HttpRouteAction;
  1478. /**
  1479. * An object that represents the criteria for determining a request match.
  1480. */
  1481. match: HttpRouteMatch;
  1482. /**
  1483. * An object that represents a retry policy.
  1484. */
  1485. retryPolicy?: HttpRetryPolicy;
  1486. /**
  1487. * An object that represents types of timeouts.
  1488. */
  1489. timeout?: HttpTimeout;
  1490. }
  1491. export interface HttpRouteAction {
  1492. /**
  1493. * An object that represents the targets that traffic is routed to when a request matches the route.
  1494. */
  1495. weightedTargets: WeightedTargets;
  1496. }
  1497. export interface HttpRouteHeader {
  1498. /**
  1499. * Specify True to match anything except the match criteria. The default value is False.
  1500. */
  1501. invert?: Boolean;
  1502. /**
  1503. * The HeaderMatchMethod object.
  1504. */
  1505. match?: HeaderMatchMethod;
  1506. /**
  1507. * A name for the HTTP header in the client request that will be matched on.
  1508. */
  1509. name: HeaderName;
  1510. }
  1511. export type HttpRouteHeaders = HttpRouteHeader[];
  1512. export interface HttpRouteMatch {
  1513. /**
  1514. * The client request headers to match on.
  1515. */
  1516. headers?: HttpRouteHeaders;
  1517. /**
  1518. * The client request method to match on. Specify only one.
  1519. */
  1520. method?: HttpMethod;
  1521. /**
  1522. * The client request path to match on.
  1523. */
  1524. path?: HttpPathMatch;
  1525. /**
  1526. * The port number to match on.
  1527. */
  1528. port?: ListenerPort;
  1529. /**
  1530. * Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
  1531. */
  1532. prefix?: String;
  1533. /**
  1534. * The client request query parameters to match on.
  1535. */
  1536. queryParameters?: HttpQueryParameters;
  1537. /**
  1538. * The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
  1539. */
  1540. scheme?: HttpScheme;
  1541. }
  1542. export type HttpScheme = "http"|"https"|string;
  1543. export interface HttpTimeout {
  1544. /**
  1545. * An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
  1546. */
  1547. idle?: Duration;
  1548. /**
  1549. * An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
  1550. */
  1551. perRequest?: Duration;
  1552. }
  1553. export type IpPreference = "IPv6_PREFERRED"|"IPv4_PREFERRED"|"IPv4_ONLY"|"IPv6_ONLY"|string;
  1554. export type JsonFormat = JsonFormatRef[];
  1555. export interface JsonFormatRef {
  1556. /**
  1557. * The specified key for the JSON.
  1558. */
  1559. key: JsonKey;
  1560. /**
  1561. * The specified value for the JSON.
  1562. */
  1563. value: JsonValue;
  1564. }
  1565. export type JsonKey = string;
  1566. export type JsonValue = string;
  1567. export interface ListGatewayRoutesInput {
  1568. /**
  1569. * The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.
  1570. */
  1571. limit?: ListGatewayRoutesLimit;
  1572. /**
  1573. * The name of the service mesh to list gateway routes in.
  1574. */
  1575. meshName: ResourceName;
  1576. /**
  1577. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1578. */
  1579. meshOwner?: AccountId;
  1580. /**
  1581. * The nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1582. */
  1583. nextToken?: String;
  1584. /**
  1585. * The name of the virtual gateway to list gateway routes in.
  1586. */
  1587. virtualGatewayName: ResourceName;
  1588. }
  1589. export type ListGatewayRoutesLimit = number;
  1590. export interface ListGatewayRoutesOutput {
  1591. /**
  1592. * The list of existing gateway routes for the specified service mesh and virtual gateway.
  1593. */
  1594. gatewayRoutes: GatewayRouteList;
  1595. /**
  1596. * The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1597. */
  1598. nextToken?: String;
  1599. }
  1600. export interface ListMeshesInput {
  1601. /**
  1602. * The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.
  1603. */
  1604. limit?: ListMeshesLimit;
  1605. /**
  1606. * The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
  1607. */
  1608. nextToken?: String;
  1609. }
  1610. export type ListMeshesLimit = number;
  1611. export interface ListMeshesOutput {
  1612. /**
  1613. * The list of existing service meshes.
  1614. */
  1615. meshes: MeshList;
  1616. /**
  1617. * The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1618. */
  1619. nextToken?: String;
  1620. }
  1621. export interface ListRoutesInput {
  1622. /**
  1623. * The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.
  1624. */
  1625. limit?: ListRoutesLimit;
  1626. /**
  1627. * The name of the service mesh to list routes in.
  1628. */
  1629. meshName: ResourceName;
  1630. /**
  1631. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1632. */
  1633. meshOwner?: AccountId;
  1634. /**
  1635. * The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1636. */
  1637. nextToken?: String;
  1638. /**
  1639. * The name of the virtual router to list routes in.
  1640. */
  1641. virtualRouterName: ResourceName;
  1642. }
  1643. export type ListRoutesLimit = number;
  1644. export interface ListRoutesOutput {
  1645. /**
  1646. * The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1647. */
  1648. nextToken?: String;
  1649. /**
  1650. * The list of existing routes for the specified service mesh and virtual router.
  1651. */
  1652. routes: RouteList;
  1653. }
  1654. export interface ListTagsForResourceInput {
  1655. /**
  1656. * The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.
  1657. */
  1658. limit?: TagsLimit;
  1659. /**
  1660. * The nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1661. */
  1662. nextToken?: String;
  1663. /**
  1664. * The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
  1665. */
  1666. resourceArn: Arn;
  1667. }
  1668. export interface ListTagsForResourceOutput {
  1669. /**
  1670. * The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1671. */
  1672. nextToken?: String;
  1673. /**
  1674. * The tags for the resource.
  1675. */
  1676. tags: TagList;
  1677. }
  1678. export interface ListVirtualGatewaysInput {
  1679. /**
  1680. * The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.
  1681. */
  1682. limit?: ListVirtualGatewaysLimit;
  1683. /**
  1684. * The name of the service mesh to list virtual gateways in.
  1685. */
  1686. meshName: ResourceName;
  1687. /**
  1688. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1689. */
  1690. meshOwner?: AccountId;
  1691. /**
  1692. * The nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1693. */
  1694. nextToken?: String;
  1695. }
  1696. export type ListVirtualGatewaysLimit = number;
  1697. export interface ListVirtualGatewaysOutput {
  1698. /**
  1699. * The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1700. */
  1701. nextToken?: String;
  1702. /**
  1703. * The list of existing virtual gateways for the specified service mesh.
  1704. */
  1705. virtualGateways: VirtualGatewayList;
  1706. }
  1707. export interface ListVirtualNodesInput {
  1708. /**
  1709. * The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.
  1710. */
  1711. limit?: ListVirtualNodesLimit;
  1712. /**
  1713. * The name of the service mesh to list virtual nodes in.
  1714. */
  1715. meshName: ResourceName;
  1716. /**
  1717. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1718. */
  1719. meshOwner?: AccountId;
  1720. /**
  1721. * The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1722. */
  1723. nextToken?: String;
  1724. }
  1725. export type ListVirtualNodesLimit = number;
  1726. export interface ListVirtualNodesOutput {
  1727. /**
  1728. * The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1729. */
  1730. nextToken?: String;
  1731. /**
  1732. * The list of existing virtual nodes for the specified service mesh.
  1733. */
  1734. virtualNodes: VirtualNodeList;
  1735. }
  1736. export interface ListVirtualRoutersInput {
  1737. /**
  1738. * The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.
  1739. */
  1740. limit?: ListVirtualRoutersLimit;
  1741. /**
  1742. * The name of the service mesh to list virtual routers in.
  1743. */
  1744. meshName: ResourceName;
  1745. /**
  1746. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1747. */
  1748. meshOwner?: AccountId;
  1749. /**
  1750. * The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1751. */
  1752. nextToken?: String;
  1753. }
  1754. export type ListVirtualRoutersLimit = number;
  1755. export interface ListVirtualRoutersOutput {
  1756. /**
  1757. * The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1758. */
  1759. nextToken?: String;
  1760. /**
  1761. * The list of existing virtual routers for the specified service mesh.
  1762. */
  1763. virtualRouters: VirtualRouterList;
  1764. }
  1765. export interface ListVirtualServicesInput {
  1766. /**
  1767. * The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.
  1768. */
  1769. limit?: ListVirtualServicesLimit;
  1770. /**
  1771. * The name of the service mesh to list virtual services in.
  1772. */
  1773. meshName: ResourceName;
  1774. /**
  1775. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1776. */
  1777. meshOwner?: AccountId;
  1778. /**
  1779. * The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  1780. */
  1781. nextToken?: String;
  1782. }
  1783. export type ListVirtualServicesLimit = number;
  1784. export interface ListVirtualServicesOutput {
  1785. /**
  1786. * The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  1787. */
  1788. nextToken?: String;
  1789. /**
  1790. * The list of existing virtual services for the specified service mesh.
  1791. */
  1792. virtualServices: VirtualServiceList;
  1793. }
  1794. export interface Listener {
  1795. /**
  1796. * The connection pool information for the listener.
  1797. */
  1798. connectionPool?: VirtualNodeConnectionPool;
  1799. /**
  1800. * The health check information for the listener.
  1801. */
  1802. healthCheck?: HealthCheckPolicy;
  1803. /**
  1804. * The outlier detection information for the listener.
  1805. */
  1806. outlierDetection?: OutlierDetection;
  1807. /**
  1808. * The port mapping information for the listener.
  1809. */
  1810. portMapping: PortMapping;
  1811. /**
  1812. * An object that represents timeouts for different protocols.
  1813. */
  1814. timeout?: ListenerTimeout;
  1815. /**
  1816. * A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
  1817. */
  1818. tls?: ListenerTls;
  1819. }
  1820. export type ListenerPort = number;
  1821. export interface ListenerTimeout {
  1822. /**
  1823. * An object that represents types of timeouts.
  1824. */
  1825. grpc?: GrpcTimeout;
  1826. /**
  1827. * An object that represents types of timeouts.
  1828. */
  1829. http?: HttpTimeout;
  1830. /**
  1831. * An object that represents types of timeouts.
  1832. */
  1833. http2?: HttpTimeout;
  1834. /**
  1835. * An object that represents types of timeouts.
  1836. */
  1837. tcp?: TcpTimeout;
  1838. }
  1839. export interface ListenerTls {
  1840. /**
  1841. * A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
  1842. */
  1843. certificate: ListenerTlsCertificate;
  1844. /**
  1845. * Specify one of the following modes. STRICT – Listener only accepts connections with TLS enabled. PERMISSIVE – Listener accepts connections with or without TLS enabled. DISABLED – Listener only accepts connections without TLS.
  1846. */
  1847. mode: ListenerTlsMode;
  1848. /**
  1849. * A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
  1850. */
  1851. validation?: ListenerTlsValidationContext;
  1852. }
  1853. export interface ListenerTlsAcmCertificate {
  1854. /**
  1855. * The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
  1856. */
  1857. certificateArn: Arn;
  1858. }
  1859. export interface ListenerTlsCertificate {
  1860. /**
  1861. * A reference to an object that represents an Certificate Manager certificate.
  1862. */
  1863. acm?: ListenerTlsAcmCertificate;
  1864. /**
  1865. * A reference to an object that represents a local file certificate.
  1866. */
  1867. file?: ListenerTlsFileCertificate;
  1868. /**
  1869. * A reference to an object that represents a listener's Secret Discovery Service certificate.
  1870. */
  1871. sds?: ListenerTlsSdsCertificate;
  1872. }
  1873. export interface ListenerTlsFileCertificate {
  1874. /**
  1875. * The certificate chain for the certificate.
  1876. */
  1877. certificateChain: FilePath;
  1878. /**
  1879. * The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
  1880. */
  1881. privateKey: FilePath;
  1882. }
  1883. export type ListenerTlsMode = "STRICT"|"PERMISSIVE"|"DISABLED"|string;
  1884. export interface ListenerTlsSdsCertificate {
  1885. /**
  1886. * A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
  1887. */
  1888. secretName: SdsSecretName;
  1889. }
  1890. export interface ListenerTlsValidationContext {
  1891. /**
  1892. * A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
  1893. */
  1894. subjectAlternativeNames?: SubjectAlternativeNames;
  1895. /**
  1896. * A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
  1897. */
  1898. trust: ListenerTlsValidationContextTrust;
  1899. }
  1900. export interface ListenerTlsValidationContextTrust {
  1901. /**
  1902. * An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
  1903. */
  1904. file?: TlsValidationContextFileTrust;
  1905. /**
  1906. * A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  1907. */
  1908. sds?: TlsValidationContextSdsTrust;
  1909. }
  1910. export type Listeners = Listener[];
  1911. export interface Logging {
  1912. /**
  1913. * The access log configuration for a virtual node.
  1914. */
  1915. accessLog?: AccessLog;
  1916. }
  1917. export interface LoggingFormat {
  1918. /**
  1919. *
  1920. */
  1921. json?: JsonFormat;
  1922. /**
  1923. *
  1924. */
  1925. text?: TextFormat;
  1926. }
  1927. export type Long = number;
  1928. export interface MatchRange {
  1929. /**
  1930. * The end of the range.
  1931. */
  1932. end: Long;
  1933. /**
  1934. * The start of the range.
  1935. */
  1936. start: Long;
  1937. }
  1938. export type MaxConnections = number;
  1939. export type MaxPendingRequests = number;
  1940. export type MaxRequests = number;
  1941. export type MaxRetries = number;
  1942. export interface MeshData {
  1943. /**
  1944. * The name of the service mesh.
  1945. */
  1946. meshName: ResourceName;
  1947. /**
  1948. * The associated metadata for the service mesh.
  1949. */
  1950. metadata: ResourceMetadata;
  1951. /**
  1952. * The associated specification for the service mesh.
  1953. */
  1954. spec: MeshSpec;
  1955. /**
  1956. * The status of the service mesh.
  1957. */
  1958. status: MeshStatus;
  1959. }
  1960. export type MeshList = MeshRef[];
  1961. export interface MeshRef {
  1962. /**
  1963. * The full Amazon Resource Name (ARN) of the service mesh.
  1964. */
  1965. arn: Arn;
  1966. /**
  1967. * The Unix epoch timestamp in seconds for when the resource was created.
  1968. */
  1969. createdAt: Timestamp;
  1970. /**
  1971. * The Unix epoch timestamp in seconds for when the resource was last updated.
  1972. */
  1973. lastUpdatedAt: Timestamp;
  1974. /**
  1975. * The name of the service mesh.
  1976. */
  1977. meshName: ResourceName;
  1978. /**
  1979. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  1980. */
  1981. meshOwner: AccountId;
  1982. /**
  1983. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  1984. */
  1985. resourceOwner: AccountId;
  1986. /**
  1987. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  1988. */
  1989. version: Long;
  1990. }
  1991. export interface MeshServiceDiscovery {
  1992. /**
  1993. * The IP version to use to control traffic within the mesh.
  1994. */
  1995. ipPreference?: IpPreference;
  1996. }
  1997. export interface MeshSpec {
  1998. /**
  1999. * The egress filter rules for the service mesh.
  2000. */
  2001. egressFilter?: EgressFilter;
  2002. serviceDiscovery?: MeshServiceDiscovery;
  2003. }
  2004. export interface MeshStatus {
  2005. /**
  2006. * The current mesh status.
  2007. */
  2008. status?: MeshStatusCode;
  2009. }
  2010. export type MeshStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  2011. export type MethodName = string;
  2012. export interface OutlierDetection {
  2013. /**
  2014. * The base amount of time for which a host is ejected.
  2015. */
  2016. baseEjectionDuration: Duration;
  2017. /**
  2018. * The time interval between ejection sweep analysis.
  2019. */
  2020. interval: Duration;
  2021. /**
  2022. * Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
  2023. */
  2024. maxEjectionPercent: OutlierDetectionMaxEjectionPercent;
  2025. /**
  2026. * Number of consecutive 5xx errors required for ejection.
  2027. */
  2028. maxServerErrors: OutlierDetectionMaxServerErrors;
  2029. }
  2030. export type OutlierDetectionMaxEjectionPercent = number;
  2031. export type OutlierDetectionMaxServerErrors = number;
  2032. export type PercentInt = number;
  2033. export interface PortMapping {
  2034. /**
  2035. * The port used for the port mapping.
  2036. */
  2037. port: PortNumber;
  2038. /**
  2039. * The protocol used for the port mapping. Specify one protocol.
  2040. */
  2041. protocol: PortProtocol;
  2042. }
  2043. export type PortNumber = number;
  2044. export type PortProtocol = "http"|"tcp"|"http2"|"grpc"|string;
  2045. export type PortSet = PortNumber[];
  2046. export interface QueryParameterMatch {
  2047. /**
  2048. * The exact query parameter to match on.
  2049. */
  2050. exact?: String;
  2051. }
  2052. export type QueryParameterName = string;
  2053. export interface ResourceMetadata {
  2054. /**
  2055. * The full Amazon Resource Name (ARN) for the resource.
  2056. */
  2057. arn: Arn;
  2058. /**
  2059. * The Unix epoch timestamp in seconds for when the resource was created.
  2060. */
  2061. createdAt: Timestamp;
  2062. /**
  2063. * The Unix epoch timestamp in seconds for when the resource was last updated.
  2064. */
  2065. lastUpdatedAt: Timestamp;
  2066. /**
  2067. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2068. */
  2069. meshOwner: AccountId;
  2070. /**
  2071. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  2072. */
  2073. resourceOwner: AccountId;
  2074. /**
  2075. * The unique identifier for the resource.
  2076. */
  2077. uid: String;
  2078. /**
  2079. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  2080. */
  2081. version: Long;
  2082. }
  2083. export type ResourceName = string;
  2084. export interface RouteData {
  2085. /**
  2086. * The name of the service mesh that the route resides in.
  2087. */
  2088. meshName: ResourceName;
  2089. /**
  2090. * The associated metadata for the route.
  2091. */
  2092. metadata: ResourceMetadata;
  2093. /**
  2094. * The name of the route.
  2095. */
  2096. routeName: ResourceName;
  2097. /**
  2098. * The specifications of the route.
  2099. */
  2100. spec: RouteSpec;
  2101. /**
  2102. * The status of the route.
  2103. */
  2104. status: RouteStatus;
  2105. /**
  2106. * The virtual router that the route is associated with.
  2107. */
  2108. virtualRouterName: ResourceName;
  2109. }
  2110. export type RouteList = RouteRef[];
  2111. export type RoutePriority = number;
  2112. export interface RouteRef {
  2113. /**
  2114. * The full Amazon Resource Name (ARN) for the route.
  2115. */
  2116. arn: Arn;
  2117. /**
  2118. * The Unix epoch timestamp in seconds for when the resource was created.
  2119. */
  2120. createdAt: Timestamp;
  2121. /**
  2122. * The Unix epoch timestamp in seconds for when the resource was last updated.
  2123. */
  2124. lastUpdatedAt: Timestamp;
  2125. /**
  2126. * The name of the service mesh that the route resides in.
  2127. */
  2128. meshName: ResourceName;
  2129. /**
  2130. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2131. */
  2132. meshOwner: AccountId;
  2133. /**
  2134. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  2135. */
  2136. resourceOwner: AccountId;
  2137. /**
  2138. * The name of the route.
  2139. */
  2140. routeName: ResourceName;
  2141. /**
  2142. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  2143. */
  2144. version: Long;
  2145. /**
  2146. * The virtual router that the route is associated with.
  2147. */
  2148. virtualRouterName: ResourceName;
  2149. }
  2150. export interface RouteSpec {
  2151. /**
  2152. * An object that represents the specification of a gRPC route.
  2153. */
  2154. grpcRoute?: GrpcRoute;
  2155. /**
  2156. * An object that represents the specification of an HTTP/2 route.
  2157. */
  2158. http2Route?: HttpRoute;
  2159. /**
  2160. * An object that represents the specification of an HTTP route.
  2161. */
  2162. httpRoute?: HttpRoute;
  2163. /**
  2164. * The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
  2165. */
  2166. priority?: RoutePriority;
  2167. /**
  2168. * An object that represents the specification of a TCP route.
  2169. */
  2170. tcpRoute?: TcpRoute;
  2171. }
  2172. export interface RouteStatus {
  2173. /**
  2174. * The current status for the route.
  2175. */
  2176. status: RouteStatusCode;
  2177. }
  2178. export type RouteStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  2179. export type SdsSecretName = string;
  2180. export interface ServiceDiscovery {
  2181. /**
  2182. * Specifies any Cloud Map information for the virtual node.
  2183. */
  2184. awsCloudMap?: AwsCloudMapServiceDiscovery;
  2185. /**
  2186. * Specifies the DNS information for the virtual node.
  2187. */
  2188. dns?: DnsServiceDiscovery;
  2189. }
  2190. export type ServiceName = string;
  2191. export type String = string;
  2192. export type SubjectAlternativeName = string;
  2193. export type SubjectAlternativeNameList = SubjectAlternativeName[];
  2194. export interface SubjectAlternativeNameMatchers {
  2195. /**
  2196. * The values sent must match the specified values exactly.
  2197. */
  2198. exact: SubjectAlternativeNameList;
  2199. }
  2200. export interface SubjectAlternativeNames {
  2201. /**
  2202. * An object that represents the criteria for determining a SANs match.
  2203. */
  2204. match: SubjectAlternativeNameMatchers;
  2205. }
  2206. export type SuffixHostname = string;
  2207. export type TagKey = string;
  2208. export type TagKeyList = TagKey[];
  2209. export type TagList = TagRef[];
  2210. export interface TagRef {
  2211. /**
  2212. * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  2213. */
  2214. key: TagKey;
  2215. /**
  2216. * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
  2217. */
  2218. value: TagValue;
  2219. }
  2220. export interface TagResourceInput {
  2221. /**
  2222. * The Amazon Resource Name (ARN) of the resource to add tags to.
  2223. */
  2224. resourceArn: Arn;
  2225. /**
  2226. * The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  2227. */
  2228. tags: TagList;
  2229. }
  2230. export interface TagResourceOutput {
  2231. }
  2232. export type TagValue = string;
  2233. export type TagsLimit = number;
  2234. export type TcpRetryPolicyEvent = "connection-error"|string;
  2235. export type TcpRetryPolicyEvents = TcpRetryPolicyEvent[];
  2236. export interface TcpRoute {
  2237. /**
  2238. * The action to take if a match is determined.
  2239. */
  2240. action: TcpRouteAction;
  2241. /**
  2242. * An object that represents the criteria for determining a request match.
  2243. */
  2244. match?: TcpRouteMatch;
  2245. /**
  2246. * An object that represents types of timeouts.
  2247. */
  2248. timeout?: TcpTimeout;
  2249. }
  2250. export interface TcpRouteAction {
  2251. /**
  2252. * An object that represents the targets that traffic is routed to when a request matches the route.
  2253. */
  2254. weightedTargets: WeightedTargets;
  2255. }
  2256. export interface TcpRouteMatch {
  2257. /**
  2258. * The port number to match on.
  2259. */
  2260. port?: ListenerPort;
  2261. }
  2262. export interface TcpTimeout {
  2263. /**
  2264. * An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
  2265. */
  2266. idle?: Duration;
  2267. }
  2268. export type TextFormat = string;
  2269. export type Timestamp = Date;
  2270. export interface TlsValidationContext {
  2271. /**
  2272. * A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
  2273. */
  2274. subjectAlternativeNames?: SubjectAlternativeNames;
  2275. /**
  2276. * A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
  2277. */
  2278. trust: TlsValidationContextTrust;
  2279. }
  2280. export interface TlsValidationContextAcmTrust {
  2281. /**
  2282. * One or more ACM Amazon Resource Name (ARN)s.
  2283. */
  2284. certificateAuthorityArns: CertificateAuthorityArns;
  2285. }
  2286. export interface TlsValidationContextFileTrust {
  2287. /**
  2288. * The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
  2289. */
  2290. certificateChain: FilePath;
  2291. }
  2292. export interface TlsValidationContextSdsTrust {
  2293. /**
  2294. * A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  2295. */
  2296. secretName: SdsSecretName;
  2297. }
  2298. export interface TlsValidationContextTrust {
  2299. /**
  2300. * A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
  2301. */
  2302. acm?: TlsValidationContextAcmTrust;
  2303. /**
  2304. * An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
  2305. */
  2306. file?: TlsValidationContextFileTrust;
  2307. /**
  2308. * A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  2309. */
  2310. sds?: TlsValidationContextSdsTrust;
  2311. }
  2312. export interface UntagResourceInput {
  2313. /**
  2314. * The Amazon Resource Name (ARN) of the resource to delete tags from.
  2315. */
  2316. resourceArn: Arn;
  2317. /**
  2318. * The keys of the tags to be removed.
  2319. */
  2320. tagKeys: TagKeyList;
  2321. }
  2322. export interface UntagResourceOutput {
  2323. }
  2324. export interface UpdateGatewayRouteInput {
  2325. /**
  2326. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2327. */
  2328. clientToken?: String;
  2329. /**
  2330. * The name of the gateway route to update.
  2331. */
  2332. gatewayRouteName: ResourceName;
  2333. /**
  2334. * The name of the service mesh that the gateway route resides in.
  2335. */
  2336. meshName: ResourceName;
  2337. /**
  2338. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2339. */
  2340. meshOwner?: AccountId;
  2341. /**
  2342. * The new gateway route specification to apply. This overwrites the existing data.
  2343. */
  2344. spec: GatewayRouteSpec;
  2345. /**
  2346. * The name of the virtual gateway that the gateway route is associated with.
  2347. */
  2348. virtualGatewayName: ResourceName;
  2349. }
  2350. export interface UpdateGatewayRouteOutput {
  2351. /**
  2352. * A full description of the gateway route that was updated.
  2353. */
  2354. gatewayRoute: GatewayRouteData;
  2355. }
  2356. export interface UpdateMeshInput {
  2357. /**
  2358. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2359. */
  2360. clientToken?: String;
  2361. /**
  2362. * The name of the service mesh to update.
  2363. */
  2364. meshName: ResourceName;
  2365. /**
  2366. * The service mesh specification to apply.
  2367. */
  2368. spec?: MeshSpec;
  2369. }
  2370. export interface UpdateMeshOutput {
  2371. mesh: MeshData;
  2372. }
  2373. export interface UpdateRouteInput {
  2374. /**
  2375. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2376. */
  2377. clientToken?: String;
  2378. /**
  2379. * The name of the service mesh that the route resides in.
  2380. */
  2381. meshName: ResourceName;
  2382. /**
  2383. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2384. */
  2385. meshOwner?: AccountId;
  2386. /**
  2387. * The name of the route to update.
  2388. */
  2389. routeName: ResourceName;
  2390. /**
  2391. * The new route specification to apply. This overwrites the existing data.
  2392. */
  2393. spec: RouteSpec;
  2394. /**
  2395. * The name of the virtual router that the route is associated with.
  2396. */
  2397. virtualRouterName: ResourceName;
  2398. }
  2399. export interface UpdateRouteOutput {
  2400. /**
  2401. * A full description of the route that was updated.
  2402. */
  2403. route: RouteData;
  2404. }
  2405. export interface UpdateVirtualGatewayInput {
  2406. /**
  2407. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2408. */
  2409. clientToken?: String;
  2410. /**
  2411. * The name of the service mesh that the virtual gateway resides in.
  2412. */
  2413. meshName: ResourceName;
  2414. /**
  2415. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2416. */
  2417. meshOwner?: AccountId;
  2418. /**
  2419. * The new virtual gateway specification to apply. This overwrites the existing data.
  2420. */
  2421. spec: VirtualGatewaySpec;
  2422. /**
  2423. * The name of the virtual gateway to update.
  2424. */
  2425. virtualGatewayName: ResourceName;
  2426. }
  2427. export interface UpdateVirtualGatewayOutput {
  2428. /**
  2429. * A full description of the virtual gateway that was updated.
  2430. */
  2431. virtualGateway: VirtualGatewayData;
  2432. }
  2433. export interface UpdateVirtualNodeInput {
  2434. /**
  2435. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2436. */
  2437. clientToken?: String;
  2438. /**
  2439. * The name of the service mesh that the virtual node resides in.
  2440. */
  2441. meshName: ResourceName;
  2442. /**
  2443. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2444. */
  2445. meshOwner?: AccountId;
  2446. /**
  2447. * The new virtual node specification to apply. This overwrites the existing data.
  2448. */
  2449. spec: VirtualNodeSpec;
  2450. /**
  2451. * The name of the virtual node to update.
  2452. */
  2453. virtualNodeName: ResourceName;
  2454. }
  2455. export interface UpdateVirtualNodeOutput {
  2456. /**
  2457. * A full description of the virtual node that was updated.
  2458. */
  2459. virtualNode: VirtualNodeData;
  2460. }
  2461. export interface UpdateVirtualRouterInput {
  2462. /**
  2463. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2464. */
  2465. clientToken?: String;
  2466. /**
  2467. * The name of the service mesh that the virtual router resides in.
  2468. */
  2469. meshName: ResourceName;
  2470. /**
  2471. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2472. */
  2473. meshOwner?: AccountId;
  2474. /**
  2475. * The new virtual router specification to apply. This overwrites the existing data.
  2476. */
  2477. spec: VirtualRouterSpec;
  2478. /**
  2479. * The name of the virtual router to update.
  2480. */
  2481. virtualRouterName: ResourceName;
  2482. }
  2483. export interface UpdateVirtualRouterOutput {
  2484. /**
  2485. * A full description of the virtual router that was updated.
  2486. */
  2487. virtualRouter: VirtualRouterData;
  2488. }
  2489. export interface UpdateVirtualServiceInput {
  2490. /**
  2491. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  2492. */
  2493. clientToken?: String;
  2494. /**
  2495. * The name of the service mesh that the virtual service resides in.
  2496. */
  2497. meshName: ResourceName;
  2498. /**
  2499. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2500. */
  2501. meshOwner?: AccountId;
  2502. /**
  2503. * The new virtual service specification to apply. This overwrites the existing data.
  2504. */
  2505. spec: VirtualServiceSpec;
  2506. /**
  2507. * The name of the virtual service to update.
  2508. */
  2509. virtualServiceName: ServiceName;
  2510. }
  2511. export interface UpdateVirtualServiceOutput {
  2512. /**
  2513. * A full description of the virtual service that was updated.
  2514. */
  2515. virtualService: VirtualServiceData;
  2516. }
  2517. export interface VirtualGatewayAccessLog {
  2518. /**
  2519. * The file object to send virtual gateway access logs to.
  2520. */
  2521. file?: VirtualGatewayFileAccessLog;
  2522. }
  2523. export interface VirtualGatewayBackendDefaults {
  2524. /**
  2525. * A reference to an object that represents a client policy.
  2526. */
  2527. clientPolicy?: VirtualGatewayClientPolicy;
  2528. }
  2529. export type VirtualGatewayCertificateAuthorityArns = Arn[];
  2530. export interface VirtualGatewayClientPolicy {
  2531. /**
  2532. * A reference to an object that represents a Transport Layer Security (TLS) client policy.
  2533. */
  2534. tls?: VirtualGatewayClientPolicyTls;
  2535. }
  2536. export interface VirtualGatewayClientPolicyTls {
  2537. /**
  2538. * A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.
  2539. */
  2540. certificate?: VirtualGatewayClientTlsCertificate;
  2541. /**
  2542. * Whether the policy is enforced. The default is True, if a value isn't specified.
  2543. */
  2544. enforce?: Boolean;
  2545. /**
  2546. * One or more ports that the policy is enforced for.
  2547. */
  2548. ports?: PortSet;
  2549. /**
  2550. * A reference to an object that represents a Transport Layer Security (TLS) validation context.
  2551. */
  2552. validation: VirtualGatewayTlsValidationContext;
  2553. }
  2554. export interface VirtualGatewayClientTlsCertificate {
  2555. /**
  2556. * An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
  2557. */
  2558. file?: VirtualGatewayListenerTlsFileCertificate;
  2559. /**
  2560. * A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
  2561. */
  2562. sds?: VirtualGatewayListenerTlsSdsCertificate;
  2563. }
  2564. export interface VirtualGatewayConnectionPool {
  2565. /**
  2566. * An object that represents a type of connection pool.
  2567. */
  2568. grpc?: VirtualGatewayGrpcConnectionPool;
  2569. /**
  2570. * An object that represents a type of connection pool.
  2571. */
  2572. http?: VirtualGatewayHttpConnectionPool;
  2573. /**
  2574. * An object that represents a type of connection pool.
  2575. */
  2576. http2?: VirtualGatewayHttp2ConnectionPool;
  2577. }
  2578. export interface VirtualGatewayData {
  2579. /**
  2580. * The name of the service mesh that the virtual gateway resides in.
  2581. */
  2582. meshName: ResourceName;
  2583. metadata: ResourceMetadata;
  2584. /**
  2585. * The specifications of the virtual gateway.
  2586. */
  2587. spec: VirtualGatewaySpec;
  2588. /**
  2589. * The current status of the virtual gateway.
  2590. */
  2591. status: VirtualGatewayStatus;
  2592. /**
  2593. * The name of the virtual gateway.
  2594. */
  2595. virtualGatewayName: ResourceName;
  2596. }
  2597. export interface VirtualGatewayFileAccessLog {
  2598. /**
  2599. * The specified format for the virtual gateway access logs. It can be either json_format or text_format.
  2600. */
  2601. format?: LoggingFormat;
  2602. /**
  2603. * The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
  2604. */
  2605. path: FilePath;
  2606. }
  2607. export interface VirtualGatewayGrpcConnectionPool {
  2608. /**
  2609. * Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
  2610. */
  2611. maxRequests: MaxRequests;
  2612. }
  2613. export type VirtualGatewayHealthCheckIntervalMillis = number;
  2614. export interface VirtualGatewayHealthCheckPolicy {
  2615. /**
  2616. * The number of consecutive successful health checks that must occur before declaring the listener healthy.
  2617. */
  2618. healthyThreshold: VirtualGatewayHealthCheckThreshold;
  2619. /**
  2620. * The time period in milliseconds between each health check execution.
  2621. */
  2622. intervalMillis: VirtualGatewayHealthCheckIntervalMillis;
  2623. /**
  2624. * The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
  2625. */
  2626. path?: String;
  2627. /**
  2628. * The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
  2629. */
  2630. port?: PortNumber;
  2631. /**
  2632. * The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
  2633. */
  2634. protocol: VirtualGatewayPortProtocol;
  2635. /**
  2636. * The amount of time to wait when receiving a response from the health check, in milliseconds.
  2637. */
  2638. timeoutMillis: VirtualGatewayHealthCheckTimeoutMillis;
  2639. /**
  2640. * The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
  2641. */
  2642. unhealthyThreshold: VirtualGatewayHealthCheckThreshold;
  2643. }
  2644. export type VirtualGatewayHealthCheckThreshold = number;
  2645. export type VirtualGatewayHealthCheckTimeoutMillis = number;
  2646. export interface VirtualGatewayHttp2ConnectionPool {
  2647. /**
  2648. * Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
  2649. */
  2650. maxRequests: MaxRequests;
  2651. }
  2652. export interface VirtualGatewayHttpConnectionPool {
  2653. /**
  2654. * Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
  2655. */
  2656. maxConnections: MaxConnections;
  2657. /**
  2658. * Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
  2659. */
  2660. maxPendingRequests?: MaxPendingRequests;
  2661. }
  2662. export type VirtualGatewayList = VirtualGatewayRef[];
  2663. export interface VirtualGatewayListener {
  2664. /**
  2665. * The connection pool information for the virtual gateway listener.
  2666. */
  2667. connectionPool?: VirtualGatewayConnectionPool;
  2668. /**
  2669. * The health check information for the listener.
  2670. */
  2671. healthCheck?: VirtualGatewayHealthCheckPolicy;
  2672. /**
  2673. * The port mapping information for the listener.
  2674. */
  2675. portMapping: VirtualGatewayPortMapping;
  2676. /**
  2677. * A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
  2678. */
  2679. tls?: VirtualGatewayListenerTls;
  2680. }
  2681. export interface VirtualGatewayListenerTls {
  2682. /**
  2683. * An object that represents a Transport Layer Security (TLS) certificate.
  2684. */
  2685. certificate: VirtualGatewayListenerTlsCertificate;
  2686. /**
  2687. * Specify one of the following modes. STRICT – Listener only accepts connections with TLS enabled. PERMISSIVE – Listener accepts connections with or without TLS enabled. DISABLED – Listener only accepts connections without TLS.
  2688. */
  2689. mode: VirtualGatewayListenerTlsMode;
  2690. /**
  2691. * A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
  2692. */
  2693. validation?: VirtualGatewayListenerTlsValidationContext;
  2694. }
  2695. export interface VirtualGatewayListenerTlsAcmCertificate {
  2696. /**
  2697. * The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
  2698. */
  2699. certificateArn: Arn;
  2700. }
  2701. export interface VirtualGatewayListenerTlsCertificate {
  2702. /**
  2703. * A reference to an object that represents an Certificate Manager certificate.
  2704. */
  2705. acm?: VirtualGatewayListenerTlsAcmCertificate;
  2706. /**
  2707. * A reference to an object that represents a local file certificate.
  2708. */
  2709. file?: VirtualGatewayListenerTlsFileCertificate;
  2710. /**
  2711. * A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
  2712. */
  2713. sds?: VirtualGatewayListenerTlsSdsCertificate;
  2714. }
  2715. export interface VirtualGatewayListenerTlsFileCertificate {
  2716. /**
  2717. * The certificate chain for the certificate.
  2718. */
  2719. certificateChain: FilePath;
  2720. /**
  2721. * The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
  2722. */
  2723. privateKey: FilePath;
  2724. }
  2725. export type VirtualGatewayListenerTlsMode = "STRICT"|"PERMISSIVE"|"DISABLED"|string;
  2726. export interface VirtualGatewayListenerTlsSdsCertificate {
  2727. /**
  2728. * A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
  2729. */
  2730. secretName: VirtualGatewaySdsSecretName;
  2731. }
  2732. export interface VirtualGatewayListenerTlsValidationContext {
  2733. /**
  2734. * A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.
  2735. */
  2736. subjectAlternativeNames?: SubjectAlternativeNames;
  2737. /**
  2738. * A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
  2739. */
  2740. trust: VirtualGatewayListenerTlsValidationContextTrust;
  2741. }
  2742. export interface VirtualGatewayListenerTlsValidationContextTrust {
  2743. /**
  2744. * An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
  2745. */
  2746. file?: VirtualGatewayTlsValidationContextFileTrust;
  2747. /**
  2748. * A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  2749. */
  2750. sds?: VirtualGatewayTlsValidationContextSdsTrust;
  2751. }
  2752. export type VirtualGatewayListeners = VirtualGatewayListener[];
  2753. export interface VirtualGatewayLogging {
  2754. /**
  2755. * The access log configuration.
  2756. */
  2757. accessLog?: VirtualGatewayAccessLog;
  2758. }
  2759. export interface VirtualGatewayPortMapping {
  2760. /**
  2761. * The port used for the port mapping. Specify one protocol.
  2762. */
  2763. port: PortNumber;
  2764. /**
  2765. * The protocol used for the port mapping.
  2766. */
  2767. protocol: VirtualGatewayPortProtocol;
  2768. }
  2769. export type VirtualGatewayPortProtocol = "http"|"http2"|"grpc"|string;
  2770. export interface VirtualGatewayRef {
  2771. /**
  2772. * The full Amazon Resource Name (ARN) for the resource.
  2773. */
  2774. arn: Arn;
  2775. /**
  2776. * The Unix epoch timestamp in seconds for when the resource was created.
  2777. */
  2778. createdAt: Timestamp;
  2779. /**
  2780. * The Unix epoch timestamp in seconds for when the resource was last updated.
  2781. */
  2782. lastUpdatedAt: Timestamp;
  2783. /**
  2784. * The name of the service mesh that the resource resides in.
  2785. */
  2786. meshName: ResourceName;
  2787. /**
  2788. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2789. */
  2790. meshOwner: AccountId;
  2791. /**
  2792. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  2793. */
  2794. resourceOwner: AccountId;
  2795. /**
  2796. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  2797. */
  2798. version: Long;
  2799. /**
  2800. * The name of the resource.
  2801. */
  2802. virtualGatewayName: ResourceName;
  2803. }
  2804. export type VirtualGatewaySdsSecretName = string;
  2805. export interface VirtualGatewaySpec {
  2806. /**
  2807. * A reference to an object that represents the defaults for backends.
  2808. */
  2809. backendDefaults?: VirtualGatewayBackendDefaults;
  2810. /**
  2811. * The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
  2812. */
  2813. listeners: VirtualGatewayListeners;
  2814. logging?: VirtualGatewayLogging;
  2815. }
  2816. export interface VirtualGatewayStatus {
  2817. /**
  2818. * The current status.
  2819. */
  2820. status: VirtualGatewayStatusCode;
  2821. }
  2822. export type VirtualGatewayStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  2823. export interface VirtualGatewayTlsValidationContext {
  2824. /**
  2825. * A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.
  2826. */
  2827. subjectAlternativeNames?: SubjectAlternativeNames;
  2828. /**
  2829. * A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
  2830. */
  2831. trust: VirtualGatewayTlsValidationContextTrust;
  2832. }
  2833. export interface VirtualGatewayTlsValidationContextAcmTrust {
  2834. /**
  2835. * One or more ACM Amazon Resource Name (ARN)s.
  2836. */
  2837. certificateAuthorityArns: VirtualGatewayCertificateAuthorityArns;
  2838. }
  2839. export interface VirtualGatewayTlsValidationContextFileTrust {
  2840. /**
  2841. * The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
  2842. */
  2843. certificateChain: FilePath;
  2844. }
  2845. export interface VirtualGatewayTlsValidationContextSdsTrust {
  2846. /**
  2847. * A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  2848. */
  2849. secretName: VirtualGatewaySdsSecretName;
  2850. }
  2851. export interface VirtualGatewayTlsValidationContextTrust {
  2852. /**
  2853. * A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
  2854. */
  2855. acm?: VirtualGatewayTlsValidationContextAcmTrust;
  2856. /**
  2857. * An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
  2858. */
  2859. file?: VirtualGatewayTlsValidationContextFileTrust;
  2860. /**
  2861. * A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  2862. */
  2863. sds?: VirtualGatewayTlsValidationContextSdsTrust;
  2864. }
  2865. export interface VirtualNodeConnectionPool {
  2866. /**
  2867. * An object that represents a type of connection pool.
  2868. */
  2869. grpc?: VirtualNodeGrpcConnectionPool;
  2870. /**
  2871. * An object that represents a type of connection pool.
  2872. */
  2873. http?: VirtualNodeHttpConnectionPool;
  2874. /**
  2875. * An object that represents a type of connection pool.
  2876. */
  2877. http2?: VirtualNodeHttp2ConnectionPool;
  2878. /**
  2879. * An object that represents a type of connection pool.
  2880. */
  2881. tcp?: VirtualNodeTcpConnectionPool;
  2882. }
  2883. export interface VirtualNodeData {
  2884. /**
  2885. * The name of the service mesh that the virtual node resides in.
  2886. */
  2887. meshName: ResourceName;
  2888. /**
  2889. * The associated metadata for the virtual node.
  2890. */
  2891. metadata: ResourceMetadata;
  2892. /**
  2893. * The specifications of the virtual node.
  2894. */
  2895. spec: VirtualNodeSpec;
  2896. /**
  2897. * The current status for the virtual node.
  2898. */
  2899. status: VirtualNodeStatus;
  2900. /**
  2901. * The name of the virtual node.
  2902. */
  2903. virtualNodeName: ResourceName;
  2904. }
  2905. export interface VirtualNodeGrpcConnectionPool {
  2906. /**
  2907. * Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
  2908. */
  2909. maxRequests: MaxRequests;
  2910. }
  2911. export interface VirtualNodeHttp2ConnectionPool {
  2912. /**
  2913. * Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
  2914. */
  2915. maxRequests: MaxRequests;
  2916. }
  2917. export interface VirtualNodeHttpConnectionPool {
  2918. /**
  2919. * Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
  2920. */
  2921. maxConnections: MaxConnections;
  2922. /**
  2923. * Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
  2924. */
  2925. maxPendingRequests?: MaxPendingRequests;
  2926. }
  2927. export type VirtualNodeList = VirtualNodeRef[];
  2928. export interface VirtualNodeRef {
  2929. /**
  2930. * The full Amazon Resource Name (ARN) for the virtual node.
  2931. */
  2932. arn: Arn;
  2933. /**
  2934. * The Unix epoch timestamp in seconds for when the resource was created.
  2935. */
  2936. createdAt: Timestamp;
  2937. /**
  2938. * The Unix epoch timestamp in seconds for when the resource was last updated.
  2939. */
  2940. lastUpdatedAt: Timestamp;
  2941. /**
  2942. * The name of the service mesh that the virtual node resides in.
  2943. */
  2944. meshName: ResourceName;
  2945. /**
  2946. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  2947. */
  2948. meshOwner: AccountId;
  2949. /**
  2950. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  2951. */
  2952. resourceOwner: AccountId;
  2953. /**
  2954. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  2955. */
  2956. version: Long;
  2957. /**
  2958. * The name of the virtual node.
  2959. */
  2960. virtualNodeName: ResourceName;
  2961. }
  2962. export interface VirtualNodeServiceProvider {
  2963. /**
  2964. * The name of the virtual node that is acting as a service provider.
  2965. */
  2966. virtualNodeName: ResourceName;
  2967. }
  2968. export interface VirtualNodeSpec {
  2969. /**
  2970. * A reference to an object that represents the defaults for backends.
  2971. */
  2972. backendDefaults?: BackendDefaults;
  2973. /**
  2974. * The backends that the virtual node is expected to send outbound traffic to.
  2975. */
  2976. backends?: Backends;
  2977. /**
  2978. * The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
  2979. */
  2980. listeners?: Listeners;
  2981. /**
  2982. * The inbound and outbound access logging information for the virtual node.
  2983. */
  2984. logging?: Logging;
  2985. /**
  2986. * The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.
  2987. */
  2988. serviceDiscovery?: ServiceDiscovery;
  2989. }
  2990. export interface VirtualNodeStatus {
  2991. /**
  2992. * The current status of the virtual node.
  2993. */
  2994. status: VirtualNodeStatusCode;
  2995. }
  2996. export type VirtualNodeStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  2997. export interface VirtualNodeTcpConnectionPool {
  2998. /**
  2999. * Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
  3000. */
  3001. maxConnections: MaxConnections;
  3002. }
  3003. export interface VirtualRouterData {
  3004. /**
  3005. * The name of the service mesh that the virtual router resides in.
  3006. */
  3007. meshName: ResourceName;
  3008. /**
  3009. * The associated metadata for the virtual router.
  3010. */
  3011. metadata: ResourceMetadata;
  3012. /**
  3013. * The specifications of the virtual router.
  3014. */
  3015. spec: VirtualRouterSpec;
  3016. /**
  3017. * The current status of the virtual router.
  3018. */
  3019. status: VirtualRouterStatus;
  3020. /**
  3021. * The name of the virtual router.
  3022. */
  3023. virtualRouterName: ResourceName;
  3024. }
  3025. export type VirtualRouterList = VirtualRouterRef[];
  3026. export interface VirtualRouterListener {
  3027. portMapping: PortMapping;
  3028. }
  3029. export type VirtualRouterListeners = VirtualRouterListener[];
  3030. export interface VirtualRouterRef {
  3031. /**
  3032. * The full Amazon Resource Name (ARN) for the virtual router.
  3033. */
  3034. arn: Arn;
  3035. /**
  3036. * The Unix epoch timestamp in seconds for when the resource was created.
  3037. */
  3038. createdAt: Timestamp;
  3039. /**
  3040. * The Unix epoch timestamp in seconds for when the resource was last updated.
  3041. */
  3042. lastUpdatedAt: Timestamp;
  3043. /**
  3044. * The name of the service mesh that the virtual router resides in.
  3045. */
  3046. meshName: ResourceName;
  3047. /**
  3048. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  3049. */
  3050. meshOwner: AccountId;
  3051. /**
  3052. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  3053. */
  3054. resourceOwner: AccountId;
  3055. /**
  3056. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  3057. */
  3058. version: Long;
  3059. /**
  3060. * The name of the virtual router.
  3061. */
  3062. virtualRouterName: ResourceName;
  3063. }
  3064. export interface VirtualRouterServiceProvider {
  3065. /**
  3066. * The name of the virtual router that is acting as a service provider.
  3067. */
  3068. virtualRouterName: ResourceName;
  3069. }
  3070. export interface VirtualRouterSpec {
  3071. /**
  3072. * The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
  3073. */
  3074. listeners?: VirtualRouterListeners;
  3075. }
  3076. export interface VirtualRouterStatus {
  3077. /**
  3078. * The current status of the virtual router.
  3079. */
  3080. status: VirtualRouterStatusCode;
  3081. }
  3082. export type VirtualRouterStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  3083. export interface VirtualServiceBackend {
  3084. /**
  3085. * A reference to an object that represents the client policy for a backend.
  3086. */
  3087. clientPolicy?: ClientPolicy;
  3088. /**
  3089. * The name of the virtual service that is acting as a virtual node backend.
  3090. */
  3091. virtualServiceName: ServiceName;
  3092. }
  3093. export interface VirtualServiceData {
  3094. /**
  3095. * The name of the service mesh that the virtual service resides in.
  3096. */
  3097. meshName: ResourceName;
  3098. metadata: ResourceMetadata;
  3099. /**
  3100. * The specifications of the virtual service.
  3101. */
  3102. spec: VirtualServiceSpec;
  3103. /**
  3104. * The current status of the virtual service.
  3105. */
  3106. status: VirtualServiceStatus;
  3107. /**
  3108. * The name of the virtual service.
  3109. */
  3110. virtualServiceName: ServiceName;
  3111. }
  3112. export type VirtualServiceList = VirtualServiceRef[];
  3113. export interface VirtualServiceProvider {
  3114. /**
  3115. * The virtual node associated with a virtual service.
  3116. */
  3117. virtualNode?: VirtualNodeServiceProvider;
  3118. /**
  3119. * The virtual router associated with a virtual service.
  3120. */
  3121. virtualRouter?: VirtualRouterServiceProvider;
  3122. }
  3123. export interface VirtualServiceRef {
  3124. /**
  3125. * The full Amazon Resource Name (ARN) for the virtual service.
  3126. */
  3127. arn: Arn;
  3128. /**
  3129. * The Unix epoch timestamp in seconds for when the resource was created.
  3130. */
  3131. createdAt: Timestamp;
  3132. /**
  3133. * The Unix epoch timestamp in seconds for when the resource was last updated.
  3134. */
  3135. lastUpdatedAt: Timestamp;
  3136. /**
  3137. * The name of the service mesh that the virtual service resides in.
  3138. */
  3139. meshName: ResourceName;
  3140. /**
  3141. * The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
  3142. */
  3143. meshOwner: AccountId;
  3144. /**
  3145. * The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
  3146. */
  3147. resourceOwner: AccountId;
  3148. /**
  3149. * The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
  3150. */
  3151. version: Long;
  3152. /**
  3153. * The name of the virtual service.
  3154. */
  3155. virtualServiceName: ServiceName;
  3156. }
  3157. export interface VirtualServiceSpec {
  3158. /**
  3159. * The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
  3160. */
  3161. provider?: VirtualServiceProvider;
  3162. }
  3163. export interface VirtualServiceStatus {
  3164. /**
  3165. * The current status of the virtual service.
  3166. */
  3167. status: VirtualServiceStatusCode;
  3168. }
  3169. export type VirtualServiceStatusCode = "ACTIVE"|"INACTIVE"|"DELETED"|string;
  3170. export interface WeightedTarget {
  3171. /**
  3172. * The targeted port of the weighted object.
  3173. */
  3174. port?: ListenerPort;
  3175. /**
  3176. * The virtual node to associate with the weighted target.
  3177. */
  3178. virtualNode: ResourceName;
  3179. /**
  3180. * The relative weight of the weighted target.
  3181. */
  3182. weight: PercentInt;
  3183. }
  3184. export type WeightedTargets = WeightedTarget[];
  3185. /**
  3186. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  3187. */
  3188. export type apiVersion = "2018-10-01"|"2018-10-01"|"2019-01-25"|"latest"|string;
  3189. export interface ClientApiVersions {
  3190. /**
  3191. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  3192. */
  3193. apiVersion?: apiVersion;
  3194. }
  3195. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  3196. /**
  3197. * Contains interfaces for use with the AppMesh client.
  3198. */
  3199. export import Types = AppMesh;
  3200. }
  3201. export = AppMesh;