Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateCustomRoutingListener

Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.

Request Syntax


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

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 the accelerator for a custom routing listener.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

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

Type: Array of PortRange objects

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

Required: Yes

Response Syntax


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

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 for a custom routing accelerator.

Type: CustomRoutingListener 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

Examples

Create a listener for a custom routing accelerator

The following is an example of creating a listener for a custom routing accelerator, and the response.


aws --region us-west-2 globalaccelerator create-custom-routing-listener 
       --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh 
       --port-ranges FromPort=80,ToPort=80 FromPort=81,ToPort=81


{
    "Listener": {
        "PortRange": [
            "FromPort": 5000 
            "ToPort": 10000, 
        ], 
        "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz"
    }
}