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. To see an AWS CLI example of creating a listener, scroll down to Example.
globalaccelerator_create_listener(AcceleratorArn, PortRanges, Protocol,
ClientAffinity, IdempotencyToken)[required] The Amazon Resource Name (ARN) of your accelerator.
[required] The list of port ranges to support for connections from clients to your accelerator.
[required] The protocol for connections from clients to your accelerator.
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. Clienty 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.
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency---that is, the uniqueness---of the request.
svc$create_listener(
AcceleratorArn = "string",
PortRanges = list(
list(
FromPort = 123,
ToPort = 123
)
),
Protocol = "TCP"|"UDP",
ClientAffinity = "NONE"|"SOURCE_IP",
IdempotencyToken = "string"
)