View Source AWS.GlobalAccelerator (aws-elixir v0.14.1)

Global Accelerator

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.

Summary

Functions

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

Add endpoints to an endpoint group.

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.

Create a cross-account attachment in Global Accelerator.

Create an endpoint group for the specified listener for a custom routing accelerator.

Create a listener to process inbound connections from clients to a custom routing accelerator.

Create an endpoint group for the specified listener.

Create a listener to process inbound connections from clients to an accelerator.

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

Delete a listener for a custom routing accelerator.

Delete an endpoint group from a listener.

Delete a listener from an accelerator.

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.

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.

Describe the attributes of an accelerator.

Gets configuration information about a cross-account attachment.

Describe the attributes of a custom routing accelerator.

Describe an endpoint group for a custom routing accelerator.

The description of a listener for a custom routing accelerator.

List the accelerators for an Amazon Web Services account.

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

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

List the accounts that have cross-account endpoints.

List the cross-account endpoints available to add to an accelerator.

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

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

List the listeners for a custom routing accelerator.

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.

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.

List the endpoint groups that are associated with a listener.

List the listeners for an accelerator.

List all tags for an accelerator.

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.

Remove endpoints from a custom routing accelerator.

Remove endpoints from an endpoint group.

Add tags to an accelerator resource.

Remove tags from a Global Accelerator resource.

Update an accelerator to make changes, such as the following

Update the attributes for an accelerator.

Update a cross-account attachment to add or remove principals or resources.

Update the attributes for a custom routing accelerator.

Update a listener for a custom routing accelerator.

Stops advertising an address range that is provisioned as an address pool.

Functions

Link to this function

add_custom_routing_endpoints(client, input, options \\ [])

View Source

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.

Link to this function

add_endpoints(client, input, options \\ [])

View Source

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.

Link to this function

allow_custom_routing_traffic(client, input, options \\ [])

View Source

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.

Link to this function

create_accelerator(client, input, options \\ [])

View Source

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.

Link to this function

create_cross_account_attachment(client, input, options \\ [])

View Source

Create a cross-account attachment in Global Accelerator.

You create a cross-account attachment to specify the principals who have permission to add to accelerators in their own account the resources in your account that you also list in the attachment.

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 add a resource listed in the attachment to an accelerator, you must sign in to an account specified as a principal. Then you can add the resources that are listed to 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 add as endpoints resources that are listed in the attachment.

Link to this function

create_custom_routing_accelerator(client, input, options \\ [])

View Source

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.

Link to this function

create_custom_routing_endpoint_group(client, input, options \\ [])

View Source

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.

Link to this function

create_custom_routing_listener(client, input, options \\ [])

View Source

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.

Link to this function

create_endpoint_group(client, input, options \\ [])

View Source

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.

Link to this function

create_listener(client, input, options \\ [])

View Source

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.

Link to this function

delete_accelerator(client, input, options \\ [])

View Source

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.

Link to this function

delete_cross_account_attachment(client, input, options \\ [])

View Source

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 by doing the following:

  • If the principal is an account ID, Global Accelerator reviews every accelerator in the account and removes cross-account endpoints from all accelerators.

  • If the principal is an accelerator, Global Accelerator reviews just that accelerator and removes cross-account endpoints from it.

If there are overlapping permissions provided by multiple cross-account attachments, Global Accelerator only removes endpoints if there are no current cross-account attachments that provide access permission. For example, if you delete a cross-account attachment that lists an accelerator as a principal, but another cross-account attachment includes the account ID that owns that accelerator, endpoints will not be removed from the accelerator.

Link to this function

delete_custom_routing_accelerator(client, input, options \\ [])

View Source

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.

Link to this function

delete_custom_routing_endpoint_group(client, input, options \\ [])

View Source

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

Link to this function

delete_custom_routing_listener(client, input, options \\ [])

View Source

Delete a listener for a custom routing accelerator.

Link to this function

delete_endpoint_group(client, input, options \\ [])

View Source

Delete an endpoint group from a listener.

Link to this function

delete_listener(client, input, options \\ [])

View Source

Delete a listener from an accelerator.

Link to this function

deny_custom_routing_traffic(client, input, options \\ [])

View Source

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.

Link to this function

deprovision_byoip_cidr(client, input, options \\ [])

View Source

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.

Link to this function

describe_accelerator(client, input, options \\ [])

View Source

Describe an accelerator.

Link to this function

describe_accelerator_attributes(client, input, options \\ [])

View Source

Describe the attributes of an accelerator.

Link to this function

describe_cross_account_attachment(client, input, options \\ [])

View Source

Gets configuration information about a cross-account attachment.

Link to this function

describe_custom_routing_accelerator(client, input, options \\ [])

View Source

Describe a custom routing accelerator.

Link to this function

describe_custom_routing_accelerator_attributes(client, input, options \\ [])

View Source

Describe the attributes of a custom routing accelerator.

Link to this function

describe_custom_routing_endpoint_group(client, input, options \\ [])

View Source

Describe an endpoint group for a custom routing accelerator.

Link to this function

describe_custom_routing_listener(client, input, options \\ [])

View Source

The description of a listener for a custom routing accelerator.

Link to this function

describe_endpoint_group(client, input, options \\ [])

View Source

Describe an endpoint group.

Link to this function

describe_listener(client, input, options \\ [])

View Source

Describe a listener.

Link to this function

list_accelerators(client, input, options \\ [])

View Source

List the accelerators for an Amazon Web Services account.

Link to this function

list_byoip_cidrs(client, input, options \\ [])

View Source

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

Link to this function

list_cross_account_attachments(client, input, options \\ [])

View Source

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

Link to this function

list_cross_account_resource_accounts(client, input, options \\ [])

View Source

List the accounts that have cross-account endpoints.

Link to this function

list_cross_account_resources(client, input, options \\ [])

View Source

List the cross-account endpoints available to add to an accelerator.

Link to this function

list_custom_routing_accelerators(client, input, options \\ [])

View Source

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

Link to this function

list_custom_routing_endpoint_groups(client, input, options \\ [])

View Source

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

Link to this function

list_custom_routing_listeners(client, input, options \\ [])

View Source

List the listeners for a custom routing accelerator.

Link to this function

list_custom_routing_port_mappings(client, input, options \\ [])

View Source

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.

Link to this function

list_custom_routing_port_mappings_by_destination(client, input, options \\ [])

View Source

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.

Link to this function

list_endpoint_groups(client, input, options \\ [])

View Source

List the endpoint groups that are associated with a listener.

Link to this function

list_listeners(client, input, options \\ [])

View Source

List the listeners for an accelerator.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List all tags for an accelerator.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

Link to this function

provision_byoip_cidr(client, input, options \\ [])

View Source

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.

Link to this function

remove_custom_routing_endpoints(client, input, options \\ [])

View Source

Remove endpoints from a custom routing accelerator.

Link to this function

remove_endpoints(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Add tags to an accelerator resource.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

Link to this function

untag_resource(client, input, options \\ [])

View Source

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.

Link to this function

update_accelerator(client, input, options \\ [])

View Source

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.

Link to this function

update_accelerator_attributes(client, input, options \\ [])

View Source

Update the attributes for an accelerator.

Link to this function

update_cross_account_attachment(client, input, options \\ [])

View Source

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 by doing the following:

  • If the principal is an account ID, Global Accelerator reviews every accelerator in the account and removes cross-account endpoints from all accelerators.

  • If the principal is an accelerator, Global Accelerator reviews just that accelerator and removes cross-account endpoints from it.

If there are overlapping permissions provided by multiple cross-account attachments, Global Accelerator only removes endpoints if there are no current cross-account attachments that provide access permission. For example, if you delete a cross-account attachment that lists an accelerator as a principal, but another cross-account attachment includes the account ID that owns that accelerator, endpoints will not be removed from the accelerator.

Link to this function

update_custom_routing_accelerator(client, input, options \\ [])

View Source

Update a custom routing accelerator.

Link to this function

update_custom_routing_accelerator_attributes(client, input, options \\ [])

View Source

Update the attributes for a custom routing accelerator.

Link to this function

update_custom_routing_listener(client, input, options \\ [])

View Source

Update a listener for a custom routing accelerator.

Link to this function

update_endpoint_group(client, input, options \\ [])

View Source

Update an endpoint group.

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

Link to this function

update_listener(client, input, options \\ [])

View Source

Update a listener.

Link to this function

withdraw_byoip_cidr(client, input, options \\ [])

View Source

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.