Skip to content

Commit f3db88f

Browse files
author
awstools
committed
docs(client-global-accelerator): Documentation update for dualstack EC2 endpoint support
1 parent 861a8a8 commit f3db88f

26 files changed

+988
-449
lines changed

clients/client-global-accelerator/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,19 @@ can use application logic to directly map one or more users to a specific endpoi
2828
<important>
2929
<p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
3030
US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
31-
on AWS CLI commands.</p>
31+
on Amazon Web Services CLI commands.</p>
3232
</important>
33-
3433
<p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
3534
are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
3635
Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
3736
With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
3837
these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
39-
4038
<p>For a standard accelerator,
4139
they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
4240
the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
4341
Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
4442
accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
4543
are virtual private cloud (VPC) subnets.</p>
46-
4744
<important>
4845
<p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
4946
disable the accelerator and it no longer accepts or routes traffic. However, when you

clients/client-global-accelerator/src/GlobalAccelerator.ts

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1096,13 +1096,13 @@ export interface GlobalAccelerator {
10961096
/**
10971097
* @public
10981098
* <fullname>Global Accelerator</fullname>
1099-
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
1099+
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
11001100
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
11011101
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
1102-
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
1102+
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
11031103
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
11041104
* gain additional benefits. </p>
1105-
* <ul>
1105+
* <ul>
11061106
* <li>
11071107
* <p>By using a standard accelerator, you can improve availability of your internet applications
11081108
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
@@ -1113,40 +1113,35 @@ export interface GlobalAccelerator {
11131113
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
11141114
* </li>
11151115
* </ul>
1116-
* <important>
1117-
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
1116+
* <important>
1117+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
11181118
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
1119-
* on AWS CLI commands.</p>
1120-
* </important>
1121-
*
1122-
*
1123-
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
1119+
* on Amazon Web Services CLI commands.</p>
1120+
* </important>
1121+
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
11241122
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
11251123
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
11261124
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
11271125
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
1128-
*
1129-
*
1130-
* <p>For a standard accelerator,
1126+
* <p>For a standard accelerator,
11311127
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
11321128
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
11331129
* Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
11341130
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
11351131
* are virtual private cloud (VPC) subnets.</p>
1136-
*
1137-
* <important>
1132+
* <important>
11381133
* <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
11391134
* disable the accelerator and it no longer accepts or routes traffic. However, when you
11401135
* <i>delete</i> an accelerator, you lose the static IP addresses that
11411136
* are assigned to it, so you can no longer route traffic by using them. You can use
11421137
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
11431138
* permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p>
11441139
* </important>
1145-
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
1140+
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
11461141
* on health, client location, and policies that you configure. The service reacts instantly to
11471142
* changes in health or configuration to ensure that internet traffic from clients is always
11481143
* directed to healthy endpoints.</p>
1149-
* <p>For more information about understanding and using Global Accelerator, see the
1144+
* <p>For more information about understanding and using Global Accelerator, see the
11501145
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
11511146
*/
11521147
export class GlobalAccelerator extends GlobalAcceleratorClient implements GlobalAccelerator {}

clients/client-global-accelerator/src/GlobalAcceleratorClient.ts

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -475,13 +475,13 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
475475
/**
476476
* @public
477477
* <fullname>Global Accelerator</fullname>
478-
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
478+
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
479479
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
480480
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
481-
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
481+
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
482482
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
483483
* gain additional benefits. </p>
484-
* <ul>
484+
* <ul>
485485
* <li>
486486
* <p>By using a standard accelerator, you can improve availability of your internet applications
487487
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
@@ -492,40 +492,35 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
492492
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
493493
* </li>
494494
* </ul>
495-
* <important>
496-
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
495+
* <important>
496+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
497497
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
498-
* on AWS CLI commands.</p>
499-
* </important>
500-
*
501-
*
502-
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
498+
* on Amazon Web Services CLI commands.</p>
499+
* </important>
500+
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
503501
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
504502
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
505503
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
506504
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
507-
*
508-
*
509-
* <p>For a standard accelerator,
505+
* <p>For a standard accelerator,
510506
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
511507
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
512508
* Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
513509
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
514510
* are virtual private cloud (VPC) subnets.</p>
515-
*
516-
* <important>
511+
* <important>
517512
* <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
518513
* disable the accelerator and it no longer accepts or routes traffic. However, when you
519514
* <i>delete</i> an accelerator, you lose the static IP addresses that
520515
* are assigned to it, so you can no longer route traffic by using them. You can use
521516
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
522517
* permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p>
523518
* </important>
524-
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
519+
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
525520
* on health, client location, and policies that you configure. The service reacts instantly to
526521
* changes in health or configuration to ensure that internet traffic from clients is always
527522
* directed to healthy endpoints.</p>
528-
* <p>For more information about understanding and using Global Accelerator, see the
523+
* <p>For more information about understanding and using Global Accelerator, see the
529524
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
530525
*/
531526
export class GlobalAcceleratorClient extends __Client<

clients/client-global-accelerator/src/commands/AddCustomRoutingEndpointsCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ export interface AddCustomRoutingEndpointsCommandOutput extends AddCustomRouting
4141
/**
4242
* @public
4343
* <p>Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.</p>
44-
* <p>The listener port range must be large enough to support the number of IP addresses that can be
44+
* <p>The listener port range must be large enough to support the number of IP addresses that can be
4545
* specified in your subnet. The number of ports required is: subnet size times the number
4646
* of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener
4747
* port range of at least 255 ports. </p>
48-
* <p>Note: You must have enough remaining listener ports available to
48+
* <p>Note: You must have enough remaining listener ports available to
4949
* map to the subnet ports, or the call will fail with a LimitExceededException.</p>
50-
* <p>By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all
50+
* <p>By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all
5151
* destinations to receive traffic, or to specify individual port mappings that can receive
5252
* traffic, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html">
5353
* AllowCustomRoutingTraffic</a> operation.</p>

clients/client-global-accelerator/src/commands/AddEndpointsCommand.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,21 @@ export interface AddEndpointsCommandOutput extends AddEndpointsResponse, __Metad
4545
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html">CreateEndpointGroup</a> API)
4646
* or when you update an endpoint group (with the
4747
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html">UpdateEndpointGroup</a> API). </p>
48-
* <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints:</p>
49-
* <ul>
48+
* <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints in Global Accelerator:</p>
49+
* <ul>
5050
* <li>
5151
* <p>It's faster, because Global Accelerator only has to resolve the new endpoints that
52-
* you're adding.</p>
52+
* you're adding, rather than resolving new and existing endpoints.</p>
5353
* </li>
5454
* <li>
55-
* <p>It's more convenient, because you don't need to specify all of the current
56-
* endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.</p>
55+
* <p>It's more convenient, because you don't need to specify the current
56+
* endpoints that are already in the endpoint group, in addition to the new endpoints that
57+
* you want to add.</p>
5758
* </li>
5859
* </ul>
60+
* <p>For information about endpoint types and requirements for endpoints that you can add
61+
* to Global Accelerator, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html">
62+
* Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>
5963
* @example
6064
* Use a bare-bones client and the command you need to make an API call.
6165
* ```javascript

clients/client-global-accelerator/src/commands/AdvertiseByoipCidrCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ export interface AdvertiseByoipCidrCommandOutput extends AdvertiseByoipCidrRespo
4343
* <p>Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources
4444
* through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to
4545
* the specified addresses starts routing to Amazon Web Services because of propagation delays. </p>
46-
* <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">
46+
* <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">
4747
* WithdrawByoipCidr</a>.</p>
48-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
48+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
4949
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.

clients/client-global-accelerator/src/commands/AllowCustomRoutingTrafficCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface AllowCustomRoutingTrafficCommandOutput extends __MetadataBearer
4444
* for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a
4545
* specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports
4646
* outside of the range that you configured for the endpoint group.</p>
47-
* <p>After you make changes, you can verify that the updates are complete by checking the status of your
47+
* <p>After you make changes, you can verify that the updates are complete by checking the status of your
4848
* accelerator: the status changes from IN_PROGRESS to DEPLOYED.</p>
4949
* @example
5050
* Use a bare-bones client and the command you need to make an API call.

clients/client-global-accelerator/src/commands/CreateAcceleratorCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ export interface CreateAcceleratorCommandOutput extends CreateAcceleratorRespons
4242
* @public
4343
* <p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic
4444
* to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. </p>
45-
* <important>
46-
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
45+
* <important>
46+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
4747
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
48-
* on AWS CLI commands.</p>
49-
* </important>
48+
* on Amazon Web Services CLI commands.</p>
49+
* </important>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

0 commit comments

Comments
 (0)