AWS Global Accelerator
API Reference (API Version 2018-08-08)

CreateListener

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.

Request Syntax

{ "AcceleratorArn": "string", "ClientAffinity": "string", "IdempotencyToken": "string", "PortRanges": [ { "FromPort": number, "ToPort": number } ], "Protocol": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AcceleratorArn

The Amazon Resource Name (ARN) of your accelerator.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

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

Type: String

Valid Values: NONE | SOURCE_IP

Required: No

IdempotencyToken

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

PortRanges

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

Type: Array of PortRange objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Protocol

The protocol for connections from clients to your accelerator.

Type: String

Valid Values: TCP | UDP

Required: Yes

Response Syntax

{ "Listener": { "ClientAffinity": "string", "ListenerArn": "string", "PortRanges": [ { "FromPort": number, "ToPort": number } ], "Protocol": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Listener

The listener that you've created.

Type: Listener object

Errors

For information about the errors that are common to all actions, see Common Errors.

AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

HTTP Status Code: 400

InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400

InvalidArgumentException

An argument that you specified is invalid.

HTTP Status Code: 400

InvalidPortRangeException

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

HTTP Status Code: 400

LimitExceededException

Processing your request would cause you to exceed an AWS Global Accelerator limit.

HTTP Status Code: 400

Example

Create a listener

The following is an example of creating a listener and the response.

aws globalaccelerator create-listener --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh --port-ranges FromPort=80,ToPort=80 FromPort=81,ToPort=81 --protocol TCP --region us-west-2 --idempotencytoken dcba4321-dcba-4321-dcba-dcba4321
{ "Listener": { "PortRanges": [ { "ToPort": 80, "FromPort": 80 }, { "ToPort": 81, "FromPort": 81 } ], "ClientAffinity": "NONE", "Protocol": "TCP", "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: