globalaccelerator.d.ts 135 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090
  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 GlobalAccelerator extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: GlobalAccelerator.Types.ClientConfiguration)
  13. config: Config & GlobalAccelerator.Types.ClientConfiguration;
  14. /**
  15. * Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator. The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports. Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException. By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
  16. */
  17. addCustomRoutingEndpoints(params: GlobalAccelerator.Types.AddCustomRoutingEndpointsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse, AWSError>;
  18. /**
  19. * Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator. The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports. Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException. By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
  20. */
  21. addCustomRoutingEndpoints(callback?: (err: AWSError, data: GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse, AWSError>;
  22. /**
  23. * Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints in Global Accelerator: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints. It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add. For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
  24. */
  25. addEndpoints(params: GlobalAccelerator.Types.AddEndpointsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.AddEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddEndpointsResponse, AWSError>;
  26. /**
  27. * Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints in Global Accelerator: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints. It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add. For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
  28. */
  29. addEndpoints(callback?: (err: AWSError, data: GlobalAccelerator.Types.AddEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddEndpointsResponse, AWSError>;
  30. /**
  31. * Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  32. */
  33. advertiseByoipCidr(params: GlobalAccelerator.Types.AdvertiseByoipCidrRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.AdvertiseByoipCidrResponse) => void): Request<GlobalAccelerator.Types.AdvertiseByoipCidrResponse, AWSError>;
  34. /**
  35. * Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  36. */
  37. advertiseByoipCidr(callback?: (err: AWSError, data: GlobalAccelerator.Types.AdvertiseByoipCidrResponse) => void): Request<GlobalAccelerator.Types.AdvertiseByoipCidrResponse, AWSError>;
  38. /**
  39. * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
  40. */
  41. allowCustomRoutingTraffic(params: GlobalAccelerator.Types.AllowCustomRoutingTrafficRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  42. /**
  43. * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
  44. */
  45. allowCustomRoutingTraffic(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  46. /**
  47. * Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  48. */
  49. createAccelerator(params: GlobalAccelerator.Types.CreateAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateAcceleratorResponse) => void): Request<GlobalAccelerator.Types.CreateAcceleratorResponse, AWSError>;
  50. /**
  51. * Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  52. */
  53. createAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateAcceleratorResponse) => void): Request<GlobalAccelerator.Types.CreateAcceleratorResponse, AWSError>;
  54. /**
  55. * Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment. Specify each principal and resource separately. To specify two CIDR address pools, list them individually under Resources, and so on. For a command line operation, for example, you might use a statement like the following: "Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}] For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  56. */
  57. createCrossAccountAttachment(params: GlobalAccelerator.Types.CreateCrossAccountAttachmentRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.CreateCrossAccountAttachmentResponse, AWSError>;
  58. /**
  59. * Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment. Specify each principal and resource separately. To specify two CIDR address pools, list them individually under Resources, and so on. For a command line operation, for example, you might use a statement like the following: "Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}] For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  60. */
  61. createCrossAccountAttachment(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.CreateCrossAccountAttachmentResponse, AWSError>;
  62. /**
  63. * Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  64. */
  65. createCustomRoutingAccelerator(params: GlobalAccelerator.Types.CreateCustomRoutingAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingAcceleratorResponse, AWSError>;
  66. /**
  67. * Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  68. */
  69. createCustomRoutingAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingAcceleratorResponse, AWSError>;
  70. /**
  71. * Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
  72. */
  73. createCustomRoutingEndpointGroup(params: GlobalAccelerator.Types.CreateCustomRoutingEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingEndpointGroupResponse, AWSError>;
  74. /**
  75. * Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
  76. */
  77. createCustomRoutingEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingEndpointGroupResponse, AWSError>;
  78. /**
  79. * Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
  80. */
  81. createCustomRoutingListener(params: GlobalAccelerator.Types.CreateCustomRoutingListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingListenerResponse, AWSError>;
  82. /**
  83. * Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
  84. */
  85. createCustomRoutingListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.CreateCustomRoutingListenerResponse, AWSError>;
  86. /**
  87. * Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint. For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
  88. */
  89. createEndpointGroup(params: GlobalAccelerator.Types.CreateEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.CreateEndpointGroupResponse, AWSError>;
  90. /**
  91. * Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint. For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
  92. */
  93. createEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.CreateEndpointGroupResponse, AWSError>;
  94. /**
  95. * Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
  96. */
  97. createListener(params: GlobalAccelerator.Types.CreateListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateListenerResponse) => void): Request<GlobalAccelerator.Types.CreateListenerResponse, AWSError>;
  98. /**
  99. * Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
  100. */
  101. createListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateListenerResponse) => void): Request<GlobalAccelerator.Types.CreateListenerResponse, AWSError>;
  102. /**
  103. * Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
  104. */
  105. deleteAccelerator(params: GlobalAccelerator.Types.DeleteAcceleratorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  106. /**
  107. * Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
  108. */
  109. deleteAccelerator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  110. /**
  111. * Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  112. */
  113. deleteCrossAccountAttachment(params: GlobalAccelerator.Types.DeleteCrossAccountAttachmentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  114. /**
  115. * Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  116. */
  117. deleteCrossAccountAttachment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  118. /**
  119. * Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
  120. */
  121. deleteCustomRoutingAccelerator(params: GlobalAccelerator.Types.DeleteCustomRoutingAcceleratorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  122. /**
  123. * Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
  124. */
  125. deleteCustomRoutingAccelerator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  126. /**
  127. * Delete an endpoint group from a listener for a custom routing accelerator.
  128. */
  129. deleteCustomRoutingEndpointGroup(params: GlobalAccelerator.Types.DeleteCustomRoutingEndpointGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  130. /**
  131. * Delete an endpoint group from a listener for a custom routing accelerator.
  132. */
  133. deleteCustomRoutingEndpointGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  134. /**
  135. * Delete a listener for a custom routing accelerator.
  136. */
  137. deleteCustomRoutingListener(params: GlobalAccelerator.Types.DeleteCustomRoutingListenerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  138. /**
  139. * Delete a listener for a custom routing accelerator.
  140. */
  141. deleteCustomRoutingListener(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  142. /**
  143. * Delete an endpoint group from a listener.
  144. */
  145. deleteEndpointGroup(params: GlobalAccelerator.Types.DeleteEndpointGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  146. /**
  147. * Delete an endpoint group from a listener.
  148. */
  149. deleteEndpointGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  150. /**
  151. * Delete a listener from an accelerator.
  152. */
  153. deleteListener(params: GlobalAccelerator.Types.DeleteListenerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  154. /**
  155. * Delete a listener from an accelerator.
  156. */
  157. deleteListener(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  158. /**
  159. * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
  160. */
  161. denyCustomRoutingTraffic(params: GlobalAccelerator.Types.DenyCustomRoutingTrafficRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  162. /**
  163. * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
  164. */
  165. denyCustomRoutingTraffic(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  166. /**
  167. * Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  168. */
  169. deprovisionByoipCidr(params: GlobalAccelerator.Types.DeprovisionByoipCidrRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DeprovisionByoipCidrResponse) => void): Request<GlobalAccelerator.Types.DeprovisionByoipCidrResponse, AWSError>;
  170. /**
  171. * Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  172. */
  173. deprovisionByoipCidr(callback?: (err: AWSError, data: GlobalAccelerator.Types.DeprovisionByoipCidrResponse) => void): Request<GlobalAccelerator.Types.DeprovisionByoipCidrResponse, AWSError>;
  174. /**
  175. * Describe an accelerator.
  176. */
  177. describeAccelerator(params: GlobalAccelerator.Types.DescribeAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorResponse) => void): Request<GlobalAccelerator.Types.DescribeAcceleratorResponse, AWSError>;
  178. /**
  179. * Describe an accelerator.
  180. */
  181. describeAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorResponse) => void): Request<GlobalAccelerator.Types.DescribeAcceleratorResponse, AWSError>;
  182. /**
  183. * Describe the attributes of an accelerator.
  184. */
  185. describeAcceleratorAttributes(params: GlobalAccelerator.Types.DescribeAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse, AWSError>;
  186. /**
  187. * Describe the attributes of an accelerator.
  188. */
  189. describeAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse, AWSError>;
  190. /**
  191. * Gets configuration information about a cross-account attachment.
  192. */
  193. describeCrossAccountAttachment(params: GlobalAccelerator.Types.DescribeCrossAccountAttachmentRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.DescribeCrossAccountAttachmentResponse, AWSError>;
  194. /**
  195. * Gets configuration information about a cross-account attachment.
  196. */
  197. describeCrossAccountAttachment(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.DescribeCrossAccountAttachmentResponse, AWSError>;
  198. /**
  199. * Describe a custom routing accelerator.
  200. */
  201. describeCustomRoutingAccelerator(params: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorResponse, AWSError>;
  202. /**
  203. * Describe a custom routing accelerator.
  204. */
  205. describeCustomRoutingAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorResponse, AWSError>;
  206. /**
  207. * Describe the attributes of a custom routing accelerator.
  208. */
  209. describeCustomRoutingAcceleratorAttributes(params: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorAttributesResponse, AWSError>;
  210. /**
  211. * Describe the attributes of a custom routing accelerator.
  212. */
  213. describeCustomRoutingAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingAcceleratorAttributesResponse, AWSError>;
  214. /**
  215. * Describe an endpoint group for a custom routing accelerator.
  216. */
  217. describeCustomRoutingEndpointGroup(params: GlobalAccelerator.Types.DescribeCustomRoutingEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingEndpointGroupResponse, AWSError>;
  218. /**
  219. * Describe an endpoint group for a custom routing accelerator.
  220. */
  221. describeCustomRoutingEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingEndpointGroupResponse, AWSError>;
  222. /**
  223. * The description of a listener for a custom routing accelerator.
  224. */
  225. describeCustomRoutingListener(params: GlobalAccelerator.Types.DescribeCustomRoutingListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingListenerResponse, AWSError>;
  226. /**
  227. * The description of a listener for a custom routing accelerator.
  228. */
  229. describeCustomRoutingListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.DescribeCustomRoutingListenerResponse, AWSError>;
  230. /**
  231. * Describe an endpoint group.
  232. */
  233. describeEndpointGroup(params: GlobalAccelerator.Types.DescribeEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.DescribeEndpointGroupResponse, AWSError>;
  234. /**
  235. * Describe an endpoint group.
  236. */
  237. describeEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.DescribeEndpointGroupResponse, AWSError>;
  238. /**
  239. * Describe a listener.
  240. */
  241. describeListener(params: GlobalAccelerator.Types.DescribeListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeListenerResponse) => void): Request<GlobalAccelerator.Types.DescribeListenerResponse, AWSError>;
  242. /**
  243. * Describe a listener.
  244. */
  245. describeListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeListenerResponse) => void): Request<GlobalAccelerator.Types.DescribeListenerResponse, AWSError>;
  246. /**
  247. * List the accelerators for an Amazon Web Services account.
  248. */
  249. listAccelerators(params: GlobalAccelerator.Types.ListAcceleratorsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListAcceleratorsResponse) => void): Request<GlobalAccelerator.Types.ListAcceleratorsResponse, AWSError>;
  250. /**
  251. * List the accelerators for an Amazon Web Services account.
  252. */
  253. listAccelerators(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListAcceleratorsResponse) => void): Request<GlobalAccelerator.Types.ListAcceleratorsResponse, AWSError>;
  254. /**
  255. * Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
  256. */
  257. listByoipCidrs(params: GlobalAccelerator.Types.ListByoipCidrsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListByoipCidrsResponse) => void): Request<GlobalAccelerator.Types.ListByoipCidrsResponse, AWSError>;
  258. /**
  259. * Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
  260. */
  261. listByoipCidrs(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListByoipCidrsResponse) => void): Request<GlobalAccelerator.Types.ListByoipCidrsResponse, AWSError>;
  262. /**
  263. * List the cross-account attachments that have been created in Global Accelerator.
  264. */
  265. listCrossAccountAttachments(params: GlobalAccelerator.Types.ListCrossAccountAttachmentsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountAttachmentsResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountAttachmentsResponse, AWSError>;
  266. /**
  267. * List the cross-account attachments that have been created in Global Accelerator.
  268. */
  269. listCrossAccountAttachments(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountAttachmentsResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountAttachmentsResponse, AWSError>;
  270. /**
  271. * List the accounts that have cross-account resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  272. */
  273. listCrossAccountResourceAccounts(params: GlobalAccelerator.Types.ListCrossAccountResourceAccountsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountResourceAccountsResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountResourceAccountsResponse, AWSError>;
  274. /**
  275. * List the accounts that have cross-account resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  276. */
  277. listCrossAccountResourceAccounts(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountResourceAccountsResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountResourceAccountsResponse, AWSError>;
  278. /**
  279. * List the cross-account resources available to work with.
  280. */
  281. listCrossAccountResources(params: GlobalAccelerator.Types.ListCrossAccountResourcesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountResourcesResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountResourcesResponse, AWSError>;
  282. /**
  283. * List the cross-account resources available to work with.
  284. */
  285. listCrossAccountResources(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCrossAccountResourcesResponse) => void): Request<GlobalAccelerator.Types.ListCrossAccountResourcesResponse, AWSError>;
  286. /**
  287. * List the custom routing accelerators for an Amazon Web Services account.
  288. */
  289. listCustomRoutingAccelerators(params: GlobalAccelerator.Types.ListCustomRoutingAcceleratorsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingAcceleratorsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingAcceleratorsResponse, AWSError>;
  290. /**
  291. * List the custom routing accelerators for an Amazon Web Services account.
  292. */
  293. listCustomRoutingAccelerators(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingAcceleratorsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingAcceleratorsResponse, AWSError>;
  294. /**
  295. * List the endpoint groups that are associated with a listener for a custom routing accelerator.
  296. */
  297. listCustomRoutingEndpointGroups(params: GlobalAccelerator.Types.ListCustomRoutingEndpointGroupsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingEndpointGroupsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingEndpointGroupsResponse, AWSError>;
  298. /**
  299. * List the endpoint groups that are associated with a listener for a custom routing accelerator.
  300. */
  301. listCustomRoutingEndpointGroups(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingEndpointGroupsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingEndpointGroupsResponse, AWSError>;
  302. /**
  303. * List the listeners for a custom routing accelerator.
  304. */
  305. listCustomRoutingListeners(params: GlobalAccelerator.Types.ListCustomRoutingListenersRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingListenersResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingListenersResponse, AWSError>;
  306. /**
  307. * List the listeners for a custom routing accelerator.
  308. */
  309. listCustomRoutingListeners(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingListenersResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingListenersResponse, AWSError>;
  310. /**
  311. * Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator. The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
  312. */
  313. listCustomRoutingPortMappings(params: GlobalAccelerator.Types.ListCustomRoutingPortMappingsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingPortMappingsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingPortMappingsResponse, AWSError>;
  314. /**
  315. * Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator. The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
  316. */
  317. listCustomRoutingPortMappings(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingPortMappingsResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingPortMappingsResponse, AWSError>;
  318. /**
  319. * List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
  320. */
  321. listCustomRoutingPortMappingsByDestination(params: GlobalAccelerator.Types.ListCustomRoutingPortMappingsByDestinationRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingPortMappingsByDestinationResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingPortMappingsByDestinationResponse, AWSError>;
  322. /**
  323. * List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
  324. */
  325. listCustomRoutingPortMappingsByDestination(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListCustomRoutingPortMappingsByDestinationResponse) => void): Request<GlobalAccelerator.Types.ListCustomRoutingPortMappingsByDestinationResponse, AWSError>;
  326. /**
  327. * List the endpoint groups that are associated with a listener.
  328. */
  329. listEndpointGroups(params: GlobalAccelerator.Types.ListEndpointGroupsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListEndpointGroupsResponse) => void): Request<GlobalAccelerator.Types.ListEndpointGroupsResponse, AWSError>;
  330. /**
  331. * List the endpoint groups that are associated with a listener.
  332. */
  333. listEndpointGroups(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListEndpointGroupsResponse) => void): Request<GlobalAccelerator.Types.ListEndpointGroupsResponse, AWSError>;
  334. /**
  335. * List the listeners for an accelerator.
  336. */
  337. listListeners(params: GlobalAccelerator.Types.ListListenersRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListListenersResponse) => void): Request<GlobalAccelerator.Types.ListListenersResponse, AWSError>;
  338. /**
  339. * List the listeners for an accelerator.
  340. */
  341. listListeners(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListListenersResponse) => void): Request<GlobalAccelerator.Types.ListListenersResponse, AWSError>;
  342. /**
  343. * List all tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  344. */
  345. listTagsForResource(params: GlobalAccelerator.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListTagsForResourceResponse) => void): Request<GlobalAccelerator.Types.ListTagsForResourceResponse, AWSError>;
  346. /**
  347. * List all tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  348. */
  349. listTagsForResource(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListTagsForResourceResponse) => void): Request<GlobalAccelerator.Types.ListTagsForResourceResponse, AWSError>;
  350. /**
  351. * Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  352. */
  353. provisionByoipCidr(params: GlobalAccelerator.Types.ProvisionByoipCidrRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ProvisionByoipCidrResponse) => void): Request<GlobalAccelerator.Types.ProvisionByoipCidrResponse, AWSError>;
  354. /**
  355. * Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  356. */
  357. provisionByoipCidr(callback?: (err: AWSError, data: GlobalAccelerator.Types.ProvisionByoipCidrResponse) => void): Request<GlobalAccelerator.Types.ProvisionByoipCidrResponse, AWSError>;
  358. /**
  359. * Remove endpoints from a custom routing accelerator.
  360. */
  361. removeCustomRoutingEndpoints(params: GlobalAccelerator.Types.RemoveCustomRoutingEndpointsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  362. /**
  363. * Remove endpoints from a custom routing accelerator.
  364. */
  365. removeCustomRoutingEndpoints(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  366. /**
  367. * Remove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
  368. */
  369. removeEndpoints(params: GlobalAccelerator.Types.RemoveEndpointsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  370. /**
  371. * Remove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
  372. */
  373. removeEndpoints(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  374. /**
  375. * Add tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  376. */
  377. tagResource(params: GlobalAccelerator.Types.TagResourceRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.TagResourceResponse) => void): Request<GlobalAccelerator.Types.TagResourceResponse, AWSError>;
  378. /**
  379. * Add tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  380. */
  381. tagResource(callback?: (err: AWSError, data: GlobalAccelerator.Types.TagResourceResponse) => void): Request<GlobalAccelerator.Types.TagResourceResponse, AWSError>;
  382. /**
  383. * Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  384. */
  385. untagResource(params: GlobalAccelerator.Types.UntagResourceRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UntagResourceResponse) => void): Request<GlobalAccelerator.Types.UntagResourceResponse, AWSError>;
  386. /**
  387. * Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  388. */
  389. untagResource(callback?: (err: AWSError, data: GlobalAccelerator.Types.UntagResourceResponse) => void): Request<GlobalAccelerator.Types.UntagResourceResponse, AWSError>;
  390. /**
  391. * Update an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it. Enable the accelerator, if it is disabled. Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  392. */
  393. updateAccelerator(params: GlobalAccelerator.Types.UpdateAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorResponse) => void): Request<GlobalAccelerator.Types.UpdateAcceleratorResponse, AWSError>;
  394. /**
  395. * Update an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it. Enable the accelerator, if it is disabled. Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
  396. */
  397. updateAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorResponse) => void): Request<GlobalAccelerator.Types.UpdateAcceleratorResponse, AWSError>;
  398. /**
  399. * Update the attributes for an accelerator.
  400. */
  401. updateAcceleratorAttributes(params: GlobalAccelerator.Types.UpdateAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse, AWSError>;
  402. /**
  403. * Update the attributes for an accelerator.
  404. */
  405. updateAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse, AWSError>;
  406. /**
  407. * Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  408. */
  409. updateCrossAccountAttachment(params: GlobalAccelerator.Types.UpdateCrossAccountAttachmentRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.UpdateCrossAccountAttachmentResponse, AWSError>;
  410. /**
  411. * Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
  412. */
  413. updateCrossAccountAttachment(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCrossAccountAttachmentResponse) => void): Request<GlobalAccelerator.Types.UpdateCrossAccountAttachmentResponse, AWSError>;
  414. /**
  415. * Update a custom routing accelerator.
  416. */
  417. updateCustomRoutingAccelerator(params: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorResponse, AWSError>;
  418. /**
  419. * Update a custom routing accelerator.
  420. */
  421. updateCustomRoutingAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorResponse, AWSError>;
  422. /**
  423. * Update the attributes for a custom routing accelerator.
  424. */
  425. updateCustomRoutingAcceleratorAttributes(params: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorAttributesResponse, AWSError>;
  426. /**
  427. * Update the attributes for a custom routing accelerator.
  428. */
  429. updateCustomRoutingAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorAttributesResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingAcceleratorAttributesResponse, AWSError>;
  430. /**
  431. * Update a listener for a custom routing accelerator.
  432. */
  433. updateCustomRoutingListener(params: GlobalAccelerator.Types.UpdateCustomRoutingListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingListenerResponse, AWSError>;
  434. /**
  435. * Update a listener for a custom routing accelerator.
  436. */
  437. updateCustomRoutingListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateCustomRoutingListenerResponse) => void): Request<GlobalAccelerator.Types.UpdateCustomRoutingListenerResponse, AWSError>;
  438. /**
  439. * Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
  440. */
  441. updateEndpointGroup(params: GlobalAccelerator.Types.UpdateEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.UpdateEndpointGroupResponse, AWSError>;
  442. /**
  443. * Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
  444. */
  445. updateEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateEndpointGroupResponse) => void): Request<GlobalAccelerator.Types.UpdateEndpointGroupResponse, AWSError>;
  446. /**
  447. * Update a listener.
  448. */
  449. updateListener(params: GlobalAccelerator.Types.UpdateListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateListenerResponse) => void): Request<GlobalAccelerator.Types.UpdateListenerResponse, AWSError>;
  450. /**
  451. * Update a listener.
  452. */
  453. updateListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateListenerResponse) => void): Request<GlobalAccelerator.Types.UpdateListenerResponse, AWSError>;
  454. /**
  455. * Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  456. */
  457. withdrawByoipCidr(params: GlobalAccelerator.Types.WithdrawByoipCidrRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.WithdrawByoipCidrResponse) => void): Request<GlobalAccelerator.Types.WithdrawByoipCidrResponse, AWSError>;
  458. /**
  459. * Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  460. */
  461. withdrawByoipCidr(callback?: (err: AWSError, data: GlobalAccelerator.Types.WithdrawByoipCidrResponse) => void): Request<GlobalAccelerator.Types.WithdrawByoipCidrResponse, AWSError>;
  462. }
  463. declare namespace GlobalAccelerator {
  464. export interface Accelerator {
  465. /**
  466. * The Amazon Resource Name (ARN) of the accelerator.
  467. */
  468. AcceleratorArn?: GenericString;
  469. /**
  470. * The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
  471. */
  472. Name?: GenericString;
  473. /**
  474. * The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
  475. */
  476. IpAddressType?: IpAddressType;
  477. /**
  478. * Indicates whether the accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
  479. */
  480. Enabled?: GenericBoolean;
  481. /**
  482. * The static IP addresses that Global Accelerator associates with the accelerator.
  483. */
  484. IpSets?: IpSets;
  485. /**
  486. * The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses. For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
  487. */
  488. DnsName?: GenericString;
  489. /**
  490. * Describes the deployment status of the accelerator.
  491. */
  492. Status?: AcceleratorStatus;
  493. /**
  494. * The date and time that the accelerator was created.
  495. */
  496. CreatedTime?: Timestamp;
  497. /**
  498. * The date and time that the accelerator was last modified.
  499. */
  500. LastModifiedTime?: Timestamp;
  501. /**
  502. * The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com. Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses. For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
  503. */
  504. DualStackDnsName?: GenericString;
  505. /**
  506. * A history of changes that you make to an accelerator in Global Accelerator.
  507. */
  508. Events?: AcceleratorEvents;
  509. }
  510. export interface AcceleratorAttributes {
  511. /**
  512. * Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow logs in the Global Accelerator Developer Guide.
  513. */
  514. FlowLogsEnabled?: GenericBoolean;
  515. /**
  516. * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.
  517. */
  518. FlowLogsS3Bucket?: GenericString;
  519. /**
  520. * The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id
  521. */
  522. FlowLogsS3Prefix?: GenericString;
  523. }
  524. export interface AcceleratorEvent {
  525. /**
  526. * A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
  527. */
  528. Message?: GenericString;
  529. /**
  530. * A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
  531. */
  532. Timestamp?: Timestamp;
  533. }
  534. export type AcceleratorEvents = AcceleratorEvent[];
  535. export type AcceleratorStatus = "DEPLOYED"|"IN_PROGRESS"|string;
  536. export type Accelerators = Accelerator[];
  537. export interface AddCustomRoutingEndpointsRequest {
  538. /**
  539. * The list of endpoint objects to add to a custom routing accelerator.
  540. */
  541. EndpointConfigurations: CustomRoutingEndpointConfigurations;
  542. /**
  543. * The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
  544. */
  545. EndpointGroupArn: GenericString;
  546. }
  547. export interface AddCustomRoutingEndpointsResponse {
  548. /**
  549. * The endpoint objects added to the custom routing accelerator.
  550. */
  551. EndpointDescriptions?: CustomRoutingEndpointDescriptions;
  552. /**
  553. * The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
  554. */
  555. EndpointGroupArn?: GenericString;
  556. }
  557. export interface AddEndpointsRequest {
  558. /**
  559. * The list of endpoint objects.
  560. */
  561. EndpointConfigurations: EndpointConfigurations;
  562. /**
  563. * The Amazon Resource Name (ARN) of the endpoint group.
  564. */
  565. EndpointGroupArn: GenericString;
  566. }
  567. export interface AddEndpointsResponse {
  568. /**
  569. * The list of endpoint objects.
  570. */
  571. EndpointDescriptions?: EndpointDescriptions;
  572. /**
  573. * The Amazon Resource Name (ARN) of the endpoint group.
  574. */
  575. EndpointGroupArn?: GenericString;
  576. }
  577. export interface AdvertiseByoipCidrRequest {
  578. /**
  579. * The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  580. */
  581. Cidr: GenericString;
  582. }
  583. export interface AdvertiseByoipCidrResponse {
  584. /**
  585. * Information about the address range.
  586. */
  587. ByoipCidr?: ByoipCidr;
  588. }
  589. export interface AllowCustomRoutingTrafficRequest {
  590. /**
  591. * The Amazon Resource Name (ARN) of the endpoint group.
  592. */
  593. EndpointGroupArn: GenericString;
  594. /**
  595. * An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
  596. */
  597. EndpointId: GenericString;
  598. /**
  599. * A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group. DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.
  600. */
  601. DestinationAddresses?: DestinationAddresses;
  602. /**
  603. * A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
  604. */
  605. DestinationPorts?: DestinationPorts;
  606. /**
  607. * Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE. When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE. When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group. The default value is FALSE.
  608. */
  609. AllowAllTrafficToEndpoint?: GenericBoolean;
  610. }
  611. export interface Attachment {
  612. /**
  613. * The Amazon Resource Name (ARN) of the cross-account attachment.
  614. */
  615. AttachmentArn?: GenericString;
  616. /**
  617. * The name of the cross-account attachment.
  618. */
  619. Name?: AttachmentName;
  620. /**
  621. * The principals included in the cross-account attachment.
  622. */
  623. Principals?: Principals;
  624. /**
  625. * The resources included in the cross-account attachment.
  626. */
  627. Resources?: Resources;
  628. /**
  629. * The date and time that the cross-account attachment was last modified.
  630. */
  631. LastModifiedTime?: Timestamp;
  632. /**
  633. * The date and time that the cross-account attachment was created.
  634. */
  635. CreatedTime?: Timestamp;
  636. }
  637. export type AttachmentName = string;
  638. export type Attachments = Attachment[];
  639. export type AwsAccountId = string;
  640. export type AwsAccountIds = AwsAccountId[];
  641. export interface ByoipCidr {
  642. /**
  643. * The address range, in CIDR notation. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  644. */
  645. Cidr?: GenericString;
  646. /**
  647. * The state of the address pool.
  648. */
  649. State?: ByoipCidrState;
  650. /**
  651. * A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
  652. */
  653. Events?: ByoipCidrEvents;
  654. }
  655. export interface ByoipCidrEvent {
  656. /**
  657. * A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
  658. */
  659. Message?: GenericString;
  660. /**
  661. * A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
  662. */
  663. Timestamp?: Timestamp;
  664. }
  665. export type ByoipCidrEvents = ByoipCidrEvent[];
  666. export type ByoipCidrState = "PENDING_PROVISIONING"|"READY"|"PENDING_ADVERTISING"|"ADVERTISING"|"PENDING_WITHDRAWING"|"PENDING_DEPROVISIONING"|"DEPROVISIONED"|"FAILED_PROVISION"|"FAILED_ADVERTISING"|"FAILED_WITHDRAW"|"FAILED_DEPROVISION"|string;
  667. export type ByoipCidrs = ByoipCidr[];
  668. export interface CidrAuthorizationContext {
  669. /**
  670. * The plain-text authorization message for the prefix and account.
  671. */
  672. Message: GenericString;
  673. /**
  674. * The signed authorization message for the prefix and account.
  675. */
  676. Signature: GenericString;
  677. }
  678. export type ClientAffinity = "NONE"|"SOURCE_IP"|string;
  679. export interface CreateAcceleratorRequest {
  680. /**
  681. * The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
  682. */
  683. Name: GenericString;
  684. /**
  685. * The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
  686. */
  687. IpAddressType?: IpAddressType;
  688. /**
  689. * Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability. You can specify one or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  690. */
  691. IpAddresses?: IpAddresses;
  692. /**
  693. * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
  694. */
  695. Enabled?: GenericBoolean;
  696. /**
  697. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
  698. */
  699. IdempotencyToken: IdempotencyToken;
  700. /**
  701. * Create tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  702. */
  703. Tags?: Tags;
  704. }
  705. export interface CreateAcceleratorResponse {
  706. /**
  707. * The accelerator that is created by specifying a listener and the supported IP address types.
  708. */
  709. Accelerator?: Accelerator;
  710. }
  711. export interface CreateCrossAccountAttachmentRequest {
  712. /**
  713. * The name of the cross-account attachment.
  714. */
  715. Name: AttachmentName;
  716. /**
  717. * The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.
  718. */
  719. Principals?: Principals;
  720. /**
  721. * The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool.
  722. */
  723. Resources?: Resources;
  724. /**
  725. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  726. */
  727. IdempotencyToken: IdempotencyToken;
  728. /**
  729. * Add tags for a cross-account attachment. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  730. */
  731. Tags?: Tags;
  732. }
  733. export interface CreateCrossAccountAttachmentResponse {
  734. /**
  735. * Information about the cross-account attachment.
  736. */
  737. CrossAccountAttachment?: Attachment;
  738. }
  739. export interface CreateCustomRoutingAcceleratorRequest {
  740. /**
  741. * The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
  742. */
  743. Name: GenericString;
  744. /**
  745. * The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
  746. */
  747. IpAddressType?: IpAddressType;
  748. /**
  749. * Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability. You can specify one or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  750. */
  751. IpAddresses?: IpAddresses;
  752. /**
  753. * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
  754. */
  755. Enabled?: GenericBoolean;
  756. /**
  757. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  758. */
  759. IdempotencyToken: IdempotencyToken;
  760. /**
  761. * Create tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
  762. */
  763. Tags?: Tags;
  764. }
  765. export interface CreateCustomRoutingAcceleratorResponse {
  766. /**
  767. * The accelerator that is created.
  768. */
  769. Accelerator?: CustomRoutingAccelerator;
  770. }
  771. export interface CreateCustomRoutingEndpointGroupRequest {
  772. /**
  773. * The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
  774. */
  775. ListenerArn: GenericString;
  776. /**
  777. * The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
  778. */
  779. EndpointGroupRegion: GenericString;
  780. /**
  781. * Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
  782. */
  783. DestinationConfigurations: CustomRoutingDestinationConfigurations;
  784. /**
  785. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  786. */
  787. IdempotencyToken: IdempotencyToken;
  788. }
  789. export interface CreateCustomRoutingEndpointGroupResponse {
  790. /**
  791. * The information about the endpoint group created for a custom routing accelerator.
  792. */
  793. EndpointGroup?: CustomRoutingEndpointGroup;
  794. }
  795. export interface CreateCustomRoutingListenerRequest {
  796. /**
  797. * The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
  798. */
  799. AcceleratorArn: GenericString;
  800. /**
  801. * The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
  802. */
  803. PortRanges: PortRanges;
  804. /**
  805. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  806. */
  807. IdempotencyToken: IdempotencyToken;
  808. }
  809. export interface CreateCustomRoutingListenerResponse {
  810. /**
  811. * The listener that you've created for a custom routing accelerator.
  812. */
  813. Listener?: CustomRoutingListener;
  814. }
  815. export interface CreateEndpointGroupRequest {
  816. /**
  817. * The Amazon Resource Name (ARN) of the listener.
  818. */
  819. ListenerArn: GenericString;
  820. /**
  821. * The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
  822. */
  823. EndpointGroupRegion: GenericString;
  824. /**
  825. * The list of endpoint objects.
  826. */
  827. EndpointConfigurations?: EndpointConfigurations;
  828. /**
  829. * The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100.
  830. */
  831. TrafficDialPercentage?: TrafficDialPercentage;
  832. /**
  833. * The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
  834. */
  835. HealthCheckPort?: HealthCheckPort;
  836. /**
  837. * The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
  838. */
  839. HealthCheckProtocol?: HealthCheckProtocol;
  840. /**
  841. * If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
  842. */
  843. HealthCheckPath?: HealthCheckPath;
  844. /**
  845. * The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
  846. */
  847. HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
  848. /**
  849. * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
  850. */
  851. ThresholdCount?: ThresholdCount;
  852. /**
  853. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  854. */
  855. IdempotencyToken: IdempotencyToken;
  856. /**
  857. * Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
  858. */
  859. PortOverrides?: PortOverrides;
  860. }
  861. export interface CreateEndpointGroupResponse {
  862. /**
  863. * The information about the endpoint group that was created.
  864. */
  865. EndpointGroup?: EndpointGroup;
  866. }
  867. export interface CreateListenerRequest {
  868. /**
  869. * The Amazon Resource Name (ARN) of your accelerator.
  870. */
  871. AcceleratorArn: GenericString;
  872. /**
  873. * The list of port ranges to support for connections from clients to your accelerator.
  874. */
  875. PortRanges: PortRanges;
  876. /**
  877. * The protocol for connections from clients to your accelerator.
  878. */
  879. Protocol: Protocol;
  880. /**
  881. * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE.
  882. */
  883. ClientAffinity?: ClientAffinity;
  884. /**
  885. * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  886. */
  887. IdempotencyToken: IdempotencyToken;
  888. }
  889. export interface CreateListenerResponse {
  890. /**
  891. * The listener that you've created.
  892. */
  893. Listener?: Listener;
  894. }
  895. export interface CrossAccountResource {
  896. /**
  897. * The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.
  898. */
  899. EndpointId?: GenericString;
  900. /**
  901. * An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  902. */
  903. Cidr?: GenericString;
  904. /**
  905. * The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.
  906. */
  907. AttachmentArn?: GenericString;
  908. }
  909. export type CrossAccountResources = CrossAccountResource[];
  910. export interface CustomRoutingAccelerator {
  911. /**
  912. * The Amazon Resource Name (ARN) of the custom routing accelerator.
  913. */
  914. AcceleratorArn?: GenericString;
  915. /**
  916. * The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
  917. */
  918. Name?: GenericString;
  919. /**
  920. * The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
  921. */
  922. IpAddressType?: IpAddressType;
  923. /**
  924. * Indicates whether the accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
  925. */
  926. Enabled?: GenericBoolean;
  927. /**
  928. * The static IP addresses that Global Accelerator associates with the accelerator.
  929. */
  930. IpSets?: IpSets;
  931. /**
  932. * The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses. For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
  933. */
  934. DnsName?: GenericString;
  935. /**
  936. * Describes the deployment status of the accelerator.
  937. */
  938. Status?: CustomRoutingAcceleratorStatus;
  939. /**
  940. * The date and time that the accelerator was created.
  941. */
  942. CreatedTime?: Timestamp;
  943. /**
  944. * The date and time that the accelerator was last modified.
  945. */
  946. LastModifiedTime?: Timestamp;
  947. }
  948. export interface CustomRoutingAcceleratorAttributes {
  949. /**
  950. * Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow logs in the Global Accelerator Developer Guide.
  951. */
  952. FlowLogsEnabled?: GenericBoolean;
  953. /**
  954. * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.
  955. */
  956. FlowLogsS3Bucket?: GenericString;
  957. /**
  958. * The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
  959. */
  960. FlowLogsS3Prefix?: GenericString;
  961. }
  962. export type CustomRoutingAcceleratorStatus = "DEPLOYED"|"IN_PROGRESS"|string;
  963. export type CustomRoutingAccelerators = CustomRoutingAccelerator[];
  964. export interface CustomRoutingDestinationConfiguration {
  965. /**
  966. * The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
  967. */
  968. FromPort: PortNumber;
  969. /**
  970. * The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
  971. */
  972. ToPort: PortNumber;
  973. /**
  974. * The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
  975. */
  976. Protocols: CustomRoutingProtocols;
  977. }
  978. export type CustomRoutingDestinationConfigurations = CustomRoutingDestinationConfiguration[];
  979. export interface CustomRoutingDestinationDescription {
  980. /**
  981. * The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
  982. */
  983. FromPort?: PortNumber;
  984. /**
  985. * The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
  986. */
  987. ToPort?: PortNumber;
  988. /**
  989. * The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
  990. */
  991. Protocols?: Protocols;
  992. }
  993. export type CustomRoutingDestinationDescriptions = CustomRoutingDestinationDescription[];
  994. export type CustomRoutingDestinationTrafficState = "ALLOW"|"DENY"|string;
  995. export interface CustomRoutingEndpointConfiguration {
  996. /**
  997. * An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
  998. */
  999. EndpointId?: GenericString;
  1000. /**
  1001. * The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
  1002. */
  1003. AttachmentArn?: GenericString;
  1004. }
  1005. export type CustomRoutingEndpointConfigurations = CustomRoutingEndpointConfiguration[];
  1006. export interface CustomRoutingEndpointDescription {
  1007. /**
  1008. * An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
  1009. */
  1010. EndpointId?: GenericString;
  1011. }
  1012. export type CustomRoutingEndpointDescriptions = CustomRoutingEndpointDescription[];
  1013. export interface CustomRoutingEndpointGroup {
  1014. /**
  1015. * The Amazon Resource Name (ARN) of the endpoint group.
  1016. */
  1017. EndpointGroupArn?: GenericString;
  1018. /**
  1019. * The Amazon Web Services Region where the endpoint group is located.
  1020. */
  1021. EndpointGroupRegion?: GenericString;
  1022. /**
  1023. * For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
  1024. */
  1025. DestinationDescriptions?: CustomRoutingDestinationDescriptions;
  1026. /**
  1027. * For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
  1028. */
  1029. EndpointDescriptions?: CustomRoutingEndpointDescriptions;
  1030. }
  1031. export type CustomRoutingEndpointGroups = CustomRoutingEndpointGroup[];
  1032. export interface CustomRoutingListener {
  1033. /**
  1034. * The Amazon Resource Name (ARN) of the listener.
  1035. */
  1036. ListenerArn?: GenericString;
  1037. /**
  1038. * The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
  1039. */
  1040. PortRanges?: PortRanges;
  1041. }
  1042. export type CustomRoutingListeners = CustomRoutingListener[];
  1043. export type CustomRoutingProtocol = "TCP"|"UDP"|string;
  1044. export type CustomRoutingProtocols = CustomRoutingProtocol[];
  1045. export interface DeleteAcceleratorRequest {
  1046. /**
  1047. * The Amazon Resource Name (ARN) of an accelerator.
  1048. */
  1049. AcceleratorArn: GenericString;
  1050. }
  1051. export interface DeleteCrossAccountAttachmentRequest {
  1052. /**
  1053. * The Amazon Resource Name (ARN) for the cross-account attachment to delete.
  1054. */
  1055. AttachmentArn: GenericString;
  1056. }
  1057. export interface DeleteCustomRoutingAcceleratorRequest {
  1058. /**
  1059. * The Amazon Resource Name (ARN) of the custom routing accelerator to delete.
  1060. */
  1061. AcceleratorArn: GenericString;
  1062. }
  1063. export interface DeleteCustomRoutingEndpointGroupRequest {
  1064. /**
  1065. * The Amazon Resource Name (ARN) of the endpoint group to delete.
  1066. */
  1067. EndpointGroupArn: GenericString;
  1068. }
  1069. export interface DeleteCustomRoutingListenerRequest {
  1070. /**
  1071. * The Amazon Resource Name (ARN) of the listener to delete.
  1072. */
  1073. ListenerArn: GenericString;
  1074. }
  1075. export interface DeleteEndpointGroupRequest {
  1076. /**
  1077. * The Amazon Resource Name (ARN) of the endpoint group to delete.
  1078. */
  1079. EndpointGroupArn: GenericString;
  1080. }
  1081. export interface DeleteListenerRequest {
  1082. /**
  1083. * The Amazon Resource Name (ARN) of the listener.
  1084. */
  1085. ListenerArn: GenericString;
  1086. }
  1087. export interface DenyCustomRoutingTrafficRequest {
  1088. /**
  1089. * The Amazon Resource Name (ARN) of the endpoint group.
  1090. */
  1091. EndpointGroupArn: GenericString;
  1092. /**
  1093. * An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
  1094. */
  1095. EndpointId: GenericString;
  1096. /**
  1097. * A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.
  1098. */
  1099. DestinationAddresses?: DestinationAddresses;
  1100. /**
  1101. * A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.
  1102. */
  1103. DestinationPorts?: DestinationPorts;
  1104. /**
  1105. * Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE. When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE. When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group. The default value is FALSE.
  1106. */
  1107. DenyAllTrafficToEndpoint?: GenericBoolean;
  1108. }
  1109. export interface DeprovisionByoipCidrRequest {
  1110. /**
  1111. * The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  1112. */
  1113. Cidr: GenericString;
  1114. }
  1115. export interface DeprovisionByoipCidrResponse {
  1116. /**
  1117. * Information about the address range.
  1118. */
  1119. ByoipCidr?: ByoipCidr;
  1120. }
  1121. export interface DescribeAcceleratorAttributesRequest {
  1122. /**
  1123. * The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
  1124. */
  1125. AcceleratorArn: GenericString;
  1126. }
  1127. export interface DescribeAcceleratorAttributesResponse {
  1128. /**
  1129. * The attributes of the accelerator.
  1130. */
  1131. AcceleratorAttributes?: AcceleratorAttributes;
  1132. }
  1133. export interface DescribeAcceleratorRequest {
  1134. /**
  1135. * The Amazon Resource Name (ARN) of the accelerator to describe.
  1136. */
  1137. AcceleratorArn: GenericString;
  1138. }
  1139. export interface DescribeAcceleratorResponse {
  1140. /**
  1141. * The description of the accelerator.
  1142. */
  1143. Accelerator?: Accelerator;
  1144. }
  1145. export interface DescribeCrossAccountAttachmentRequest {
  1146. /**
  1147. * The Amazon Resource Name (ARN) for the cross-account attachment to describe.
  1148. */
  1149. AttachmentArn: GenericString;
  1150. }
  1151. export interface DescribeCrossAccountAttachmentResponse {
  1152. /**
  1153. * Information about the cross-account attachment.
  1154. */
  1155. CrossAccountAttachment?: Attachment;
  1156. }
  1157. export interface DescribeCustomRoutingAcceleratorAttributesRequest {
  1158. /**
  1159. * The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.
  1160. */
  1161. AcceleratorArn: GenericString;
  1162. }
  1163. export interface DescribeCustomRoutingAcceleratorAttributesResponse {
  1164. /**
  1165. * The attributes of the custom routing accelerator.
  1166. */
  1167. AcceleratorAttributes?: CustomRoutingAcceleratorAttributes;
  1168. }
  1169. export interface DescribeCustomRoutingAcceleratorRequest {
  1170. /**
  1171. * The Amazon Resource Name (ARN) of the accelerator to describe.
  1172. */
  1173. AcceleratorArn: GenericString;
  1174. }
  1175. export interface DescribeCustomRoutingAcceleratorResponse {
  1176. /**
  1177. * The description of the custom routing accelerator.
  1178. */
  1179. Accelerator?: CustomRoutingAccelerator;
  1180. }
  1181. export interface DescribeCustomRoutingEndpointGroupRequest {
  1182. /**
  1183. * The Amazon Resource Name (ARN) of the endpoint group to describe.
  1184. */
  1185. EndpointGroupArn: GenericString;
  1186. }
  1187. export interface DescribeCustomRoutingEndpointGroupResponse {
  1188. /**
  1189. * The description of an endpoint group for a custom routing accelerator.
  1190. */
  1191. EndpointGroup?: CustomRoutingEndpointGroup;
  1192. }
  1193. export interface DescribeCustomRoutingListenerRequest {
  1194. /**
  1195. * The Amazon Resource Name (ARN) of the listener to describe.
  1196. */
  1197. ListenerArn: GenericString;
  1198. }
  1199. export interface DescribeCustomRoutingListenerResponse {
  1200. /**
  1201. * The description of a listener for a custom routing accelerator.
  1202. */
  1203. Listener?: CustomRoutingListener;
  1204. }
  1205. export interface DescribeEndpointGroupRequest {
  1206. /**
  1207. * The Amazon Resource Name (ARN) of the endpoint group to describe.
  1208. */
  1209. EndpointGroupArn: GenericString;
  1210. }
  1211. export interface DescribeEndpointGroupResponse {
  1212. /**
  1213. * The description of an endpoint group.
  1214. */
  1215. EndpointGroup?: EndpointGroup;
  1216. }
  1217. export interface DescribeListenerRequest {
  1218. /**
  1219. * The Amazon Resource Name (ARN) of the listener to describe.
  1220. */
  1221. ListenerArn: GenericString;
  1222. }
  1223. export interface DescribeListenerResponse {
  1224. /**
  1225. * The description of a listener.
  1226. */
  1227. Listener?: Listener;
  1228. }
  1229. export type DestinationAddresses = IpAddress[];
  1230. export interface DestinationPortMapping {
  1231. /**
  1232. * The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
  1233. */
  1234. AcceleratorArn?: GenericString;
  1235. /**
  1236. * The IP address/port combinations (sockets) that map to a given destination socket address.
  1237. */
  1238. AcceleratorSocketAddresses?: SocketAddresses;
  1239. /**
  1240. * The Amazon Resource Name (ARN) of the endpoint group.
  1241. */
  1242. EndpointGroupArn?: GenericString;
  1243. /**
  1244. * The ID for the virtual private cloud (VPC) subnet.
  1245. */
  1246. EndpointId?: GenericString;
  1247. /**
  1248. * The Amazon Web Services Region for the endpoint group.
  1249. */
  1250. EndpointGroupRegion?: GenericString;
  1251. /**
  1252. * The endpoint IP address/port combination for traffic received on the accelerator socket address.
  1253. */
  1254. DestinationSocketAddress?: SocketAddress;
  1255. /**
  1256. * The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
  1257. */
  1258. IpAddressType?: IpAddressType;
  1259. /**
  1260. * Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
  1261. */
  1262. DestinationTrafficState?: CustomRoutingDestinationTrafficState;
  1263. }
  1264. export type DestinationPortMappings = DestinationPortMapping[];
  1265. export type DestinationPorts = PortNumber[];
  1266. export interface EndpointConfiguration {
  1267. /**
  1268. * An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint. For cross-account endpoints, this must be the ARN of the resource.
  1269. */
  1270. EndpointId?: GenericString;
  1271. /**
  1272. * The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide.
  1273. */
  1274. Weight?: EndpointWeight;
  1275. /**
  1276. * Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints. If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator. Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners. For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
  1277. */
  1278. ClientIPPreservationEnabled?: GenericBoolean;
  1279. /**
  1280. * The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
  1281. */
  1282. AttachmentArn?: GenericString;
  1283. }
  1284. export type EndpointConfigurations = EndpointConfiguration[];
  1285. export interface EndpointDescription {
  1286. /**
  1287. * An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. An Application Load Balancer can be either internal or internet-facing.
  1288. */
  1289. EndpointId?: GenericString;
  1290. /**
  1291. * The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide.
  1292. */
  1293. Weight?: EndpointWeight;
  1294. /**
  1295. * The health status of the endpoint.
  1296. */
  1297. HealthState?: HealthState;
  1298. /**
  1299. * Returns a null result.
  1300. */
  1301. HealthReason?: GenericString;
  1302. /**
  1303. * Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints. If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator. Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners. For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
  1304. */
  1305. ClientIPPreservationEnabled?: GenericBoolean;
  1306. }
  1307. export type EndpointDescriptions = EndpointDescription[];
  1308. export interface EndpointGroup {
  1309. /**
  1310. * The Amazon Resource Name (ARN) of the endpoint group.
  1311. */
  1312. EndpointGroupArn?: GenericString;
  1313. /**
  1314. * The Amazon Web Services Region where the endpoint group is located.
  1315. */
  1316. EndpointGroupRegion?: GenericString;
  1317. /**
  1318. * The list of endpoint objects.
  1319. */
  1320. EndpointDescriptions?: EndpointDescriptions;
  1321. /**
  1322. * The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100.
  1323. */
  1324. TrafficDialPercentage?: TrafficDialPercentage;
  1325. /**
  1326. * The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
  1327. */
  1328. HealthCheckPort?: HealthCheckPort;
  1329. /**
  1330. * The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
  1331. */
  1332. HealthCheckProtocol?: HealthCheckProtocol;
  1333. /**
  1334. * If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
  1335. */
  1336. HealthCheckPath?: HealthCheckPath;
  1337. /**
  1338. * The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
  1339. */
  1340. HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
  1341. /**
  1342. * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
  1343. */
  1344. ThresholdCount?: ThresholdCount;
  1345. /**
  1346. * Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
  1347. */
  1348. PortOverrides?: PortOverrides;
  1349. }
  1350. export type EndpointGroups = EndpointGroup[];
  1351. export interface EndpointIdentifier {
  1352. /**
  1353. * An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. An Application Load Balancer can be either internal or internet-facing.
  1354. */
  1355. EndpointId: GenericString;
  1356. /**
  1357. * Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.
  1358. */
  1359. ClientIPPreservationEnabled?: GenericBoolean;
  1360. }
  1361. export type EndpointIdentifiers = EndpointIdentifier[];
  1362. export type EndpointIds = GenericString[];
  1363. export type EndpointWeight = number;
  1364. export type GenericBoolean = boolean;
  1365. export type GenericString = string;
  1366. export type HealthCheckIntervalSeconds = number;
  1367. export type HealthCheckPath = string;
  1368. export type HealthCheckPort = number;
  1369. export type HealthCheckProtocol = "TCP"|"HTTP"|"HTTPS"|string;
  1370. export type HealthState = "INITIAL"|"HEALTHY"|"UNHEALTHY"|string;
  1371. export type IdempotencyToken = string;
  1372. export type IpAddress = string;
  1373. export type IpAddressFamily = "IPv4"|"IPv6"|string;
  1374. export type IpAddressType = "IPV4"|"DUAL_STACK"|string;
  1375. export type IpAddresses = IpAddress[];
  1376. export interface IpSet {
  1377. /**
  1378. * IpFamily is deprecated and has been replaced by IpAddressFamily.
  1379. */
  1380. IpFamily?: GenericString;
  1381. /**
  1382. * The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
  1383. */
  1384. IpAddresses?: IpAddresses;
  1385. /**
  1386. * The types of IP addresses included in this IP set.
  1387. */
  1388. IpAddressFamily?: IpAddressFamily;
  1389. }
  1390. export type IpSets = IpSet[];
  1391. export interface ListAcceleratorsRequest {
  1392. /**
  1393. * The number of Global Accelerator objects that you want to return with this call. The default value is 10.
  1394. */
  1395. MaxResults?: MaxResults;
  1396. /**
  1397. * The token for the next set of results. You receive this token from a previous call.
  1398. */
  1399. NextToken?: GenericString;
  1400. }
  1401. export interface ListAcceleratorsResponse {
  1402. /**
  1403. * The list of accelerators for a customer account.
  1404. */
  1405. Accelerators?: Accelerators;
  1406. /**
  1407. * The token for the next set of results. You receive this token from a previous call.
  1408. */
  1409. NextToken?: GenericString;
  1410. }
  1411. export interface ListByoipCidrsRequest {
  1412. /**
  1413. * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  1414. */
  1415. MaxResults?: MaxResults;
  1416. /**
  1417. * The token for the next page of results.
  1418. */
  1419. NextToken?: GenericString;
  1420. }
  1421. export interface ListByoipCidrsResponse {
  1422. /**
  1423. * Information about your address ranges.
  1424. */
  1425. ByoipCidrs?: ByoipCidrs;
  1426. /**
  1427. * The token for the next page of results.
  1428. */
  1429. NextToken?: GenericString;
  1430. }
  1431. export interface ListCrossAccountAttachmentsRequest {
  1432. /**
  1433. * The number of cross-account attachment objects that you want to return with this call. The default value is 10.
  1434. */
  1435. MaxResults?: MaxResults;
  1436. /**
  1437. * The token for the next set of results. You receive this token from a previous call.
  1438. */
  1439. NextToken?: GenericString;
  1440. }
  1441. export interface ListCrossAccountAttachmentsResponse {
  1442. /**
  1443. * Information about the cross-account attachments.
  1444. */
  1445. CrossAccountAttachments?: Attachments;
  1446. /**
  1447. * The token for the next set of results. You receive this token from a previous call.
  1448. */
  1449. NextToken?: GenericString;
  1450. }
  1451. export interface ListCrossAccountResourceAccountsRequest {
  1452. }
  1453. export interface ListCrossAccountResourceAccountsResponse {
  1454. /**
  1455. * The account IDs of principals (resource owners) in a cross-account attachment who can work with resources listed in the same attachment.
  1456. */
  1457. ResourceOwnerAwsAccountIds?: AwsAccountIds;
  1458. }
  1459. export interface ListCrossAccountResourcesRequest {
  1460. /**
  1461. * The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
  1462. */
  1463. AcceleratorArn?: GenericString;
  1464. /**
  1465. * The account ID of a resource owner in a cross-account attachment.
  1466. */
  1467. ResourceOwnerAwsAccountId: AwsAccountId;
  1468. /**
  1469. * The number of cross-account resource objects that you want to return with this call. The default value is 10.
  1470. */
  1471. MaxResults?: MaxResults;
  1472. /**
  1473. * The token for the next set of results. You receive this token from a previous call.
  1474. */
  1475. NextToken?: GenericString;
  1476. }
  1477. export interface ListCrossAccountResourcesResponse {
  1478. /**
  1479. * The cross-account resources used with an accelerator.
  1480. */
  1481. CrossAccountResources?: CrossAccountResources;
  1482. /**
  1483. * The token for the next set of results. You receive this token from a previous call.
  1484. */
  1485. NextToken?: GenericString;
  1486. }
  1487. export interface ListCustomRoutingAcceleratorsRequest {
  1488. /**
  1489. * The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
  1490. */
  1491. MaxResults?: MaxResults;
  1492. /**
  1493. * The token for the next set of results. You receive this token from a previous call.
  1494. */
  1495. NextToken?: GenericString;
  1496. }
  1497. export interface ListCustomRoutingAcceleratorsResponse {
  1498. /**
  1499. * The list of custom routing accelerators for a customer account.
  1500. */
  1501. Accelerators?: CustomRoutingAccelerators;
  1502. /**
  1503. * The token for the next set of results. You receive this token from a previous call.
  1504. */
  1505. NextToken?: GenericString;
  1506. }
  1507. export interface ListCustomRoutingEndpointGroupsRequest {
  1508. /**
  1509. * The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
  1510. */
  1511. ListenerArn: GenericString;
  1512. /**
  1513. * The number of endpoint group objects that you want to return with this call. The default value is 10.
  1514. */
  1515. MaxResults?: MaxResults;
  1516. /**
  1517. * The token for the next set of results. You receive this token from a previous call.
  1518. */
  1519. NextToken?: GenericString;
  1520. }
  1521. export interface ListCustomRoutingEndpointGroupsResponse {
  1522. /**
  1523. * The list of the endpoint groups associated with a listener for a custom routing accelerator.
  1524. */
  1525. EndpointGroups?: CustomRoutingEndpointGroups;
  1526. /**
  1527. * The token for the next set of results. You receive this token from a previous call.
  1528. */
  1529. NextToken?: GenericString;
  1530. }
  1531. export interface ListCustomRoutingListenersRequest {
  1532. /**
  1533. * The Amazon Resource Name (ARN) of the accelerator to list listeners for.
  1534. */
  1535. AcceleratorArn: GenericString;
  1536. /**
  1537. * The number of listener objects that you want to return with this call. The default value is 10.
  1538. */
  1539. MaxResults?: MaxResults;
  1540. /**
  1541. * The token for the next set of results. You receive this token from a previous call.
  1542. */
  1543. NextToken?: GenericString;
  1544. }
  1545. export interface ListCustomRoutingListenersResponse {
  1546. /**
  1547. * The list of listeners for a custom routing accelerator.
  1548. */
  1549. Listeners?: CustomRoutingListeners;
  1550. /**
  1551. * The token for the next set of results. You receive this token from a previous call.
  1552. */
  1553. NextToken?: GenericString;
  1554. }
  1555. export interface ListCustomRoutingPortMappingsByDestinationRequest {
  1556. /**
  1557. * The ID for the virtual private cloud (VPC) subnet.
  1558. */
  1559. EndpointId: GenericString;
  1560. /**
  1561. * The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
  1562. */
  1563. DestinationAddress: GenericString;
  1564. /**
  1565. * The number of destination port mappings that you want to return with this call. The default value is 10.
  1566. */
  1567. MaxResults?: PortMappingsMaxResults;
  1568. /**
  1569. * The token for the next set of results. You receive this token from a previous call.
  1570. */
  1571. NextToken?: GenericString;
  1572. }
  1573. export interface ListCustomRoutingPortMappingsByDestinationResponse {
  1574. /**
  1575. * The port mappings for the endpoint IP address that you specified in the request.
  1576. */
  1577. DestinationPortMappings?: DestinationPortMappings;
  1578. /**
  1579. * The token for the next set of results. You receive this token from a previous call.
  1580. */
  1581. NextToken?: GenericString;
  1582. }
  1583. export interface ListCustomRoutingPortMappingsRequest {
  1584. /**
  1585. * The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
  1586. */
  1587. AcceleratorArn: GenericString;
  1588. /**
  1589. * The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
  1590. */
  1591. EndpointGroupArn?: GenericString;
  1592. /**
  1593. * The number of destination port mappings that you want to return with this call. The default value is 10.
  1594. */
  1595. MaxResults?: PortMappingsMaxResults;
  1596. /**
  1597. * The token for the next set of results. You receive this token from a previous call.
  1598. */
  1599. NextToken?: GenericString;
  1600. }
  1601. export interface ListCustomRoutingPortMappingsResponse {
  1602. /**
  1603. * The port mappings for a custom routing accelerator.
  1604. */
  1605. PortMappings?: PortMappings;
  1606. /**
  1607. * The token for the next set of results. You receive this token from a previous call.
  1608. */
  1609. NextToken?: GenericString;
  1610. }
  1611. export interface ListEndpointGroupsRequest {
  1612. /**
  1613. * The Amazon Resource Name (ARN) of the listener.
  1614. */
  1615. ListenerArn: GenericString;
  1616. /**
  1617. * The number of endpoint group objects that you want to return with this call. The default value is 10.
  1618. */
  1619. MaxResults?: MaxResults;
  1620. /**
  1621. * The token for the next set of results. You receive this token from a previous call.
  1622. */
  1623. NextToken?: GenericString;
  1624. }
  1625. export interface ListEndpointGroupsResponse {
  1626. /**
  1627. * The list of the endpoint groups associated with a listener.
  1628. */
  1629. EndpointGroups?: EndpointGroups;
  1630. /**
  1631. * The token for the next set of results. You receive this token from a previous call.
  1632. */
  1633. NextToken?: GenericString;
  1634. }
  1635. export interface ListListenersRequest {
  1636. /**
  1637. * The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
  1638. */
  1639. AcceleratorArn: GenericString;
  1640. /**
  1641. * The number of listener objects that you want to return with this call. The default value is 10.
  1642. */
  1643. MaxResults?: MaxResults;
  1644. /**
  1645. * The token for the next set of results. You receive this token from a previous call.
  1646. */
  1647. NextToken?: GenericString;
  1648. }
  1649. export interface ListListenersResponse {
  1650. /**
  1651. * The list of listeners for an accelerator.
  1652. */
  1653. Listeners?: Listeners;
  1654. /**
  1655. * The token for the next set of results. You receive this token from a previous call.
  1656. */
  1657. NextToken?: GenericString;
  1658. }
  1659. export interface ListTagsForResourceRequest {
  1660. /**
  1661. * The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
  1662. */
  1663. ResourceArn: ResourceArn;
  1664. }
  1665. export interface ListTagsForResourceResponse {
  1666. /**
  1667. * Root level tag for the Tags parameters.
  1668. */
  1669. Tags?: Tags;
  1670. }
  1671. export interface Listener {
  1672. /**
  1673. * The Amazon Resource Name (ARN) of the listener.
  1674. */
  1675. ListenerArn?: GenericString;
  1676. /**
  1677. * The list of port ranges for the connections from clients to the accelerator.
  1678. */
  1679. PortRanges?: PortRanges;
  1680. /**
  1681. * The protocol for the connections from clients to the accelerator.
  1682. */
  1683. Protocol?: Protocol;
  1684. /**
  1685. * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE.
  1686. */
  1687. ClientAffinity?: ClientAffinity;
  1688. }
  1689. export type Listeners = Listener[];
  1690. export type MaxResults = number;
  1691. export interface PortMapping {
  1692. /**
  1693. * The accelerator port.
  1694. */
  1695. AcceleratorPort?: PortNumber;
  1696. /**
  1697. * The Amazon Resource Name (ARN) of the endpoint group.
  1698. */
  1699. EndpointGroupArn?: GenericString;
  1700. /**
  1701. * The IP address of the VPC subnet (the subnet ID).
  1702. */
  1703. EndpointId?: GenericString;
  1704. /**
  1705. * The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
  1706. */
  1707. DestinationSocketAddress?: SocketAddress;
  1708. /**
  1709. * The protocols supported by the endpoint group.
  1710. */
  1711. Protocols?: CustomRoutingProtocols;
  1712. /**
  1713. * Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
  1714. */
  1715. DestinationTrafficState?: CustomRoutingDestinationTrafficState;
  1716. }
  1717. export type PortMappings = PortMapping[];
  1718. export type PortMappingsMaxResults = number;
  1719. export type PortNumber = number;
  1720. export interface PortOverride {
  1721. /**
  1722. * The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
  1723. */
  1724. ListenerPort?: PortNumber;
  1725. /**
  1726. * The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
  1727. */
  1728. EndpointPort?: PortNumber;
  1729. }
  1730. export type PortOverrides = PortOverride[];
  1731. export interface PortRange {
  1732. /**
  1733. * The first port in the range of ports, inclusive.
  1734. */
  1735. FromPort?: PortNumber;
  1736. /**
  1737. * The last port in the range of ports, inclusive.
  1738. */
  1739. ToPort?: PortNumber;
  1740. }
  1741. export type PortRanges = PortRange[];
  1742. export type Principal = string;
  1743. export type Principals = Principal[];
  1744. export type Protocol = "TCP"|"UDP"|string;
  1745. export type Protocols = Protocol[];
  1746. export interface ProvisionByoipCidrRequest {
  1747. /**
  1748. * The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  1749. */
  1750. Cidr: GenericString;
  1751. /**
  1752. * A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
  1753. */
  1754. CidrAuthorizationContext: CidrAuthorizationContext;
  1755. }
  1756. export interface ProvisionByoipCidrResponse {
  1757. /**
  1758. * Information about the address range.
  1759. */
  1760. ByoipCidr?: ByoipCidr;
  1761. }
  1762. export interface RemoveCustomRoutingEndpointsRequest {
  1763. /**
  1764. * The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.
  1765. */
  1766. EndpointIds: EndpointIds;
  1767. /**
  1768. * The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
  1769. */
  1770. EndpointGroupArn: GenericString;
  1771. }
  1772. export interface RemoveEndpointsRequest {
  1773. /**
  1774. * The identifiers of the endpoints that you want to remove.
  1775. */
  1776. EndpointIdentifiers: EndpointIdentifiers;
  1777. /**
  1778. * The Amazon Resource Name (ARN) of the endpoint group.
  1779. */
  1780. EndpointGroupArn: GenericString;
  1781. }
  1782. export interface Resource {
  1783. /**
  1784. * The endpoint ID for the endpoint that is specified as a Amazon Web Services resource. An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
  1785. */
  1786. EndpointId?: GenericString;
  1787. /**
  1788. * An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  1789. */
  1790. Cidr?: GenericString;
  1791. /**
  1792. * The Amazon Web Services Region where a shared endpoint resource is located.
  1793. */
  1794. Region?: GenericString;
  1795. }
  1796. export type ResourceArn = string;
  1797. export type Resources = Resource[];
  1798. export interface SocketAddress {
  1799. /**
  1800. * The IP address for the socket address.
  1801. */
  1802. IpAddress?: GenericString;
  1803. /**
  1804. * The port for the socket address.
  1805. */
  1806. Port?: PortNumber;
  1807. }
  1808. export type SocketAddresses = SocketAddress[];
  1809. export interface Tag {
  1810. /**
  1811. * A string that contains a Tag key.
  1812. */
  1813. Key: TagKey;
  1814. /**
  1815. * A string that contains a Tag value.
  1816. */
  1817. Value: TagValue;
  1818. }
  1819. export type TagKey = string;
  1820. export type TagKeys = TagKey[];
  1821. export interface TagResourceRequest {
  1822. /**
  1823. * The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.
  1824. */
  1825. ResourceArn: ResourceArn;
  1826. /**
  1827. * The tags to add to a resource. A tag consists of a key and a value that you define.
  1828. */
  1829. Tags: Tags;
  1830. }
  1831. export interface TagResourceResponse {
  1832. }
  1833. export type TagValue = string;
  1834. export type Tags = Tag[];
  1835. export type ThresholdCount = number;
  1836. export type Timestamp = Date;
  1837. export type TrafficDialPercentage = number;
  1838. export interface UntagResourceRequest {
  1839. /**
  1840. * The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.
  1841. */
  1842. ResourceArn: ResourceArn;
  1843. /**
  1844. * The tag key pairs that you want to remove from the specified resources.
  1845. */
  1846. TagKeys: TagKeys;
  1847. }
  1848. export interface UntagResourceResponse {
  1849. }
  1850. export interface UpdateAcceleratorAttributesRequest {
  1851. /**
  1852. * The Amazon Resource Name (ARN) of the accelerator that you want to update.
  1853. */
  1854. AcceleratorArn: GenericString;
  1855. /**
  1856. * Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow Logs in the Global Accelerator Developer Guide.
  1857. */
  1858. FlowLogsEnabled?: GenericBoolean;
  1859. /**
  1860. * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.
  1861. */
  1862. FlowLogsS3Bucket?: GenericString;
  1863. /**
  1864. * Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id
  1865. */
  1866. FlowLogsS3Prefix?: GenericString;
  1867. }
  1868. export interface UpdateAcceleratorAttributesResponse {
  1869. /**
  1870. * Updated attributes for the accelerator.
  1871. */
  1872. AcceleratorAttributes?: AcceleratorAttributes;
  1873. }
  1874. export interface UpdateAcceleratorRequest {
  1875. /**
  1876. * The Amazon Resource Name (ARN) of the accelerator to update.
  1877. */
  1878. AcceleratorArn: GenericString;
  1879. /**
  1880. * The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
  1881. */
  1882. Name?: GenericString;
  1883. /**
  1884. * The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
  1885. */
  1886. IpAddressType?: IpAddressType;
  1887. /**
  1888. * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
  1889. */
  1890. Enabled?: GenericBoolean;
  1891. }
  1892. export interface UpdateAcceleratorResponse {
  1893. /**
  1894. * Information about the updated accelerator.
  1895. */
  1896. Accelerator?: Accelerator;
  1897. }
  1898. export interface UpdateCrossAccountAttachmentRequest {
  1899. /**
  1900. * The Amazon Resource Name (ARN) of the cross-account attachment to update.
  1901. */
  1902. AttachmentArn: GenericString;
  1903. /**
  1904. * The name of the cross-account attachment.
  1905. */
  1906. Name?: AttachmentName;
  1907. /**
  1908. * The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
  1909. */
  1910. AddPrincipals?: Principals;
  1911. /**
  1912. * The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
  1913. */
  1914. RemovePrincipals?: Principals;
  1915. /**
  1916. * The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To add more than one resource, separate the resource ARNs with commas.
  1917. */
  1918. AddResources?: Resources;
  1919. /**
  1920. * The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To remove more than one resource, separate the resource ARNs with commas.
  1921. */
  1922. RemoveResources?: Resources;
  1923. }
  1924. export interface UpdateCrossAccountAttachmentResponse {
  1925. /**
  1926. * Information about the updated cross-account attachment.
  1927. */
  1928. CrossAccountAttachment?: Attachment;
  1929. }
  1930. export interface UpdateCustomRoutingAcceleratorAttributesRequest {
  1931. /**
  1932. * The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
  1933. */
  1934. AcceleratorArn: GenericString;
  1935. /**
  1936. * Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow logs in the Global Accelerator Developer Guide.
  1937. */
  1938. FlowLogsEnabled?: GenericBoolean;
  1939. /**
  1940. * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.
  1941. */
  1942. FlowLogsS3Bucket?: GenericString;
  1943. /**
  1944. * Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
  1945. */
  1946. FlowLogsS3Prefix?: GenericString;
  1947. }
  1948. export interface UpdateCustomRoutingAcceleratorAttributesResponse {
  1949. /**
  1950. * Updated custom routing accelerator.
  1951. */
  1952. AcceleratorAttributes?: CustomRoutingAcceleratorAttributes;
  1953. }
  1954. export interface UpdateCustomRoutingAcceleratorRequest {
  1955. /**
  1956. * The Amazon Resource Name (ARN) of the accelerator to update.
  1957. */
  1958. AcceleratorArn: GenericString;
  1959. /**
  1960. * The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
  1961. */
  1962. Name?: GenericString;
  1963. /**
  1964. * The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
  1965. */
  1966. IpAddressType?: IpAddressType;
  1967. /**
  1968. * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
  1969. */
  1970. Enabled?: GenericBoolean;
  1971. }
  1972. export interface UpdateCustomRoutingAcceleratorResponse {
  1973. /**
  1974. * Information about the updated custom routing accelerator.
  1975. */
  1976. Accelerator?: CustomRoutingAccelerator;
  1977. }
  1978. export interface UpdateCustomRoutingListenerRequest {
  1979. /**
  1980. * The Amazon Resource Name (ARN) of the listener to update.
  1981. */
  1982. ListenerArn: GenericString;
  1983. /**
  1984. * The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
  1985. */
  1986. PortRanges: PortRanges;
  1987. }
  1988. export interface UpdateCustomRoutingListenerResponse {
  1989. /**
  1990. * Information for the updated listener for a custom routing accelerator.
  1991. */
  1992. Listener?: CustomRoutingListener;
  1993. }
  1994. export interface UpdateEndpointGroupRequest {
  1995. /**
  1996. * The Amazon Resource Name (ARN) of the endpoint group.
  1997. */
  1998. EndpointGroupArn: GenericString;
  1999. /**
  2000. * The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
  2001. */
  2002. EndpointConfigurations?: EndpointConfigurations;
  2003. /**
  2004. * The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100.
  2005. */
  2006. TrafficDialPercentage?: TrafficDialPercentage;
  2007. /**
  2008. * The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
  2009. */
  2010. HealthCheckPort?: HealthCheckPort;
  2011. /**
  2012. * The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
  2013. */
  2014. HealthCheckProtocol?: HealthCheckProtocol;
  2015. /**
  2016. * If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
  2017. */
  2018. HealthCheckPath?: HealthCheckPath;
  2019. /**
  2020. * The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
  2021. */
  2022. HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
  2023. /**
  2024. * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
  2025. */
  2026. ThresholdCount?: ThresholdCount;
  2027. /**
  2028. * Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
  2029. */
  2030. PortOverrides?: PortOverrides;
  2031. }
  2032. export interface UpdateEndpointGroupResponse {
  2033. /**
  2034. * The information about the endpoint group that was updated.
  2035. */
  2036. EndpointGroup?: EndpointGroup;
  2037. }
  2038. export interface UpdateListenerRequest {
  2039. /**
  2040. * The Amazon Resource Name (ARN) of the listener to update.
  2041. */
  2042. ListenerArn: GenericString;
  2043. /**
  2044. * The updated list of port ranges for the connections from clients to the accelerator.
  2045. */
  2046. PortRanges?: PortRanges;
  2047. /**
  2048. * The updated protocol for the connections from clients to the accelerator.
  2049. */
  2050. Protocol?: Protocol;
  2051. /**
  2052. * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE.
  2053. */
  2054. ClientAffinity?: ClientAffinity;
  2055. }
  2056. export interface UpdateListenerResponse {
  2057. /**
  2058. * Information for the updated listener.
  2059. */
  2060. Listener?: Listener;
  2061. }
  2062. export interface WithdrawByoipCidrRequest {
  2063. /**
  2064. * The address range, in CIDR notation. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  2065. */
  2066. Cidr: GenericString;
  2067. }
  2068. export interface WithdrawByoipCidrResponse {
  2069. /**
  2070. * Information about the BYOIP address pool.
  2071. */
  2072. ByoipCidr?: ByoipCidr;
  2073. }
  2074. /**
  2075. * 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.
  2076. */
  2077. export type apiVersion = "2018-08-08"|"latest"|string;
  2078. export interface ClientApiVersions {
  2079. /**
  2080. * 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.
  2081. */
  2082. apiVersion?: apiVersion;
  2083. }
  2084. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2085. /**
  2086. * Contains interfaces for use with the GlobalAccelerator client.
  2087. */
  2088. export import Types = GlobalAccelerator;
  2089. }
  2090. export = GlobalAccelerator;