String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator.
String name
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
String ipAddressType
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
Boolean enabled
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.
List<E> ipSets
The static IP addresses that Global Accelerator associates with the accelerator.
String dnsName
The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points
to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses
and two IPv6 addresses.
For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
String status
Describes the deployment status of the accelerator.
Date createdTime
The date and time that the accelerator was created.
Date lastModifiedTime
The date and time that the accelerator was last modified.
String dualStackDnsName
The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.
Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points
just to the static IPv4 addresses.
For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
List<E> events
A history of changes that you make to an accelerator in Global Accelerator.
Boolean flowLogsEnabled
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 Global Accelerator Developer Guide.
String flowLogsS3Bucket
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 Global Accelerator permission to
write to the bucket.
String flowLogsS3Prefix
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
String message
A string that contains an Event message describing changes or errors when you update an accelerator
in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
Date timestamp
A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
String cidr
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
ByoipCidr byoipCidr
Information about the address range.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointId
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
List<E> destinationAddresses
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.
List<E> destinationPorts
A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
Boolean allowAllTrafficToEndpoint
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.
String attachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment.
String name
The name of the cross-account attachment.
List<E> principals
The principals included in the cross-account attachment.
List<E> resources
The resources included in the cross-account attachment.
Date lastModifiedTime
The date and time that the cross-account attachment was last modified.
Date createdTime
The date and time that the cross-account attachment was created.
String cidr
The address range, in CIDR notation.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
String state
The state of the address pool.
List<E> events
A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
String message
A string that contains an Event message describing changes that you make in the status of an IP
address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
Date timestamp
A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
String name
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
String ipAddressType
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
List<E> ipAddresses
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
Boolean enabled
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 idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
List<E> tags
Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
Accelerator accelerator
The accelerator that is created by specifying a listener and the supported IP address types.
String name
The name of the cross-account attachment.
List<E> principals
The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.
List<E> resources
The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
List<E> tags
Add tags for a cross-account attachment.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
Attachment crossAccountAttachment
Information about the cross-account attachment.
String name
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 ipAddressType
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
List<E> ipAddresses
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
Boolean enabled
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 idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
List<E> tags
Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
CustomRoutingAccelerator accelerator
The accelerator that is created.
String listenerArn
The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
String endpointGroupRegion
The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
List<E> destinationConfigurations
Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
CustomRoutingEndpointGroup endpointGroup
The information about the endpoint group created for a custom routing accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
List<E> portRanges
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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
CustomRoutingListener listener
The listener that you've created for a custom routing accelerator.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String endpointGroupRegion
The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
List<E> endpointConfigurations
The list of endpoint objects.
Float trafficDialPercentage
The percentage of traffic to send to an Amazon Web Services 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.
Integer healthCheckPort
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
String healthCheckProtocol
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
String healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
Integer 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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
List<E> portOverrides
Override specific listener ports used to route traffic to endpoints that are part of this 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 Overriding listener ports in the Global Accelerator Developer Guide.
EndpointGroup endpointGroup
The information about the endpoint group that was created.
String acceleratorArn
The Amazon Resource Name (ARN) of your accelerator.
List<E> portRanges
The list of port ranges to support for connections from clients to your accelerator.
String protocol
The protocol for connections from clients to your accelerator.
String 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.
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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
Listener listener
The listener that you've created.
String endpointId
The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.
String cidr
An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
String attachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.
String acceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator.
String name
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
String ipAddressType
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
Boolean enabled
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.
List<E> ipSets
The static IP addresses that Global Accelerator associates with the accelerator.
String dnsName
The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.
If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points
to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses
and two IPv6 addresses.
For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
String status
Describes the deployment status of the accelerator.
Date createdTime
The date and time that the accelerator was created.
Date lastModifiedTime
The date and time that the accelerator was last modified.
Boolean flowLogsEnabled
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 Global Accelerator Developer Guide.
String flowLogsS3Bucket
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 Global Accelerator permission to
write to the bucket.
String flowLogsS3Prefix
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
Integer fromPort
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Integer toPort
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
List<E> protocols
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
Integer fromPort
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
Integer toPort
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
List<E> protocols
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
String endpointId
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
String attachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
String endpointId
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointGroupRegion
The Amazon Web Services Region where the endpoint group is located.
List<E> destinationDescriptions
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.
List<E> endpointDescriptions
For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
List<E> portRanges
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.
String acceleratorArn
The Amazon Resource Name (ARN) of an accelerator.
String attachmentArn
The Amazon Resource Name (ARN) for the cross-account attachment to delete.
String acceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator to delete.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to delete.
String listenerArn
The Amazon Resource Name (ARN) of the listener to delete.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to delete.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointId
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
List<E> destinationAddresses
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.
List<E> destinationPorts
A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.
Boolean denyAllTrafficToEndpoint
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.
String cidr
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
ByoipCidr byoipCidr
Information about the address range.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
AcceleratorAttributes acceleratorAttributes
The attributes of the accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to describe.
Accelerator accelerator
The description of the accelerator.
String attachmentArn
The Amazon Resource Name (ARN) for the cross-account attachment to describe.
Attachment crossAccountAttachment
Information about the cross-account attachment.
String acceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.
CustomRoutingAcceleratorAttributes acceleratorAttributes
The attributes of the custom routing accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to describe.
CustomRoutingAccelerator accelerator
The description of the custom routing accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to describe.
CustomRoutingEndpointGroup endpointGroup
The description of an endpoint group for a custom routing accelerator.
String listenerArn
The Amazon Resource Name (ARN) of the listener to describe.
CustomRoutingListener listener
The description of a listener for a custom routing accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to describe.
EndpointGroup endpointGroup
The description of an endpoint group.
String listenerArn
The Amazon Resource Name (ARN) of the listener to describe.
Listener listener
The description of a listener.
String acceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
List<E> acceleratorSocketAddresses
The IP address/port combinations (sockets) that map to a given destination socket address.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointId
The ID for the virtual private cloud (VPC) subnet.
String endpointGroupRegion
The Amazon Web Services Region for the endpoint group.
SocketAddress destinationSocketAddress
The endpoint IP address/port combination for traffic received on the accelerator socket address.
String ipAddressType
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
String 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.
String 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.
For cross-account endpoints, this must be the ARN of the resource.
Integer weight
The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.
Boolean clientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
String attachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
String 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.
Integer weight
The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.
String healthState
The health status of the endpoint.
String healthReason
Returns a null result.
Boolean clientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointGroupRegion
The Amazon Web Services Region where the endpoint group is located.
List<E> endpointDescriptions
The list of endpoint objects.
Float trafficDialPercentage
The percentage of traffic to send to an Amazon Web Services 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.
Integer 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.
String 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.
String 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 (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
Integer 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.
List<E> portOverrides
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you 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.
String 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.
Boolean clientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
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 endpoint fronted by the accelerator.
String ipFamily
IpFamily is deprecated and has been replaced by IpAddressFamily.
List<E> ipAddresses
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
String ipAddressFamily
The types of IP addresses included in this IP set.
String acceleratorArn
The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
String resourceOwnerAwsAccountId
The account ID of a resource owner in a cross-account attachment.
Integer maxResults
The number of cross-account resource objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String listenerArn
The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
Integer maxResults
The number of endpoint group objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to list listeners for.
Integer maxResults
The number of listener objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String endpointId
The ID for the virtual private cloud (VPC) subnet.
String destinationAddress
The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
Integer maxResults
The number of destination port mappings that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
Integer maxResults
The number of destination port mappings that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
Integer maxResults
The number of endpoint group objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
List<E> portRanges
The list of port ranges for the connections from clients to the accelerator.
String protocol
The protocol for the connections from clients to the accelerator.
String 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.
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.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
Integer maxResults
The number of listener objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String resourceArn
The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
Integer acceleratorPort
The accelerator port.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointId
The IP address of the VPC subnet (the subnet ID).
SocketAddress destinationSocketAddress
The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
List<E> protocols
The protocols supported by the endpoint group.
String 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.
Integer 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.
Integer 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.
String cidr
The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
CidrAuthorizationContext cidrAuthorizationContext
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
ByoipCidr byoipCidr
Information about the address range.
String endpointId
The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.
An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
String cidr
An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
String region
The Amazon Web Services Region where a shared endpoint resource is located.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator that you want to update.
Boolean flowLogsEnabled
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 Global Accelerator Developer Guide.
String flowLogsS3Bucket
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 Global Accelerator permission to
write to the bucket.
String flowLogsS3Prefix
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
AcceleratorAttributes acceleratorAttributes
Updated attributes for the accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to update.
String name
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
String ipAddressType
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
List<E> ipAddresses
The IP addresses for an accelerator.
Boolean enabled
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.
Accelerator accelerator
Information about the updated accelerator.
String attachmentArn
The Amazon Resource Name (ARN) of the cross-account attachment to update.
String name
The name of the cross-account attachment.
List<E> addPrincipals
The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.
To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
List<E> removePrincipals
The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.
To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
List<E> addResources
The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.
To add more than one resource, separate the resource ARNs with commas.
List<E> removeResources
The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.
To remove more than one resource, separate the resource ARNs with commas.
Attachment crossAccountAttachment
Information about the updated cross-account attachment.
String acceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
Boolean flowLogsEnabled
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 Global Accelerator Developer Guide.
String flowLogsS3Bucket
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 Global Accelerator permission to
write to the bucket.
String flowLogsS3Prefix
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
CustomRoutingAcceleratorAttributes acceleratorAttributes
Updated custom routing accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to update.
String name
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
String ipAddressType
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
List<E> ipAddresses
The IP addresses for an accelerator.
Boolean enabled
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.
CustomRoutingAccelerator accelerator
Information about the updated custom routing accelerator.
String listenerArn
The Amazon Resource Name (ARN) of the listener to update.
List<E> portRanges
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.
CustomRoutingListener listener
Information for the updated listener for a custom routing accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
List<E> endpointConfigurations
The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
Float trafficDialPercentage
The percentage of traffic to send to an Amazon Web Services 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.
Integer healthCheckPort
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
String healthCheckProtocol
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
String healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
Integer 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.
List<E> portOverrides
Override specific listener ports used to route traffic to endpoints that are part of this 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 Overriding listener ports in the Global Accelerator Developer Guide.
EndpointGroup endpointGroup
The information about the endpoint group that was updated.
String listenerArn
The Amazon Resource Name (ARN) of the listener to update.
List<E> portRanges
The updated list of port ranges for the connections from clients to the accelerator.
String protocol
The updated protocol for the connections from clients to the accelerator.
String 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.
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.
Listener listener
Information for the updated listener.
String cidr
The address range, in CIDR notation.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
ByoipCidr byoipCidr
Information about the BYOIP address pool.
Copyright © 2025. All rights reserved.