2020/12/09 - AWS Global Accelerator - 22 new api methods
Changes This release adds support for custom routing accelerators
Describe an endpoint group for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.describe_custom_routing_endpoint_group(
EndpointGroupArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to describe.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'DestinationDescriptions': [
{
'FromPort': 123,
'ToPort': 123,
'Protocols': [
'TCP'|'UDP',
]
},
],
'EndpointDescriptions': [
{
'EndpointId': 'string'
},
]
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The description of an endpoint group for a custom routing accelerator.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
DestinationDescriptions (list) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
FromPort (integer) --
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
ToPort (integer) --
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Protocols (list) --
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
(string) --
EndpointDescriptions (list) --
For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
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.
Warning
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 .
See also: AWS API Documentation
Request Syntax
client.delete_custom_routing_accelerator(
AcceleratorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the custom routing accelerator to delete.
None
Update the attributes for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.update_custom_routing_accelerator_attributes(
AcceleratorArn='string',
FlowLogsEnabled=True|False,
FlowLogsS3Bucket='string',
FlowLogsS3Prefix='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
boolean
Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .
string
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
string
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
dict
Response Syntax
{
'AcceleratorAttributes': {
'FlowLogsEnabled': True|False,
'FlowLogsS3Bucket': 'string',
'FlowLogsS3Prefix': 'string'
}
}
Response Structure
(dict) --
AcceleratorAttributes (dict) --
Updated custom routing accelerator.
FlowLogsEnabled (boolean) --
Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .
FlowLogsS3Bucket (string) --
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix (string) --
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
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.
See also: AWS API Documentation
Request Syntax
client.list_custom_routing_port_mappings_by_destination(
EndpointId='string',
DestinationAddress='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID for the virtual private cloud (VPC) subnet.
string
[REQUIRED]
The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
integer
The number of destination port mappings that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'DestinationPortMappings': [
{
'AcceleratorArn': 'string',
'AcceleratorSocketAddresses': [
{
'IpAddress': 'string',
'Port': 123
},
],
'EndpointGroupArn': 'string',
'EndpointId': 'string',
'EndpointGroupRegion': 'string',
'DestinationSocketAddress': {
'IpAddress': 'string',
'Port': 123
},
'IpAddressType': 'IPV4',
'DestinationTrafficState': 'ALLOW'|'DENY'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DestinationPortMappings (list) --
The port mappings for the endpoint IP address that you specified in the request.
(dict) --
The port mappings for a specified endpoint IP address (destination).
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
AcceleratorSocketAddresses (list) --
The IP address/port combinations (sockets) that map to a given destination socket address.
(dict) --
An IP address/port combination.
IpAddress (string) --
The IP address for the socket address.
Port (integer) --
The port for the socket address.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointId (string) --
The ID for the virtual private cloud (VPC) subnet.
EndpointGroupRegion (string) --
The AWS Region for the endpoint group.
DestinationSocketAddress (dict) --
The endpoint IP address/port combination for traffic received on the accelerator socket address.
IpAddress (string) --
The IP address for the socket address.
Port (integer) --
The port for the socket address.
IpAddressType (string) --
The IP address type, which must be IPv4.
DestinationTrafficState (string) --
Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
The description of a listener for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.describe_custom_routing_listener(
ListenerArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to describe.
dict
Response Syntax
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
]
}
}
Response Structure
(dict) --
Listener (dict) --
The description of a listener for a custom routing accelerator.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
List the endpoint groups that are associated with a listener for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.list_custom_routing_endpoint_groups(
ListenerArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
integer
The number of endpoint group objects that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'EndpointGroups': [
{
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'DestinationDescriptions': [
{
'FromPort': 123,
'ToPort': 123,
'Protocols': [
'TCP'|'UDP',
]
},
],
'EndpointDescriptions': [
{
'EndpointId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EndpointGroups (list) --
The list of the endpoint groups associated with a listener for a custom routing accelerator.
(dict) --
A complex type for the endpoint group for a custom routing accelerator. An AWS Region can have only one endpoint group for a specific listener.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
DestinationDescriptions (list) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
FromPort (integer) --
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
ToPort (integer) --
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Protocols (list) --
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
(string) --
EndpointDescriptions (list) --
For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
Remove endpoints from a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.remove_custom_routing_endpoints(
EndpointIds=[
'string',
],
EndpointGroupArn='string'
)
list
[REQUIRED]
The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
None
List the listeners for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.list_custom_routing_listeners(
AcceleratorArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to list listeners for.
integer
The number of listener objects that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Listeners (list) --
The list of listeners for a custom routing accelerator.
(dict) --
A complex type for a listener for a custom routing accelerator.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
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.
See also: AWS API Documentation
Request Syntax
client.create_custom_routing_listener(
AcceleratorArn='string',
PortRanges=[
{
'FromPort': 123,
'ToPort': 123
},
],
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
list
[REQUIRED]
The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
]
}
}
Response Structure
(dict) --
Listener (dict) --
The listener that you've created for a custom routing accelerator.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
Update a listener for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.update_custom_routing_listener(
ListenerArn='string',
PortRanges=[
{
'FromPort': 123,
'ToPort': 123
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to update.
list
[REQUIRED]
The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
dict
Response Syntax
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
]
}
}
Response Structure
(dict) --
Listener (dict) --
Information for the updated listener for a custom routing accelerator.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
Delete a listener for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.delete_custom_routing_listener(
ListenerArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to delete.
None
Describe the attributes of a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.describe_custom_routing_accelerator_attributes(
AcceleratorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.
dict
Response Syntax
{
'AcceleratorAttributes': {
'FlowLogsEnabled': True|False,
'FlowLogsS3Bucket': 'string',
'FlowLogsS3Prefix': 'string'
}
}
Response Structure
(dict) --
AcceleratorAttributes (dict) --
The attributes of the custom routing accelerator.
FlowLogsEnabled (boolean) --
Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .
FlowLogsS3Bucket (string) --
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix (string) --
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
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.
See also: AWS API Documentation
Request Syntax
client.create_custom_routing_endpoint_group(
ListenerArn='string',
EndpointGroupRegion='string',
DestinationConfigurations=[
{
'FromPort': 123,
'ToPort': 123,
'Protocols': [
'TCP'|'UDP',
]
},
],
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
string
[REQUIRED]
The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
list
[REQUIRED]
Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
(dict) --
For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
FromPort (integer) -- [REQUIRED]
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
ToPort (integer) -- [REQUIRED]
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Protocols (list) -- [REQUIRED]
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
(string) --
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'DestinationDescriptions': [
{
'FromPort': 123,
'ToPort': 123,
'Protocols': [
'TCP'|'UDP',
]
},
],
'EndpointDescriptions': [
{
'EndpointId': 'string'
},
]
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The information about the endpoint group created for a custom routing accelerator.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
DestinationDescriptions (list) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
FromPort (integer) --
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
ToPort (integer) --
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Protocols (list) --
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
(string) --
EndpointDescriptions (list) --
For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
(dict) --
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
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.
See also: AWS API Documentation
Request Syntax
client.deny_custom_routing_traffic(
EndpointGroupArn='string',
EndpointId='string',
DestinationAddresses=[
'string',
],
DestinationPorts=[
123,
],
DenyAllTrafficToEndpoint=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group.
string
[REQUIRED]
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
list
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.
(string) --
list
A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.
(integer) --
boolean
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
None
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.
See also: AWS API Documentation
Request Syntax
client.allow_custom_routing_traffic(
EndpointGroupArn='string',
EndpointId='string',
DestinationAddresses=[
'string',
],
DestinationPorts=[
123,
],
AllowAllTrafficToEndpoint=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group.
string
[REQUIRED]
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
list
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.
(string) --
list
A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
(integer) --
boolean
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
None
Delete an endpoint group from a listener for a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.delete_custom_routing_endpoint_group(
EndpointGroupArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to delete.
None
List the custom routing accelerators for an AWS account.
See also: AWS API Documentation
Request Syntax
client.list_custom_routing_accelerators(
MaxResults=123,
NextToken='string'
)
integer
The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'Accelerators': [
{
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'DnsName': 'string',
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accelerators (list) --
The list of custom routing accelerators for a customer account.
(dict) --
Attributes of a custom routing accelerator.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the custom routing accelerator.
Name (string) --
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
The static IP addresses that Global Accelerator associates with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
(string) --
DnsName (string) --
The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
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.
See also: AWS API Documentation
Request Syntax
client.add_custom_routing_endpoints(
EndpointConfigurations=[
{
'EndpointId': 'string'
},
],
EndpointGroupArn='string'
)
list
[REQUIRED]
The list of endpoint objects to add to a custom routing accelerator.
(dict) --
The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
dict
Response Syntax
{
'EndpointDescriptions': [
{
'EndpointId': 'string'
},
],
'EndpointGroupArn': 'string'
}
Response Structure
(dict) --
EndpointDescriptions (list) --
The endpoint objects added to the custom routing accelerator.
(dict) --
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
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.
See also: AWS API Documentation
Request Syntax
client.create_custom_routing_accelerator(
Name='string',
IpAddressType='IPV4',
Enabled=True|False,
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
string
The value for the address type must be IPv4.
boolean
Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
This field is autopopulated if not provided.
list
Create tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .
(dict) --
A complex type that contains a Tag key and Tag value.
Key (string) -- [REQUIRED]
A string that contains a Tag key.
Value (string) -- [REQUIRED]
A string that contains a Tag value.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'DnsName': 'string',
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Accelerator (dict) --
The accelerator that is created.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the custom routing accelerator.
Name (string) --
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
The static IP addresses that Global Accelerator associates with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
(string) --
DnsName (string) --
The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
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.
See also: AWS API Documentation
Request Syntax
client.list_custom_routing_port_mappings(
AcceleratorArn='string',
EndpointGroupArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
string
The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
integer
The number of destination port mappings that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'PortMappings': [
{
'AcceleratorPort': 123,
'EndpointGroupArn': 'string',
'EndpointId': 'string',
'DestinationSocketAddress': {
'IpAddress': 'string',
'Port': 123
},
'Protocols': [
'TCP'|'UDP',
],
'DestinationTrafficState': 'ALLOW'|'DENY'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PortMappings (list) --
The port mappings for a custom routing accelerator.
(dict) --
Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in AWS Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.
AcceleratorPort (integer) --
The accelerator port.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointId (string) --
The IP address of the VPC subnet (the subnet ID).
DestinationSocketAddress (dict) --
The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
IpAddress (string) --
The IP address for the socket address.
Port (integer) --
The port for the socket address.
Protocols (list) --
The protocols supported by the endpoint group.
(string) --
DestinationTrafficState (string) --
Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
Update a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.update_custom_routing_accelerator(
AcceleratorArn='string',
Name='string',
IpAddressType='IPV4',
Enabled=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to update.
string
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
string
The value for the address type must be IPv4.
boolean
Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'DnsName': 'string',
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Accelerator (dict) --
Information about the updated custom routing accelerator.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the custom routing accelerator.
Name (string) --
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
The static IP addresses that Global Accelerator associates with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
(string) --
DnsName (string) --
The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
Describe a custom routing accelerator.
See also: AWS API Documentation
Request Syntax
client.describe_custom_routing_accelerator(
AcceleratorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to describe.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'DnsName': 'string',
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Accelerator (dict) --
The description of the custom routing accelerator.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the custom routing accelerator.
Name (string) --
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
The static IP addresses that Global Accelerator associates with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
(string) --
DnsName (string) --
The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.