Table Of Contents

Feedback

User Guide

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

[ aws . globalaccelerator ]

update-listener

Description

Update a listener.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-listener
--listener-arn <value>
[--port-ranges <value>]
[--protocol <value>]
[--client-affinity <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 list of port ranges for the connections from clients to the accelerator.

Shorthand Syntax:

FromPort=integer,ToPort=integer ...

JSON Syntax:

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

--protocol (string)

The updated protocol for the connections from clients to the accelerator.

Possible values:

  • TCP
  • UDP

--client-affinity (string)

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 .

Possible values:

  • NONE
  • SOURCE_IP

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

Output

Listener -> (structure)

Information for the updated listener.

ListenerArn -> (string)

The Amazon Resource Name (ARN) of the listener.

PortRanges -> (list)

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

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

Protocol -> (string)

The protocol for the connections from clients to the accelerator.

ClientAffinity -> (string)

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 .