AWS::GlobalAccelerator::Listener
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::GlobalAccelerator::Listener", "Properties" : { "AcceleratorArn" :
String
, "ClientAffinity" :String
, "PortRanges" :[ PortRange, ... ]
, "Protocol" :String
} }
YAML
Type: AWS::GlobalAccelerator::Listener Properties: AcceleratorArn:
String
ClientAffinity:String
PortRanges:- PortRange
Protocol:String
Properties
AcceleratorArn
-
The Amazon Resource Name (ARN) of your accelerator.
Required: Yes
Type: String
Maximum:
255
Update requires: Replacement
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 theSOURCE_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
.Required: No
Type: String
Allowed values:
NONE | SOURCE_IP
Update requires: No interruption
PortRanges
-
The list of port ranges for the connections from clients to the accelerator.
Required: Yes
Type: Array of PortRange
Minimum:
1
Maximum:
10
Update requires: No interruption
Protocol
-
The protocol for the connections from clients to the accelerator.
Required: Yes
Type: String
Allowed values:
TCP | UDP
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the ARN of the listener, such as
arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
ListenerArn
-
The ARN of the listener, such as
arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz
.
Examples
Add a listener
These are examples to specify a listener.
JSON
"Resources": { "Listener": { "Type": "AWS::GlobalAccelerator::Listener", "Properties": { "AcceleratorArn": { "Ref": "Accelerator" }, "Protocol": "TCP", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ] } } }
YAML
Listener: Type: AWS::GlobalAccelerator::Listener Properties: AcceleratorArn: Ref: Accelerator Protocol: TCP PortRanges: - FromPort: 80 ToPort: 80