AWS.GlobalAccelerator — AWS SDK for JavaScript (original) (raw)

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is the Global Accelerator API Reference. 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 Global Accelerator Developer Guide.

Global Accelerator is a service in which you create accelerators 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.

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 global network.
For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.

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.

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 to Global Accelerator (BYOIP).

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.

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 delete 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 Tag-based policies.

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.

For more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.

Sending a Request Using GlobalAccelerator

var globalaccelerator = new AWS.GlobalAccelerator();
globalaccelerator.addCustomRoutingEndpoints(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the GlobalAccelerator object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var globalaccelerator = new AWS.GlobalAccelerator({apiVersion: '2018-08-08'});

You can also set the API version globally in AWS.config.apiVersions using the globalaccelerator service identifier:

AWS.config.apiVersions = {
  globalaccelerator: '2018-08-08',
  // other service API versions
};

var globalaccelerator = new AWS.GlobalAccelerator();

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addCustomRoutingEndpoints(params = {}, callback) ⇒ AWS.Request

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.

addEndpoints(params = {}, callback) ⇒ AWS.Request

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.

advertiseByoipCidr(params = {}, callback) ⇒ AWS.Request

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.

allowCustomRoutingTraffic(params = {}, callback) ⇒ AWS.Request

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.

createAccelerator(params = {}, callback) ⇒ AWS.Request

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.

createCrossAccountAttachment(params = {}, callback) ⇒ AWS.Request

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.

createCustomRoutingAccelerator(params = {}, callback) ⇒ AWS.Request

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.

createCustomRoutingEndpointGroup(params = {}, callback) ⇒ AWS.Request

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.

createCustomRoutingListener(params = {}, callback) ⇒ AWS.Request

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.

createEndpointGroup(params = {}, callback) ⇒ AWS.Request

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.

createListener(params = {}, callback) ⇒ AWS.Request

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.

deleteAccelerator(params = {}, callback) ⇒ AWS.Request

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.

deleteCrossAccountAttachment(params = {}, callback) ⇒ AWS.Request

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.

deleteCustomRoutingAccelerator(params = {}, callback) ⇒ AWS.Request

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.

deleteCustomRoutingEndpointGroup(params = {}, callback) ⇒ AWS.Request

Delete an endpoint group from a listener for a custom routing accelerator.

deleteCustomRoutingListener(params = {}, callback) ⇒ AWS.Request

Delete a listener for a custom routing accelerator.

deleteEndpointGroup(params = {}, callback) ⇒ AWS.Request

Delete an endpoint group from a listener.

deleteListener(params = {}, callback) ⇒ AWS.Request

Delete a listener from an accelerator.

denyCustomRoutingTraffic(params = {}, callback) ⇒ AWS.Request

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.

deprovisionByoipCidr(params = {}, callback) ⇒ AWS.Request

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.

describeAccelerator(params = {}, callback) ⇒ AWS.Request

describeAcceleratorAttributes(params = {}, callback) ⇒ AWS.Request

Describe the attributes of an accelerator.

describeCrossAccountAttachment(params = {}, callback) ⇒ AWS.Request

Gets configuration information about a cross-account attachment.

describeCustomRoutingAccelerator(params = {}, callback) ⇒ AWS.Request

Describe a custom routing accelerator.

describeCustomRoutingAcceleratorAttributes(params = {}, callback) ⇒ AWS.Request

Describe the attributes of a custom routing accelerator.

describeCustomRoutingEndpointGroup(params = {}, callback) ⇒ AWS.Request

Describe an endpoint group for a custom routing accelerator.

describeCustomRoutingListener(params = {}, callback) ⇒ AWS.Request

The description of a listener for a custom routing accelerator.

describeEndpointGroup(params = {}, callback) ⇒ AWS.Request

Describe an endpoint group.

describeListener(params = {}, callback) ⇒ AWS.Request

listAccelerators(params = {}, callback) ⇒ AWS.Request

List the accelerators for an Amazon Web Services account.

listByoipCidrs(params = {}, callback) ⇒ AWS.Request

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

listCrossAccountAttachments(params = {}, callback) ⇒ AWS.Request

List the cross-account attachments that have been created in Global Accelerator.

listCrossAccountResourceAccounts(params = {}, callback) ⇒ AWS.Request

listCrossAccountResources(params = {}, callback) ⇒ AWS.Request

List the cross-account resources available to work with.

listCustomRoutingAccelerators(params = {}, callback) ⇒ AWS.Request

List the custom routing accelerators for an Amazon Web Services account.

listCustomRoutingEndpointGroups(params = {}, callback) ⇒ AWS.Request

List the endpoint groups that are associated with a listener for a custom routing accelerator.

listCustomRoutingListeners(params = {}, callback) ⇒ AWS.Request

List the listeners for a custom routing accelerator.

listCustomRoutingPortMappings(params = {}, callback) ⇒ AWS.Request

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.

listCustomRoutingPortMappingsByDestination(params = {}, callback) ⇒ AWS.Request

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.

listEndpointGroups(params = {}, callback) ⇒ AWS.Request

List the endpoint groups that are associated with a listener.

listListeners(params = {}, callback) ⇒ AWS.Request

List the listeners for an accelerator.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

provisionByoipCidr(params = {}, callback) ⇒ AWS.Request

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.

removeCustomRoutingEndpoints(params = {}, callback) ⇒ AWS.Request

Remove endpoints from a custom routing accelerator.

removeEndpoints(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

updateAccelerator(params = {}, callback) ⇒ AWS.Request

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.

updateAcceleratorAttributes(params = {}, callback) ⇒ AWS.Request

Update the attributes for an accelerator.

updateCrossAccountAttachment(params = {}, callback) ⇒ AWS.Request

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.

updateCustomRoutingAccelerator(params = {}, callback) ⇒ AWS.Request

Update a custom routing accelerator.

updateCustomRoutingAcceleratorAttributes(params = {}, callback) ⇒ AWS.Request

Update the attributes for a custom routing accelerator.

updateCustomRoutingListener(params = {}, callback) ⇒ AWS.Request

Update a listener for a custom routing accelerator.

updateEndpointGroup(params = {}, callback) ⇒ AWS.Request

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

updateListener(params = {}, callback) ⇒ AWS.Request

withdrawByoipCidr(params = {}, callback) ⇒ AWS.Request

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.