addListener

Accelerator

acceleratorName

Indicates whether the accelerator is enabled.

enabled

IP addresses associated with the accelerator.

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP
addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.
You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify
only one IP address from your IP address range, Global Accelerator assigns a second static IP address for
the accelerator from the AWS IP address pool.

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.

ipAddresses

The IP address type that an accelerator supports.

For a standard accelerator, the value can be IPV4 or DUAL_STACK.

ipAddressType

addEndpoint

Return an object that represents the Accelerator's Security Group.

Uses a Custom Resource to look up the Security Group that Accelerator
creates at deploy time. Requires your VPC ID to perform the lookup.

The Security Group will only be created if you enable **Client IP
Preservation** on any of the endpoints.

You cannot manipulate the rules inside this security group, but you can
use this security group as a Peer in Connections rules on other
constructs.

connectionsPeer

EndpointGroup

The Amazon Resource Name (ARN) of the listener.

listener

endpointGroupName

Initial list of endpoints for this group.

endpoints

The time between health checks for each endpoint.

Must be either 10 or 30 seconds.

healthCheckInterval

The ping path for health checks (if the protocol is HTTP(S)).

healthCheckPath

healthCheckPort

The protocol used to perform health checks.

healthCheckProtocol

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.

healthCheckThreshold

Override the destination ports used to route traffic to an endpoint.

Unless overridden, the port used to hit the endpoint will be the same as the port
that traffic arrives on at the listener.

portOverrides

The AWS Region where the endpoint group is located.

region

The percentage of traffic to send to this AWS Region.

The percentage is applied to the traffic that would otherwise have been
routed to the Region based on optimal routing. Additional traffic is
distributed to other endpoint groups for this listener.

trafficDialPercentage

Add a new endpoint group to this listener.

addEndpointGroup

Listener

accelerator

The list of port ranges for the connections from clients to the accelerator.

portRanges

Client affinity to direct all requests from a user to the same endpoint.

If you have stateful applications, client affinity lets you direct all
requests from a user to the same endpoint.

By default, each connection from each client is routed to separate
endpoints. Set client affinity to SOURCE_IP to route all connections from
a single client to the same endpoint.

clientAffinity

listenerName

The protocol for the connections from clients to the accelerator.

protocol

The `AWS::GlobalAccelerator::Accelerator` resource is a Global Accelerator resource type that contains information about how you create an accelerator.

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

CfnAccelerator

The name of the accelerator.

The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

name

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.

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.

You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

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)](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the *AWS Global Accelerator Developer Guide* .

Create tags for an accelerator.

For more information, see [Tagging](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the *AWS Global Accelerator Developer Guide* .

CfnCrossAccountAttachment

The name of the cross-account attachment.

The principals included in the cross-account attachment.

principals

The resources included in the cross-account attachment.

resources

Add tags for a cross-account attachment.

For more information, see [Tagging in AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the *AWS Global Accelerator Developer Guide* .

The `AWS::GlobalAccelerator::EndpointGroup` resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener.

An endpoint group is a collection of endpoints in one AWS Region .

CfnEndpointGroup

The AWS Regions where the endpoint group is located.

endpointGroupRegion

listenerArn

endpointConfigurations

The time—10 seconds or 30 seconds—between health checks for each endpoint.

The default value is 30.

healthCheckIntervalSeconds

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 (/).

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.

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default value is TCP.

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.

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.

thresholdCount

The percentage of traffic to send to an AWS Regions .

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.

The `AWS::GlobalAccelerator::Listener` resource is a Global Accelerator resource type that contains information about how you create a listener to process inbound connections from clients to an accelerator.

Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.

CfnListener

The Amazon Resource Name (ARN) of your accelerator.

acceleratorArn

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` .

AWS globalaccelerator

L2 Constructs3

Accelerator

EndpointGroup

Listener

L1 Constructs4

CfnAccelerator

CfnCrossAccountAttachment

CfnEndpointGroup

CfnListener

Learn AWS the Practical Way

Quick Facts

Related Links

More AWS globalaccelerator deep dives