@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSGlobalAccelerator extends Object implements AWSGlobalAccelerator
AWSGlobalAccelerator
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public AddCustomRoutingEndpointsResult addCustomRoutingEndpoints(AddCustomRoutingEndpointsRequest request)
AWSGlobalAccelerator
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.
addCustomRoutingEndpoints
in interface AWSGlobalAccelerator
public AdvertiseByoipCidrResult advertiseByoipCidr(AdvertiseByoipCidrRequest request)
AWSGlobalAccelerator
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.
advertiseByoipCidr
in interface AWSGlobalAccelerator
public AllowCustomRoutingTrafficResult allowCustomRoutingTraffic(AllowCustomRoutingTrafficRequest request)
AWSGlobalAccelerator
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.
allowCustomRoutingTraffic
in interface AWSGlobalAccelerator
public CreateAcceleratorResult createAccelerator(CreateAcceleratorRequest request)
AWSGlobalAccelerator
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.
createAccelerator
in interface AWSGlobalAccelerator
public CreateCustomRoutingAcceleratorResult createCustomRoutingAccelerator(CreateCustomRoutingAcceleratorRequest request)
AWSGlobalAccelerator
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.
createCustomRoutingAccelerator
in interface AWSGlobalAccelerator
public CreateCustomRoutingEndpointGroupResult createCustomRoutingEndpointGroup(CreateCustomRoutingEndpointGroupRequest request)
AWSGlobalAccelerator
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.
createCustomRoutingEndpointGroup
in interface AWSGlobalAccelerator
public CreateCustomRoutingListenerResult createCustomRoutingListener(CreateCustomRoutingListenerRequest request)
AWSGlobalAccelerator
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.
createCustomRoutingListener
in interface AWSGlobalAccelerator
public CreateEndpointGroupResult createEndpointGroup(CreateEndpointGroupRequest request)
AWSGlobalAccelerator
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.
createEndpointGroup
in interface AWSGlobalAccelerator
public CreateListenerResult createListener(CreateListenerRequest request)
AWSGlobalAccelerator
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.
createListener
in interface AWSGlobalAccelerator
public DeleteAcceleratorResult deleteAccelerator(DeleteAcceleratorRequest request)
AWSGlobalAccelerator
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.
deleteAccelerator
in interface AWSGlobalAccelerator
public DeleteCustomRoutingAcceleratorResult deleteCustomRoutingAccelerator(DeleteCustomRoutingAcceleratorRequest request)
AWSGlobalAccelerator
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.
deleteCustomRoutingAccelerator
in interface AWSGlobalAccelerator
public DeleteCustomRoutingEndpointGroupResult deleteCustomRoutingEndpointGroup(DeleteCustomRoutingEndpointGroupRequest request)
AWSGlobalAccelerator
Delete an endpoint group from a listener for a custom routing accelerator.
deleteCustomRoutingEndpointGroup
in interface AWSGlobalAccelerator
public DeleteCustomRoutingListenerResult deleteCustomRoutingListener(DeleteCustomRoutingListenerRequest request)
AWSGlobalAccelerator
Delete a listener for a custom routing accelerator.
deleteCustomRoutingListener
in interface AWSGlobalAccelerator
public DeleteEndpointGroupResult deleteEndpointGroup(DeleteEndpointGroupRequest request)
AWSGlobalAccelerator
Delete an endpoint group from a listener.
deleteEndpointGroup
in interface AWSGlobalAccelerator
public DeleteListenerResult deleteListener(DeleteListenerRequest request)
AWSGlobalAccelerator
Delete a listener from an accelerator.
deleteListener
in interface AWSGlobalAccelerator
public DenyCustomRoutingTrafficResult denyCustomRoutingTraffic(DenyCustomRoutingTrafficRequest request)
AWSGlobalAccelerator
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.
denyCustomRoutingTraffic
in interface AWSGlobalAccelerator
public DeprovisionByoipCidrResult deprovisionByoipCidr(DeprovisionByoipCidrRequest request)
AWSGlobalAccelerator
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.
deprovisionByoipCidr
in interface AWSGlobalAccelerator
public DescribeAcceleratorResult describeAccelerator(DescribeAcceleratorRequest request)
AWSGlobalAccelerator
Describe an accelerator.
describeAccelerator
in interface AWSGlobalAccelerator
public DescribeAcceleratorAttributesResult describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest request)
AWSGlobalAccelerator
Describe the attributes of an accelerator.
describeAcceleratorAttributes
in interface AWSGlobalAccelerator
public DescribeCustomRoutingAcceleratorResult describeCustomRoutingAccelerator(DescribeCustomRoutingAcceleratorRequest request)
AWSGlobalAccelerator
Describe a custom routing accelerator.
describeCustomRoutingAccelerator
in interface AWSGlobalAccelerator
public DescribeCustomRoutingAcceleratorAttributesResult describeCustomRoutingAcceleratorAttributes(DescribeCustomRoutingAcceleratorAttributesRequest request)
AWSGlobalAccelerator
Describe the attributes of a custom routing accelerator.
describeCustomRoutingAcceleratorAttributes
in interface AWSGlobalAccelerator
public DescribeCustomRoutingEndpointGroupResult describeCustomRoutingEndpointGroup(DescribeCustomRoutingEndpointGroupRequest request)
AWSGlobalAccelerator
Describe an endpoint group for a custom routing accelerator.
describeCustomRoutingEndpointGroup
in interface AWSGlobalAccelerator
public DescribeCustomRoutingListenerResult describeCustomRoutingListener(DescribeCustomRoutingListenerRequest request)
AWSGlobalAccelerator
The description of a listener for a custom routing accelerator.
describeCustomRoutingListener
in interface AWSGlobalAccelerator
public DescribeEndpointGroupResult describeEndpointGroup(DescribeEndpointGroupRequest request)
AWSGlobalAccelerator
Describe an endpoint group.
describeEndpointGroup
in interface AWSGlobalAccelerator
public DescribeListenerResult describeListener(DescribeListenerRequest request)
AWSGlobalAccelerator
Describe a listener.
describeListener
in interface AWSGlobalAccelerator
public ListAcceleratorsResult listAccelerators(ListAcceleratorsRequest request)
AWSGlobalAccelerator
List the accelerators for an AWS account.
listAccelerators
in interface AWSGlobalAccelerator
public ListByoipCidrsResult listByoipCidrs(ListByoipCidrsRequest request)
AWSGlobalAccelerator
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
listByoipCidrs
in interface AWSGlobalAccelerator
public ListCustomRoutingAcceleratorsResult listCustomRoutingAccelerators(ListCustomRoutingAcceleratorsRequest request)
AWSGlobalAccelerator
List the custom routing accelerators for an AWS account.
listCustomRoutingAccelerators
in interface AWSGlobalAccelerator
public ListCustomRoutingEndpointGroupsResult listCustomRoutingEndpointGroups(ListCustomRoutingEndpointGroupsRequest request)
AWSGlobalAccelerator
List the endpoint groups that are associated with a listener for a custom routing accelerator.
listCustomRoutingEndpointGroups
in interface AWSGlobalAccelerator
public ListCustomRoutingListenersResult listCustomRoutingListeners(ListCustomRoutingListenersRequest request)
AWSGlobalAccelerator
List the listeners for a custom routing accelerator.
listCustomRoutingListeners
in interface AWSGlobalAccelerator
public ListCustomRoutingPortMappingsResult listCustomRoutingPortMappings(ListCustomRoutingPortMappingsRequest request)
AWSGlobalAccelerator
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.
listCustomRoutingPortMappings
in interface AWSGlobalAccelerator
public ListCustomRoutingPortMappingsByDestinationResult listCustomRoutingPortMappingsByDestination(ListCustomRoutingPortMappingsByDestinationRequest request)
AWSGlobalAccelerator
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.
listCustomRoutingPortMappingsByDestination
in interface AWSGlobalAccelerator
public ListEndpointGroupsResult listEndpointGroups(ListEndpointGroupsRequest request)
AWSGlobalAccelerator
List the endpoint groups that are associated with a listener.
listEndpointGroups
in interface AWSGlobalAccelerator
public ListListenersResult listListeners(ListListenersRequest request)
AWSGlobalAccelerator
List the listeners for an accelerator.
listListeners
in interface AWSGlobalAccelerator
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSGlobalAccelerator
List all tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
listTagsForResource
in interface AWSGlobalAccelerator
public ProvisionByoipCidrResult provisionByoipCidr(ProvisionByoipCidrRequest request)
AWSGlobalAccelerator
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.
provisionByoipCidr
in interface AWSGlobalAccelerator
public RemoveCustomRoutingEndpointsResult removeCustomRoutingEndpoints(RemoveCustomRoutingEndpointsRequest request)
AWSGlobalAccelerator
Remove endpoints from a custom routing accelerator.
removeCustomRoutingEndpoints
in interface AWSGlobalAccelerator
public TagResourceResult tagResource(TagResourceRequest request)
AWSGlobalAccelerator
Add tags to an accelerator resource.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
tagResource
in interface AWSGlobalAccelerator
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSGlobalAccelerator
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.
untagResource
in interface AWSGlobalAccelerator
public UpdateAcceleratorResult updateAccelerator(UpdateAcceleratorRequest request)
AWSGlobalAccelerator
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.
updateAccelerator
in interface AWSGlobalAccelerator
public UpdateAcceleratorAttributesResult updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest request)
AWSGlobalAccelerator
Update the attributes for an accelerator.
updateAcceleratorAttributes
in interface AWSGlobalAccelerator
public UpdateCustomRoutingAcceleratorResult updateCustomRoutingAccelerator(UpdateCustomRoutingAcceleratorRequest request)
AWSGlobalAccelerator
Update a custom routing accelerator.
updateCustomRoutingAccelerator
in interface AWSGlobalAccelerator
public UpdateCustomRoutingAcceleratorAttributesResult updateCustomRoutingAcceleratorAttributes(UpdateCustomRoutingAcceleratorAttributesRequest request)
AWSGlobalAccelerator
Update the attributes for a custom routing accelerator.
updateCustomRoutingAcceleratorAttributes
in interface AWSGlobalAccelerator
public UpdateCustomRoutingListenerResult updateCustomRoutingListener(UpdateCustomRoutingListenerRequest request)
AWSGlobalAccelerator
Update a listener for a custom routing accelerator.
updateCustomRoutingListener
in interface AWSGlobalAccelerator
public UpdateEndpointGroupResult updateEndpointGroup(UpdateEndpointGroupRequest request)
AWSGlobalAccelerator
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
updateEndpointGroup
in interface AWSGlobalAccelerator
public UpdateListenerResult updateListener(UpdateListenerRequest request)
AWSGlobalAccelerator
Update a listener.
updateListener
in interface AWSGlobalAccelerator
public WithdrawByoipCidrResult withdrawByoipCidr(WithdrawByoipCidrRequest request)
AWSGlobalAccelerator
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.
withdrawByoipCidr
in interface AWSGlobalAccelerator
public void shutdown()
AWSGlobalAccelerator
shutdown
in interface AWSGlobalAccelerator
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSGlobalAccelerator
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.
getCachedResponseMetadata
in interface AWSGlobalAccelerator
request
- The originally executed request.