EndpointConfiguration
A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
Contents
ClientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
Type: Boolean Required: No EndpointId
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.
An Application Load Balancer can be either internal or internet-facing.
Type: String
Length Constraints: Maximum length of 255.
Required: No Weight
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 169
EndpointDescription
EndpointDescription
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
Contents
ClientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
Type: Boolean Required: No EndpointId
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Type: String
Length Constraints: Maximum length of 255.
Required: No HealthReason
Returns a null result.
Type: String
Length Constraints: Maximum length of 255.
Required: No HealthState
The health status of the endpoint.
Type: String
Valid Values: INITIAL | HEALTHY | UNHEALTHY Required: No
Weight
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on
average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 171
EndpointGroup
EndpointGroup
A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
Contents
EndpointDescriptions
The list of endpoint objects.
Type: Array of EndpointDescription (p. 170) objects Required: No
EndpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
Type: String
Length Constraints: Maximum length of 255.
Required: No EndpointGroupRegion
The AWS Region where the endpoint group is located.
Type: String
Length Constraints: Maximum length of 255.
Required: No
HealthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 30.
Required: No HealthCheckPath
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
Type: String
Length Constraints: Maximum length of 255.
Pattern: ^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$
Required: No HealthCheckPort
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No HealthCheckProtocol
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
Type: String
Valid Values: TCP | HTTP | HTTPS Required: No
PortOverrides
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
Type: Array of PortOverride (p. 180) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No ThresholdCount
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No TrafficDialPercentage
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The
percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-08-08 173
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
IpSet
A complex type for the set of IP addresses for an accelerator.
Contents
IpAddresses
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Length Constraints: Maximum length of 45.
Required: No IpFamily
The types of IP addresses included in this IP set.
Type: String
Length Constraints: Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 175
Listener
Listener
A complex type for a listener.
Contents
ClientAffinity
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties
—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Type: String
Valid Values: NONE | SOURCE_IP Required: No
ListenerArn
The Amazon Resource Name (ARN) of the listener.
Type: String
Length Constraints: Maximum length of 255.
Required: No PortRanges
The list of port ranges for the connections from clients to the accelerator.
Type: Array of PortRange (p. 181) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No Protocol
The protocol for the connections from clients to the accelerator.
Type: String
Valid Values: TCP | UDP Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 177
PortMapping
PortMapping
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.
Contents
AcceleratorPort
The accelerator port.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
DestinationSocketAddress
The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
Type: SocketAddress (p. 182) object Required: No
DestinationTrafficState
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.
Type: String
Valid Values: ALLOW | DENY Required: No
EndpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
Type: String
Length Constraints: Maximum length of 255.
Required: No EndpointId
The IP address of the VPC subnet (the subnet ID).
Type: String
Length Constraints: Maximum length of 255.
Required: No Protocols
The protocols supported by the endpoint group.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: TCP | UDP Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 179
PortOverride
PortOverride
Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
Contents
EndpointPort
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No ListenerPort
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PortRange
A complex type for a range of ports for a listener.
Contents
FromPort
The first port in the range of ports, inclusive.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No ToPort
The last port in the range of ports, inclusive.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 181
SocketAddress
SocketAddress
An IP address/port combination.
Contents
IpAddress
The IP address for the socket address.
Type: String
Length Constraints: Maximum length of 255.
Required: No Port
The port for the socket address.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Tag
A complex type that contains a Tag key and Tag value.
Contents
Key
A string that contains a Tag key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes Value
A string that contains a Tag value.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 183