Skip to content

Commit

Permalink
docs(client-global-accelerator): Documentation update for dualstack E…
Browse files Browse the repository at this point in the history
…C2 endpoint support
  • Loading branch information
awstools committed Aug 9, 2023
1 parent 861a8a8 commit f3db88f
Show file tree
Hide file tree
Showing 26 changed files with 988 additions and 449 deletions.
5 changes: 1 addition & 4 deletions clients/client-global-accelerator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,19 @@ can use application logic to directly map one or more users to a specific endpoi
<important>
<p>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 <code>--region us-west-2</code>
on AWS CLI commands.</p>
on Amazon Web Services CLI commands.</p>
</important>

<p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>

<p>For a standard accelerator,
they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
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
accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
are virtual private cloud (VPC) subnets.</p>

<important>
<p>The 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
Expand Down
29 changes: 12 additions & 17 deletions clients/client-global-accelerator/src/GlobalAccelerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1096,13 +1096,13 @@ export interface GlobalAccelerator {
/**
* @public
* <fullname>Global Accelerator</fullname>
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
* gain additional benefits. </p>
* <ul>
* <ul>
* <li>
* <p>By using a standard accelerator, you can improve availability of your internet applications
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
Expand All @@ -1113,40 +1113,35 @@ export interface GlobalAccelerator {
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
* </li>
* </ul>
* <important>
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
* <important>
* <p>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 <code>--region us-west-2</code>
* on AWS CLI commands.</p>
* </important>
*
*
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
* on Amazon Web Services CLI commands.</p>
* </important>
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
*
*
* <p>For a standard accelerator,
* <p>For a standard accelerator,
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
* 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
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
* are virtual private cloud (VPC) subnets.</p>
*
* <important>
* <important>
* <p>The 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
* <i>delete</i> an accelerator, you lose the static IP addresses that
* are assigned to it, so you can no longer route traffic by using them. You can use
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
* 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>
* </important>
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
* on health, client location, and policies that you configure. The service reacts instantly to
* changes in health or configuration to ensure that internet traffic from clients is always
* directed to healthy endpoints.</p>
* <p>For more information about understanding and using Global Accelerator, see the
* <p>For more information about understanding and using Global Accelerator, see the
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
*/
export class GlobalAccelerator extends GlobalAcceleratorClient implements GlobalAccelerator {}
Expand Down
29 changes: 12 additions & 17 deletions clients/client-global-accelerator/src/GlobalAcceleratorClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -475,13 +475,13 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
/**
* @public
* <fullname>Global Accelerator</fullname>
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
* gain additional benefits. </p>
* <ul>
* <ul>
* <li>
* <p>By using a standard accelerator, you can improve availability of your internet applications
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
Expand All @@ -492,40 +492,35 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
* </li>
* </ul>
* <important>
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
* <important>
* <p>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 <code>--region us-west-2</code>
* on AWS CLI commands.</p>
* </important>
*
*
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
* on Amazon Web Services CLI commands.</p>
* </important>
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
*
*
* <p>For a standard accelerator,
* <p>For a standard accelerator,
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
* 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
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
* are virtual private cloud (VPC) subnets.</p>
*
* <important>
* <important>
* <p>The 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
* <i>delete</i> an accelerator, you lose the static IP addresses that
* are assigned to it, so you can no longer route traffic by using them. You can use
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
* 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>
* </important>
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
* on health, client location, and policies that you configure. The service reacts instantly to
* changes in health or configuration to ensure that internet traffic from clients is always
* directed to healthy endpoints.</p>
* <p>For more information about understanding and using Global Accelerator, see the
* <p>For more information about understanding and using Global Accelerator, see the
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
*/
export class GlobalAcceleratorClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ export interface AddCustomRoutingEndpointsCommandOutput extends AddCustomRouting
/**
* @public
* <p>Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.</p>
* <p>The listener port range must be large enough to support the number of IP addresses that can be
* <p>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. </p>
* <p>Note: You must have enough remaining listener ports available to
* <p>Note: You must have enough remaining listener ports available to
* map to the subnet ports, or the call will fail with a LimitExceededException.</p>
* <p>By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all
* <p>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 <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html">
* AllowCustomRoutingTraffic</a> operation.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,21 @@ export interface AddEndpointsCommandOutput extends AddEndpointsResponse, __Metad
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html">CreateEndpointGroup</a> API)
* or when you update an endpoint group (with the
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html">UpdateEndpointGroup</a> API). </p>
* <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints:</p>
* <ul>
* <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints in Global Accelerator:</p>
* <ul>
* <li>
* <p>It's faster, because Global Accelerator only has to resolve the new endpoints that
* you're adding.</p>
* you're adding, rather than resolving new and existing endpoints.</p>
* </li>
* <li>
* <p>It's more convenient, because you don't need to specify all of the current
* endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.</p>
* <p>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.</p>
* </li>
* </ul>
* <p>For information about endpoint types and requirements for endpoints that you can add
* to Global Accelerator, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html">
* Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ export interface AdvertiseByoipCidrCommandOutput extends AdvertiseByoipCidrRespo
* <p>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. </p>
* <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">
* <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">
* WithdrawByoipCidr</a>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface AllowCustomRoutingTrafficCommandOutput extends __MetadataBearer
* 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.</p>
* <p>After you make changes, you can verify that the updates are complete by checking the status of your
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ export interface CreateAcceleratorCommandOutput extends CreateAcceleratorRespons
* @public
* <p>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. </p>
* <important>
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
* <important>
* <p>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 <code>--region us-west-2</code>
* on AWS CLI commands.</p>
* </important>
* on Amazon Web Services CLI commands.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit f3db88f

Please sign in to comment.