Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . globalaccelerator ]

update-custom-routing-listener

Description

Update a listener for a custom routing accelerator.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-custom-routing-listener
--listener-arn <value>
--port-ranges <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--listener-arn (string)

The Amazon Resource Name (ARN) of the listener to update.

--port-ranges (list)

The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.

Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators .

(structure)

A complex type for a range of ports for a listener.

FromPort -> (integer)

The first port in the range of ports, inclusive.

ToPort -> (integer)

The last port in the range of ports, inclusive.

Shorthand Syntax:

FromPort=integer,ToPort=integer ...

JSON Syntax:

[
  {
    "FromPort": integer,
    "ToPort": integer
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a listener for a custom routing accelerator

The following update-custom-routing-listener example updates a listener to change the port range.

aws globalaccelerator update-custom-routing-listener \
    --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \
    --port-ranges FromPort=10000,ToPort=20000

Output:

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

For more information, see Listeners for custom routing accelerators in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Output

Listener -> (structure)

Information for the updated listener for a custom routing accelerator.

ListenerArn -> (string)

The Amazon Resource Name (ARN) of the listener.

PortRanges -> (list)

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 .

(structure)

A complex type for a range of ports for a listener.

FromPort -> (integer)

The first port in the range of ports, inclusive.

ToPort -> (integer)

The last port in the range of ports, inclusive.