@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSGlobalAccelerator
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSGlobalAccelerator instead.
This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.
AWS 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 AWS 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 AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.
By default, Global Accelerator provides you with two static IP addresses that you associate with your accelerator. With a standard accelerator, instead of using the IP 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. The static IP addresses are anycast from the AWS edge network. For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple AWS 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 AWS Region or multiple 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 AWS 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 a list of the AWS Regions where Global Accelerator and other services are currently supported, see the AWS Region Table.
AWS Global Accelerator includes the following components:
Global Accelerator provides you with a set of two static IP addresses that are anycast from the AWS edge network. If you bring your own IP address range to AWS (BYOIP) to use with a standard accelerator, you can instead assign IP addresses from your own pool to use with your accelerator. For more information, see Bring your own IP addresses (BYOIP) in AWS Global Accelerator.
The IP addresses serve as single fixed entry points for your clients. If you already have Elastic Load Balancing load balancers, Amazon EC2 instances, or Elastic IP address resources set up for your applications, you can easily add those to a standard accelerator in Global Accelerator. This allows Global Accelerator to use static IP addresses to access the resources.
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 delete an accelerator. For more information, see Tag-based policies.
An accelerator directs traffic to endpoints over the AWS global network to improve the performance of your internet applications. Each accelerator includes one or more listeners.
There are two types of accelerators:
A standard accelerator directs traffic to the optimal AWS endpoint based on several factors, including the user’s location, the health of the endpoint, and the endpoint weights that you configure. This improves the availability and performance of your applications. Endpoints can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses.
A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instances running in a single or multiple virtual private clouds (VPCs). With custom routing, listener ports are mapped to statically associate port ranges with VPC subnets, which allows Global Accelerator to determine an EC2 instance IP address at the time of connection. By default, all port mapping destinations in a VPC subnet can't receive traffic. You can choose to configure all destinations in the subnet to receive traffic, or to specify individual port mappings that can receive traffic.
For more information, see Types of accelerators.
Global Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to
a1234567890abcdef.awsglobalaccelerator.com, that points to the static IP addresses that Global
Accelerator assigns to you or that you choose from your own IP address range. Depending on the use case, you can use
your accelerator's static IP addresses or DNS name to route traffic to your accelerator, or set up DNS records to
route traffic using your own custom domain name.
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, by default, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
A listener processes inbound connections from clients to Global Accelerator, based on the port (or port range) and protocol (or protocols) that you configure. A listener can be configured for TCP, UDP, or both TCP and UDP protocols. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. With a standard accelerator, traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.
Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. With a standard accelerator, you can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing, for example, for new releases across different AWS Regions.
An endpoint is a resource that Global Accelerator directs traffic to.
Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses. An Application Load Balancer endpoint can be internet-facing or internal. Traffic for standard accelerators is routed to endpoints based on the health of the endpoint along with configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.
Endpoints for custom routing accelerators are virtual private cloud (VPC) subnets with one or many EC2 instances.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddCustomRoutingEndpointsResult |
addCustomRoutingEndpoints(AddCustomRoutingEndpointsRequest addCustomRoutingEndpointsRequest)
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
|
AdvertiseByoipCidrResult |
advertiseByoipCidr(AdvertiseByoipCidrRequest advertiseByoipCidrRequest)
Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP
addresses (BYOIP).
|
AllowCustomRoutingTrafficResult |
allowCustomRoutingTraffic(AllowCustomRoutingTrafficRequest allowCustomRoutingTrafficRequest)
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive
traffic for a custom routing accelerator.
|
CreateAcceleratorResult |
createAccelerator(CreateAcceleratorRequest createAcceleratorRequest)
Create an accelerator.
|
CreateCustomRoutingAcceleratorResult |
createCustomRoutingAccelerator(CreateCustomRoutingAcceleratorRequest createCustomRoutingAcceleratorRequest)
Create a custom routing accelerator.
|
CreateCustomRoutingEndpointGroupResult |
createCustomRoutingEndpointGroup(CreateCustomRoutingEndpointGroupRequest createCustomRoutingEndpointGroupRequest)
Create an endpoint group for the specified listener for a custom routing accelerator.
|
CreateCustomRoutingListenerResult |
createCustomRoutingListener(CreateCustomRoutingListenerRequest createCustomRoutingListenerRequest)
Create a listener to process inbound connections from clients to a custom routing accelerator.
|
CreateEndpointGroupResult |
createEndpointGroup(CreateEndpointGroupRequest createEndpointGroupRequest)
Create an endpoint group for the specified listener.
|
CreateListenerResult |
createListener(CreateListenerRequest createListenerRequest)
Create a listener to process inbound connections from clients to an accelerator.
|
DeleteAcceleratorResult |
deleteAccelerator(DeleteAcceleratorRequest deleteAcceleratorRequest)
Delete an accelerator.
|
DeleteCustomRoutingAcceleratorResult |
deleteCustomRoutingAccelerator(DeleteCustomRoutingAcceleratorRequest deleteCustomRoutingAcceleratorRequest)
Delete a custom routing accelerator.
|
DeleteCustomRoutingEndpointGroupResult |
deleteCustomRoutingEndpointGroup(DeleteCustomRoutingEndpointGroupRequest deleteCustomRoutingEndpointGroupRequest)
Delete an endpoint group from a listener for a custom routing accelerator.
|
DeleteCustomRoutingListenerResult |
deleteCustomRoutingListener(DeleteCustomRoutingListenerRequest deleteCustomRoutingListenerRequest)
Delete a listener for a custom routing accelerator.
|
DeleteEndpointGroupResult |
deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest)
Delete an endpoint group from a listener.
|
DeleteListenerResult |
deleteListener(DeleteListenerRequest deleteListenerRequest)
Delete a listener from an accelerator.
|
DenyCustomRoutingTrafficResult |
denyCustomRoutingTraffic(DenyCustomRoutingTrafficRequest denyCustomRoutingTrafficRequest)
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot
receive traffic for a custom routing accelerator.
|
DeprovisionByoipCidrResult |
deprovisionByoipCidr(DeprovisionByoipCidrRequest deprovisionByoipCidrRequest)
Releases the specified address range that you provisioned to use with your AWS resources through bring your own
IP addresses (BYOIP) and deletes the corresponding address pool.
|
DescribeAcceleratorResult |
describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest)
Describe an accelerator.
|
DescribeAcceleratorAttributesResult |
describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest)
Describe the attributes of an accelerator.
|
DescribeCustomRoutingAcceleratorResult |
describeCustomRoutingAccelerator(DescribeCustomRoutingAcceleratorRequest describeCustomRoutingAcceleratorRequest)
Describe a custom routing accelerator.
|
DescribeCustomRoutingAcceleratorAttributesResult |
describeCustomRoutingAcceleratorAttributes(DescribeCustomRoutingAcceleratorAttributesRequest describeCustomRoutingAcceleratorAttributesRequest)
Describe the attributes of a custom routing accelerator.
|
DescribeCustomRoutingEndpointGroupResult |
describeCustomRoutingEndpointGroup(DescribeCustomRoutingEndpointGroupRequest describeCustomRoutingEndpointGroupRequest)
Describe an endpoint group for a custom routing accelerator.
|
DescribeCustomRoutingListenerResult |
describeCustomRoutingListener(DescribeCustomRoutingListenerRequest describeCustomRoutingListenerRequest)
The description of a listener for a custom routing accelerator.
|
DescribeEndpointGroupResult |
describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest)
Describe an endpoint group.
|
DescribeListenerResult |
describeListener(DescribeListenerRequest describeListenerRequest)
Describe a listener.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAcceleratorsResult |
listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest)
List the accelerators for an AWS account.
|
ListByoipCidrsResult |
listByoipCidrs(ListByoipCidrsRequest listByoipCidrsRequest)
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr,
including the current state and a history of state changes.
|
ListCustomRoutingAcceleratorsResult |
listCustomRoutingAccelerators(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest)
List the custom routing accelerators for an AWS account.
|
ListCustomRoutingEndpointGroupsResult |
listCustomRoutingEndpointGroups(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest)
List the endpoint groups that are associated with a listener for a custom routing accelerator.
|
ListCustomRoutingListenersResult |
listCustomRoutingListeners(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest)
List the listeners for a custom routing accelerator.
|
ListCustomRoutingPortMappingsResult |
listCustomRoutingPortMappings(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest)
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.
|
ListCustomRoutingPortMappingsByDestinationResult |
listCustomRoutingPortMappingsByDestination(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest)
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.
|
ListEndpointGroupsResult |
listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest)
List the endpoint groups that are associated with a listener.
|
ListListenersResult |
listListeners(ListListenersRequest listListenersRequest)
List the listeners for an accelerator.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags for an accelerator.
|
ProvisionByoipCidrResult |
provisionByoipCidr(ProvisionByoipCidrRequest provisionByoipCidrRequest)
Provisions an IP address range to use with your AWS resources through bring your own IP addresses (BYOIP) and
creates a corresponding address pool.
|
RemoveCustomRoutingEndpointsResult |
removeCustomRoutingEndpoints(RemoveCustomRoutingEndpointsRequest removeCustomRoutingEndpointsRequest)
Remove endpoints from a custom routing accelerator.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Add tags to an accelerator resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a Global Accelerator resource.
|
UpdateAcceleratorResult |
updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest)
Update an accelerator.
|
UpdateAcceleratorAttributesResult |
updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest)
Update the attributes for an accelerator.
|
UpdateCustomRoutingAcceleratorResult |
updateCustomRoutingAccelerator(UpdateCustomRoutingAcceleratorRequest updateCustomRoutingAcceleratorRequest)
Update a custom routing accelerator.
|
UpdateCustomRoutingAcceleratorAttributesResult |
updateCustomRoutingAcceleratorAttributes(UpdateCustomRoutingAcceleratorAttributesRequest updateCustomRoutingAcceleratorAttributesRequest)
Update the attributes for a custom routing accelerator.
|
UpdateCustomRoutingListenerResult |
updateCustomRoutingListener(UpdateCustomRoutingListenerRequest updateCustomRoutingListenerRequest)
Update a listener for a custom routing accelerator.
|
UpdateEndpointGroupResult |
updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest)
Update an endpoint group.
|
UpdateListenerResult |
updateListener(UpdateListenerRequest updateListenerRequest)
Update a listener.
|
WithdrawByoipCidrResult |
withdrawByoipCidr(WithdrawByoipCidrRequest withdrawByoipCidrRequest)
Stops advertising an address range that is provisioned as an address pool.
|
static final String ENDPOINT_PREFIX
AddCustomRoutingEndpointsResult addCustomRoutingEndpoints(AddCustomRoutingEndpointsRequest addCustomRoutingEndpointsRequest)
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.
addCustomRoutingEndpointsRequest - EndpointAlreadyExistsException - The endpoint that you specified doesn't exist.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.ConflictException - You can't use both of those options.AdvertiseByoipCidrResult advertiseByoipCidr(AdvertiseByoipCidrRequest advertiseByoipCidrRequest)
Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS 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 AWS Global Accelerator Developer Guide.
advertiseByoipCidrRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.ByoipCidrNotFoundException - The CIDR that you specified was not found or is incorrect.IncorrectCidrStateException - The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be
incorrect for this action.AllowCustomRoutingTrafficResult allowCustomRoutingTraffic(AllowCustomRoutingTrafficRequest allowCustomRoutingTrafficRequest)
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.
allowCustomRoutingTrafficRequest - InvalidArgumentException - An argument that you specified is invalid.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.CreateAcceleratorResult createAccelerator(CreateAcceleratorRequest createAcceleratorRequest)
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 AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.
createAcceleratorRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.CreateCustomRoutingAcceleratorResult createCustomRoutingAccelerator(CreateCustomRoutingAcceleratorRequest createCustomRoutingAcceleratorRequest)
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 AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.
createCustomRoutingAcceleratorRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.CreateCustomRoutingEndpointGroupResult createCustomRoutingEndpointGroup(CreateCustomRoutingEndpointGroupRequest createCustomRoutingEndpointGroupRequest)
Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one AWS Region.
createCustomRoutingEndpointGroupRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.EndpointGroupAlreadyExistsException - The endpoint group that you specified already exists.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.InvalidPortRangeException - The port numbers that you specified are not valid numbers or are not unique for this accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.CreateCustomRoutingListenerResult createCustomRoutingListener(CreateCustomRoutingListenerRequest createCustomRoutingListenerRequest)
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.
createCustomRoutingListenerRequest - InvalidArgumentException - An argument that you specified is invalid.AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InvalidPortRangeException - The port numbers that you specified are not valid numbers or are not unique for this accelerator.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.CreateEndpointGroupResult createEndpointGroup(CreateEndpointGroupRequest createEndpointGroupRequest)
Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. A resource must be valid and active when you add it as an endpoint.
createEndpointGroupRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.EndpointGroupAlreadyExistsException - The endpoint group that you specified already exists.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.CreateListenerResult createListener(CreateListenerRequest createListenerRequest)
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.
createListenerRequest - InvalidArgumentException - An argument that you specified is invalid.AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InvalidPortRangeException - The port numbers that you specified are not valid numbers or are not unique for this accelerator.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.DeleteAcceleratorResult deleteAccelerator(DeleteAcceleratorRequest deleteAcceleratorRequest)
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 Authentication and Access Control in the AWS Global Accelerator Developer Guide.
deleteAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.AcceleratorNotDisabledException - The accelerator that you specified could not be disabled.AssociatedListenerFoundException - The accelerator that you specified has a listener associated with it. You must remove all dependent
resources from an accelerator before you can delete it.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DeleteCustomRoutingAcceleratorResult deleteCustomRoutingAccelerator(DeleteCustomRoutingAcceleratorRequest deleteCustomRoutingAcceleratorRequest)
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 Authentication and Access Control in the AWS Global Accelerator Developer Guide.
deleteCustomRoutingAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.AcceleratorNotDisabledException - The accelerator that you specified could not be disabled.AssociatedListenerFoundException - The accelerator that you specified has a listener associated with it. You must remove all dependent
resources from an accelerator before you can delete it.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DeleteCustomRoutingEndpointGroupResult deleteCustomRoutingEndpointGroup(DeleteCustomRoutingEndpointGroupRequest deleteCustomRoutingEndpointGroupRequest)
Delete an endpoint group from a listener for a custom routing accelerator.
deleteCustomRoutingEndpointGroupRequest - InvalidArgumentException - An argument that you specified is invalid.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DeleteCustomRoutingListenerResult deleteCustomRoutingListener(DeleteCustomRoutingListenerRequest deleteCustomRoutingListenerRequest)
Delete a listener for a custom routing accelerator.
deleteCustomRoutingListenerRequest - InvalidArgumentException - An argument that you specified is invalid.ListenerNotFoundException - The listener that you specified doesn't exist.AssociatedEndpointGroupFoundException - The listener that you specified has an endpoint group associated with it. You must remove all dependent
resources from a listener before you can delete it.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DeleteEndpointGroupResult deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest)
Delete an endpoint group from a listener.
deleteEndpointGroupRequest - InvalidArgumentException - An argument that you specified is invalid.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DeleteListenerResult deleteListener(DeleteListenerRequest deleteListenerRequest)
Delete a listener from an accelerator.
deleteListenerRequest - InvalidArgumentException - An argument that you specified is invalid.ListenerNotFoundException - The listener that you specified doesn't exist.AssociatedEndpointGroupFoundException - The listener that you specified has an endpoint group associated with it. You must remove all dependent
resources from a listener before you can delete it.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DenyCustomRoutingTrafficResult denyCustomRoutingTraffic(DenyCustomRoutingTrafficRequest denyCustomRoutingTrafficRequest)
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.
denyCustomRoutingTrafficRequest - InvalidArgumentException - An argument that you specified is invalid.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DeprovisionByoipCidrResult deprovisionByoipCidr(DeprovisionByoipCidrRequest deprovisionByoipCidrRequest)
Releases the specified address range that you provisioned to use with your AWS 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 AWS Global Accelerator Developer Guide.
deprovisionByoipCidrRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.ByoipCidrNotFoundException - The CIDR that you specified was not found or is incorrect.IncorrectCidrStateException - The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be
incorrect for this action.DescribeAcceleratorResult describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest)
Describe an accelerator.
describeAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DescribeAcceleratorAttributesResult describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest)
Describe the attributes of an accelerator.
describeAcceleratorAttributesRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DescribeCustomRoutingAcceleratorResult describeCustomRoutingAccelerator(DescribeCustomRoutingAcceleratorRequest describeCustomRoutingAcceleratorRequest)
Describe a custom routing accelerator.
describeCustomRoutingAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DescribeCustomRoutingAcceleratorAttributesResult describeCustomRoutingAcceleratorAttributes(DescribeCustomRoutingAcceleratorAttributesRequest describeCustomRoutingAcceleratorAttributesRequest)
Describe the attributes of a custom routing accelerator.
describeCustomRoutingAcceleratorAttributesRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.DescribeCustomRoutingEndpointGroupResult describeCustomRoutingEndpointGroup(DescribeCustomRoutingEndpointGroupRequest describeCustomRoutingEndpointGroupRequest)
Describe an endpoint group for a custom routing accelerator.
describeCustomRoutingEndpointGroupRequest - InvalidArgumentException - An argument that you specified is invalid.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DescribeCustomRoutingListenerResult describeCustomRoutingListener(DescribeCustomRoutingListenerRequest describeCustomRoutingListenerRequest)
The description of a listener for a custom routing accelerator.
describeCustomRoutingListenerRequest - InvalidArgumentException - An argument that you specified is invalid.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DescribeEndpointGroupResult describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest)
Describe an endpoint group.
describeEndpointGroupRequest - InvalidArgumentException - An argument that you specified is invalid.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.DescribeListenerResult describeListener(DescribeListenerRequest describeListenerRequest)
Describe a listener.
describeListenerRequest - InvalidArgumentException - An argument that you specified is invalid.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListAcceleratorsResult listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest)
List the accelerators for an AWS account.
listAcceleratorsRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidNextTokenException - There isn't another item to return.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListByoipCidrsResult listByoipCidrs(ListByoipCidrsRequest listByoipCidrsRequest)
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
listByoipCidrsRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.InvalidNextTokenException - There isn't another item to return.ListCustomRoutingAcceleratorsResult listCustomRoutingAccelerators(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest)
List the custom routing accelerators for an AWS account.
listCustomRoutingAcceleratorsRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidNextTokenException - There isn't another item to return.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListCustomRoutingEndpointGroupsResult listCustomRoutingEndpointGroups(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest)
List the endpoint groups that are associated with a listener for a custom routing accelerator.
listCustomRoutingEndpointGroupsRequest - ListenerNotFoundException - The listener that you specified doesn't exist.InvalidNextTokenException - There isn't another item to return.InvalidArgumentException - An argument that you specified is invalid.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListCustomRoutingListenersResult listCustomRoutingListeners(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest)
List the listeners for a custom routing accelerator.
listCustomRoutingListenersRequest - InvalidArgumentException - An argument that you specified is invalid.AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InvalidNextTokenException - There isn't another item to return.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListCustomRoutingPortMappingsResult listCustomRoutingPortMappings(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest)
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.
listCustomRoutingPortMappingsRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidNextTokenException - There isn't another item to return.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListCustomRoutingPortMappingsByDestinationResult listCustomRoutingPortMappingsByDestination(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest)
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.
listCustomRoutingPortMappingsByDestinationRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidNextTokenException - There isn't another item to return.EndpointNotFoundException - The endpoint that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListEndpointGroupsResult listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest)
List the endpoint groups that are associated with a listener.
listEndpointGroupsRequest - ListenerNotFoundException - The listener that you specified doesn't exist.InvalidNextTokenException - There isn't another item to return.InvalidArgumentException - An argument that you specified is invalid.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListListenersResult listListeners(ListListenersRequest listListenersRequest)
List the listeners for an accelerator.
listListenersRequest - InvalidArgumentException - An argument that you specified is invalid.AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InvalidNextTokenException - There isn't another item to return.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
listTagsForResourceRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.ProvisionByoipCidrResult provisionByoipCidr(ProvisionByoipCidrRequest provisionByoipCidrRequest)
Provisions an IP address range to use with your AWS 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 AWS Global Accelerator Developer Guide.
provisionByoipCidrRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.IncorrectCidrStateException - The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be
incorrect for this action.RemoveCustomRoutingEndpointsResult removeCustomRoutingEndpoints(RemoveCustomRoutingEndpointsRequest removeCustomRoutingEndpointsRequest)
Remove endpoints from a custom routing accelerator.
removeCustomRoutingEndpointsRequest - EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.EndpointNotFoundException - The endpoint that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.ConflictException - You can't use both of those options.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Add tags to an accelerator resource.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
tagResourceRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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 AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
untagResourceRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.UpdateAcceleratorResult updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest)
Update an accelerator.
Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.
updateAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.UpdateAcceleratorAttributesResult updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest)
Update the attributes for an accelerator.
updateAcceleratorAttributesRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.UpdateCustomRoutingAcceleratorResult updateCustomRoutingAccelerator(UpdateCustomRoutingAcceleratorRequest updateCustomRoutingAcceleratorRequest)
Update a custom routing accelerator.
updateCustomRoutingAcceleratorRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.UpdateCustomRoutingAcceleratorAttributesResult updateCustomRoutingAcceleratorAttributes(UpdateCustomRoutingAcceleratorAttributesRequest updateCustomRoutingAcceleratorAttributesRequest)
Update the attributes for a custom routing accelerator.
updateCustomRoutingAcceleratorAttributesRequest - AcceleratorNotFoundException - The accelerator that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.UpdateCustomRoutingListenerResult updateCustomRoutingListener(UpdateCustomRoutingListenerRequest updateCustomRoutingListenerRequest)
Update a listener for a custom routing accelerator.
updateCustomRoutingListenerRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidPortRangeException - The port numbers that you specified are not valid numbers or are not unique for this accelerator.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.UpdateEndpointGroupResult updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest)
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
updateEndpointGroupRequest - InvalidArgumentException - An argument that you specified is invalid.EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.AccessDeniedException - You don't have access permission.UpdateListenerResult updateListener(UpdateListenerRequest updateListenerRequest)
Update a listener.
updateListenerRequest - InvalidArgumentException - An argument that you specified is invalid.InvalidPortRangeException - The port numbers that you specified are not valid numbers or are not unique for this accelerator.ListenerNotFoundException - The listener that you specified doesn't exist.InternalServiceErrorException - There was an internal error for AWS Global Accelerator.LimitExceededException - Processing your request would cause you to exceed an AWS Global Accelerator limit.WithdrawByoipCidrResult withdrawByoipCidr(WithdrawByoipCidrRequest withdrawByoipCidrRequest)
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 AWS because of propagation delays.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
withdrawByoipCidrRequest - InternalServiceErrorException - There was an internal error for AWS Global Accelerator.InvalidArgumentException - An argument that you specified is invalid.AccessDeniedException - You don't have access permission.ByoipCidrNotFoundException - The CIDR that you specified was not found or is incorrect.IncorrectCidrStateException - The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be
incorrect for this action.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.