You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GlobalAccelerator::Types::Listener
- Inherits:
-
Struct
- Object
- Struct
- Aws::GlobalAccelerator::Types::Listener
- Defined in:
- (unknown)
Overview
A complex type for a listener.
Returned by:
Instance Attribute Summary collapse
-
#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.
-
#listener_arn ⇒ String
The Amazon Resource Name (ARN) of the listener.
-
#port_ranges ⇒ Array<Types::PortRange>
The list of port ranges for the connections from clients to the accelerator.
-
#protocol ⇒ String
The protocol for the connections from clients to the accelerator.
Instance Attribute Details
#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. 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
#listener_arn ⇒ String
The Amazon Resource Name (ARN) of the listener.
#port_ranges ⇒ Array<Types::PortRange>
The list of port ranges for the connections from clients to the accelerator.
#protocol ⇒ String
The protocol for the connections from clients to the accelerator.
Possible values:
- TCP
- UDP