AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GlobalAccelerator::Types::UpdateListenerRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateListenerRequest as input to an Aws::Client method, you can use a vanilla 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_affinityString

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.

Possible values:

  • NONE
  • SOURCE_IP

Returns:

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

#listener_arnString

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

Returns:

  • (String)

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

#port_rangesArray<Types::PortRange>

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

Returns:

  • (Array<Types::PortRange>)

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

#protocolString

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

Possible values:

  • TCP
  • UDP

Returns:

  • (String)

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