@Generated(value="software.amazon.awssdk:codegen") public interface GlobalAcceleratorAsyncClient extends SdkClient
builder() method.
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.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
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:
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.
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.
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.
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.
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.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static GlobalAcceleratorAsyncClient create()
GlobalAcceleratorAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GlobalAcceleratorAsyncClientBuilder builder()
GlobalAcceleratorAsyncClient.default CompletableFuture<CreateAcceleratorResponse> 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.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
createAcceleratorRequest - default CompletableFuture<CreateAcceleratorResponse> createAccelerator(Consumer<CreateAcceleratorRequest.Builder> 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.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
This is a convenience which creates an instance of the CreateAcceleratorRequest.Builder avoiding the need
to create one manually via CreateAcceleratorRequest.builder()
createAcceleratorRequest - A Consumer that will call methods on CreateAcceleratorRequest.Builder to create a request.default CompletableFuture<CreateEndpointGroupResponse> 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.
createEndpointGroupRequest - default CompletableFuture<CreateEndpointGroupResponse> createEndpointGroup(Consumer<CreateEndpointGroupRequest.Builder> 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.
This is a convenience which creates an instance of the CreateEndpointGroupRequest.Builder avoiding the
need to create one manually via CreateEndpointGroupRequest.builder()
createEndpointGroupRequest - A Consumer that will call methods on CreateEndpointGroupRequest.Builder to create a
request.default CompletableFuture<CreateListenerResponse> 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.
createListenerRequest - default CompletableFuture<CreateListenerResponse> createListener(Consumer<CreateListenerRequest.Builder> 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.
This is a convenience which creates an instance of the CreateListenerRequest.Builder avoiding the need to
create one manually via CreateListenerRequest.builder()
createListenerRequest - A Consumer that will call methods on CreateListenerRequest.Builder to create a request.default CompletableFuture<DeleteAcceleratorResponse> 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).
deleteAcceleratorRequest - default CompletableFuture<DeleteAcceleratorResponse> deleteAccelerator(Consumer<DeleteAcceleratorRequest.Builder> deleteAcceleratorRequest)
Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).
This is a convenience which creates an instance of the DeleteAcceleratorRequest.Builder avoiding the need
to create one manually via DeleteAcceleratorRequest.builder()
deleteAcceleratorRequest - A Consumer that will call methods on DeleteAcceleratorRequest.Builder to create a request.default CompletableFuture<DeleteEndpointGroupResponse> deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest)
Delete an endpoint group from a listener.
deleteEndpointGroupRequest - default CompletableFuture<DeleteEndpointGroupResponse> deleteEndpointGroup(Consumer<DeleteEndpointGroupRequest.Builder> deleteEndpointGroupRequest)
Delete an endpoint group from a listener.
This is a convenience which creates an instance of the DeleteEndpointGroupRequest.Builder avoiding the
need to create one manually via DeleteEndpointGroupRequest.builder()
deleteEndpointGroupRequest - A Consumer that will call methods on DeleteEndpointGroupRequest.Builder to create a
request.default CompletableFuture<DeleteListenerResponse> deleteListener(DeleteListenerRequest deleteListenerRequest)
Delete a listener from an accelerator.
deleteListenerRequest - default CompletableFuture<DeleteListenerResponse> deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest)
Delete a listener from an accelerator.
This is a convenience which creates an instance of the DeleteListenerRequest.Builder avoiding the need to
create one manually via DeleteListenerRequest.builder()
deleteListenerRequest - A Consumer that will call methods on DeleteListenerRequest.Builder to create a request.default CompletableFuture<DescribeAcceleratorResponse> describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest)
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.
describeAcceleratorRequest - default CompletableFuture<DescribeAcceleratorResponse> describeAccelerator(Consumer<DescribeAcceleratorRequest.Builder> describeAcceleratorRequest)
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.
This is a convenience which creates an instance of the DescribeAcceleratorRequest.Builder avoiding the
need to create one manually via DescribeAcceleratorRequest.builder()
describeAcceleratorRequest - A Consumer that will call methods on DescribeAcceleratorRequest.Builder to create a
request.default CompletableFuture<DescribeAcceleratorAttributesResponse> describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest)
Describe the attributes of an accelerator.
describeAcceleratorAttributesRequest - default CompletableFuture<DescribeAcceleratorAttributesResponse> describeAcceleratorAttributes(Consumer<DescribeAcceleratorAttributesRequest.Builder> describeAcceleratorAttributesRequest)
Describe the attributes of an accelerator.
This is a convenience which creates an instance of the DescribeAcceleratorAttributesRequest.Builder
avoiding the need to create one manually via DescribeAcceleratorAttributesRequest.builder()
describeAcceleratorAttributesRequest - A Consumer that will call methods on DescribeAcceleratorAttributesRequest.Builder to
create a request.default CompletableFuture<DescribeEndpointGroupResponse> describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest)
Describe an endpoint group.
describeEndpointGroupRequest - default CompletableFuture<DescribeEndpointGroupResponse> describeEndpointGroup(Consumer<DescribeEndpointGroupRequest.Builder> describeEndpointGroupRequest)
Describe an endpoint group.
This is a convenience which creates an instance of the DescribeEndpointGroupRequest.Builder avoiding the
need to create one manually via DescribeEndpointGroupRequest.builder()
describeEndpointGroupRequest - A Consumer that will call methods on DescribeEndpointGroupRequest.Builder to create a
request.default CompletableFuture<DescribeListenerResponse> describeListener(DescribeListenerRequest describeListenerRequest)
Describe a listener.
describeListenerRequest - default CompletableFuture<DescribeListenerResponse> describeListener(Consumer<DescribeListenerRequest.Builder> describeListenerRequest)
Describe a listener.
This is a convenience which creates an instance of the DescribeListenerRequest.Builder avoiding the need
to create one manually via DescribeListenerRequest.builder()
describeListenerRequest - A Consumer that will call methods on DescribeListenerRequest.Builder to create a request.default CompletableFuture<ListAcceleratorsResponse> listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest)
List the accelerators for an AWS account.
listAcceleratorsRequest - default CompletableFuture<ListAcceleratorsResponse> listAccelerators(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest)
List the accelerators for an AWS account.
This is a convenience which creates an instance of the ListAcceleratorsRequest.Builder avoiding the need
to create one manually via ListAcceleratorsRequest.builder()
listAcceleratorsRequest - A Consumer that will call methods on ListAcceleratorsRequest.Builder to create a request.default CompletableFuture<ListAcceleratorsResponse> listAccelerators()
List the accelerators for an AWS account.
default CompletableFuture<ListEndpointGroupsResponse> listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest)
List the endpoint groups that are associated with a listener.
listEndpointGroupsRequest - default CompletableFuture<ListEndpointGroupsResponse> listEndpointGroups(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest)
List the endpoint groups that are associated with a listener.
This is a convenience which creates an instance of the ListEndpointGroupsRequest.Builder avoiding the
need to create one manually via ListEndpointGroupsRequest.builder()
listEndpointGroupsRequest - A Consumer that will call methods on ListEndpointGroupsRequest.Builder to create a
request.default CompletableFuture<ListListenersResponse> listListeners(ListListenersRequest listListenersRequest)
List the listeners for an accelerator.
listListenersRequest - default CompletableFuture<ListListenersResponse> listListeners(Consumer<ListListenersRequest.Builder> listListenersRequest)
List the listeners for an accelerator.
This is a convenience which creates an instance of the ListListenersRequest.Builder avoiding the need to
create one manually via ListListenersRequest.builder()
listListenersRequest - A Consumer that will call methods on ListListenersRequest.Builder to create a request.default CompletableFuture<UpdateAcceleratorResponse> updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest)
Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
updateAcceleratorRequest - default CompletableFuture<UpdateAcceleratorResponse> updateAccelerator(Consumer<UpdateAcceleratorRequest.Builder> updateAcceleratorRequest)
Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
This is a convenience which creates an instance of the UpdateAcceleratorRequest.Builder avoiding the need
to create one manually via UpdateAcceleratorRequest.builder()
updateAcceleratorRequest - A Consumer that will call methods on UpdateAcceleratorRequest.Builder to create a request.default CompletableFuture<UpdateAcceleratorAttributesResponse> 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.
updateAcceleratorAttributesRequest - default CompletableFuture<UpdateAcceleratorAttributesResponse> updateAcceleratorAttributes(Consumer<UpdateAcceleratorAttributesRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateAcceleratorAttributesRequest.Builder
avoiding the need to create one manually via UpdateAcceleratorAttributesRequest.builder()
updateAcceleratorAttributesRequest - A Consumer that will call methods on UpdateAcceleratorAttributesRequest.Builder to create
a request.default CompletableFuture<UpdateEndpointGroupResponse> updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest)
Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.
updateEndpointGroupRequest - default CompletableFuture<UpdateEndpointGroupResponse> updateEndpointGroup(Consumer<UpdateEndpointGroupRequest.Builder> updateEndpointGroupRequest)
Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.
This is a convenience which creates an instance of the UpdateEndpointGroupRequest.Builder avoiding the
need to create one manually via UpdateEndpointGroupRequest.builder()
updateEndpointGroupRequest - A Consumer that will call methods on UpdateEndpointGroupRequest.Builder to create a
request.default CompletableFuture<UpdateListenerResponse> updateListener(UpdateListenerRequest updateListenerRequest)
Update a listener.
updateListenerRequest - default CompletableFuture<UpdateListenerResponse> updateListener(Consumer<UpdateListenerRequest.Builder> updateListenerRequest)
Update a listener.
This is a convenience which creates an instance of the UpdateListenerRequest.Builder avoiding the need to
create one manually via UpdateListenerRequest.builder()
updateListenerRequest - A Consumer that will call methods on UpdateListenerRequest.Builder to create a request.Copyright © 2019 Amazon Web Services, Inc. All Rights Reserved.