Class: Aws::GlobalAccelerator::Types::Listener

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb

Overview

A complex type for a listener.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

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.

Returns:

  • (String) 


2912
2913
2914
2915
2916
2917
2918
2919
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2912

class Listener < Struct.new(
  :listener_arn,
  :port_ranges,
  :protocol,
  :client_affinity)
  SENSITIVE = []
  include Aws::Structure
end

#listener_arn ⇒ String

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String) 


2912
2913
2914
2915
2916
2917
2918
2919
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2912

class Listener < Struct.new(
  :listener_arn,
  :port_ranges,
  :protocol,
  :client_affinity)
  SENSITIVE = []
  include Aws::Structure
end

#port_ranges ⇒ Array<Types::PortRange>

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

Returns:



2912
2913
2914
2915
2916
2917
2918
2919
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2912

class Listener < Struct.new(
  :listener_arn,
  :port_ranges,
  :protocol,
  :client_affinity)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol for the connections from clients to the accelerator.

Returns:

  • (String) 


2912
2913
2914
2915
2916
2917
2918
2919
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2912

class Listener < Struct.new(
  :listener_arn,
  :port_ranges,
  :protocol,
  :client_affinity)
  SENSITIVE = []
  include Aws::Structure
end