class Aws::GlobalAccelerator::Types::UpdateListenerRequest

@note When making an API call, you may pass UpdateListenerRequest

data as a hash:

    {
      listener_arn: "GenericString", # required
      port_ranges: [
        {
          from_port: 1,
          to_port: 1,
        },
      ],
      protocol: "TCP", # accepts TCP, UDP
      client_affinity: "NONE", # accepts NONE, SOURCE_IP
    }

@!attribute [rw] listener_arn

The Amazon Resource Name (ARN) of the listener to update.
@return [String]

@!attribute [rw] port_ranges

The updated list of port ranges for the connections from clients to
the accelerator.
@return [Array<Types::PortRange>]

@!attribute [rw] protocol

The updated protocol for the connections from clients to the
accelerator.
@return [String]

@!attribute [rw] client_affinity

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. Client 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`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListenerRequest AWS API Documentation

Constants

SENSITIVE