com.amazonaws.services.globalaccelerator

Interface AWSGlobalAccelerator

All Known Subinterfaces:

AWSGlobalAcceleratorAsync

All Known Implementing Classes:

AbstractAWSGlobalAccelerator, AbstractAWSGlobalAcceleratorAsync, AWSGlobalAcceleratorAsyncClient, AWSGlobalAcceleratorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSGlobalAccelerator

Interface for accessing AWS Global Accelerator.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSGlobalAccelerator instead.

AWS Global Accelerator

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 network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.

Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.

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 directed to only healthy endpoints.

Global Accelerator includes components that work together to help you improve performance and availability for your applications:

Static IP address

AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.

Accelerator

An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.

Network zone

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, 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.

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. 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. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. 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 new releases across different AWS Regions, for example.

Endpoint

An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAcceleratorResult	createAccelerator(CreateAcceleratorRequest createAcceleratorRequest) Create an 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.
DeleteEndpointGroupResult	deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest) Delete an endpoint group from a listener.
DeleteListenerResult	deleteListener(DeleteListenerRequest deleteListenerRequest) Delete a listener from an accelerator.
DescribeAcceleratorResult	describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest) Describe an accelerator.
DescribeAcceleratorAttributesResult	describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest) Describe the attributes of an 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.
ListEndpointGroupsResult	listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest) List the endpoint groups that are associated with a listener.
ListListenersResult	listListeners(ListListenersRequest listListenersRequest) List the listeners for an accelerator.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAcceleratorResult	updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest) Update an accelerator.
UpdateAcceleratorAttributesResult	updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest) Update the attributes for an accelerator.
UpdateEndpointGroupResult	updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest) Update an endpoint group.
UpdateListenerResult	updateListener(UpdateListenerRequest updateListenerRequest) Update a listener.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAccelerator

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. To see an AWS CLI example of creating an accelerator, scroll down to Example.

Parameters:

createAcceleratorRequest -

Returns:

Result of the CreateAccelerator operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createEndpointGroup

CreateEndpointGroupResult createEndpointGroup(CreateEndpointGroupRequest createEndpointGroupRequest)

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

Parameters:

createEndpointGroupRequest -

Returns:

Result of the CreateEndpointGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createListener

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. To see an AWS CLI example of creating a listener, scroll down to Example.

Parameters:

createListenerRequest -

Returns:

Result of the CreateListener operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAccelerator

DeleteAcceleratorResult deleteAccelerator(DeleteAcceleratorRequest deleteAcceleratorRequest)

Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).

Parameters:

deleteAcceleratorRequest -

Returns:

Result of the DeleteAccelerator operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteEndpointGroup

DeleteEndpointGroupResult deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest)

Delete an endpoint group from a listener.

Parameters:

deleteEndpointGroupRequest -

Returns:

Result of the DeleteEndpointGroup operation returned by the service.

Throws:

EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.

InternalServiceErrorException - There was an internal error for AWS Global Accelerator.

See Also:

AWS API Documentation

deleteListener

DeleteListenerResult deleteListener(DeleteListenerRequest deleteListenerRequest)

Delete a listener from an accelerator.

Parameters:

deleteListenerRequest -

Returns:

Result of the DeleteListener operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeAccelerator

DescribeAcceleratorResult describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest)

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

Parameters:

describeAcceleratorRequest -

Returns:

Result of the DescribeAccelerator operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeAcceleratorAttributes

DescribeAcceleratorAttributesResult describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest)

Describe the attributes of an accelerator.

Parameters:

describeAcceleratorAttributesRequest -

Returns:

Result of the DescribeAcceleratorAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeEndpointGroup

DescribeEndpointGroupResult describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest)

Describe an endpoint group.

Parameters:

describeEndpointGroupRequest -

Returns:

Result of the DescribeEndpointGroup operation returned by the service.

Throws:

EndpointGroupNotFoundException - The endpoint group that you specified doesn't exist.

InternalServiceErrorException - There was an internal error for AWS Global Accelerator.

See Also:

AWS API Documentation

describeListener

DescribeListenerResult describeListener(DescribeListenerRequest describeListenerRequest)

Describe a listener.

Parameters:

describeListenerRequest -

Returns:

Result of the DescribeListener operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAccelerators

ListAcceleratorsResult listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest)

List the accelerators for an AWS account.

Parameters:

listAcceleratorsRequest -

Returns:

Result of the ListAccelerators operation returned by the service.

Throws:

InvalidNextTokenException - There isn't another item to return.

InternalServiceErrorException - There was an internal error for AWS Global Accelerator.

See Also:

AWS API Documentation

listEndpointGroups

ListEndpointGroupsResult listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest)

List the endpoint groups that are associated with a listener.

Parameters:

listEndpointGroupsRequest -

Returns:

Result of the ListEndpointGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listListeners

ListListenersResult listListeners(ListListenersRequest listListenersRequest)

List the listeners for an accelerator.

Parameters:

listListenersRequest -

Returns:

Result of the ListListeners operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateAccelerator

UpdateAcceleratorResult updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest)

Update an accelerator.

Parameters:

updateAcceleratorRequest -

Returns:

Result of the UpdateAccelerator operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateAcceleratorAttributes

UpdateAcceleratorAttributesResult updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest)

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.

Parameters:

updateAcceleratorAttributesRequest -

Returns:

Result of the UpdateAcceleratorAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateEndpointGroup

UpdateEndpointGroupResult updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest)

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.

Parameters:

updateEndpointGroupRequest -

Returns:

Result of the UpdateEndpointGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateListener

UpdateListenerResult updateListener(UpdateListenerRequest updateListenerRequest)

Update a listener.

Parameters:

updateListenerRequest -

Returns:

Result of the UpdateListener operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.