Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GlobalAccelerator.Types.Listener

Description

Synopsis

data Listener = Listener' {
- portRanges :: Maybe (NonEmpty PortRange)
- listenerArn :: Maybe Text
- protocol :: Maybe Protocol
- clientAffinity :: Maybe ClientAffinity
}
newListener :: Listener
listener_portRanges :: Lens' Listener (Maybe (NonEmpty PortRange))
listener_listenerArn :: Lens' Listener (Maybe Text)
listener_protocol :: Lens' Listener (Maybe Protocol)
listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity)

Documentation

data Listener Source #

A complex type for a listener.

See: newListener smart constructor.

Constructors

Listener'

Fields

portRanges :: Maybe (NonEmpty PortRange)
The list of port ranges for the connections from clients to the accelerator.
listenerArn :: Maybe Text
The Amazon Resource Name (ARN) of the listener.
protocol :: Maybe Protocol
The protocol for the connections from clients to the accelerator.
clientAffinity :: Maybe ClientAffinity
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.

Instances

Instances details

Eq Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods (==) :: Listener -> Listener -> Bool # (/=) :: Listener -> Listener -> Bool #
Read Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods readsPrec :: Int -> ReadS Listener # readList :: ReadS [Listener] # readPrec :: ReadPrec Listener # readListPrec :: ReadPrec [Listener] #
Show Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods showsPrec :: Int -> Listener -> ShowS # show :: Listener -> String # showList :: [Listener] -> ShowS #
Generic Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Associated Types type Rep Listener :: Type -> Type # Methods from :: Listener -> Rep Listener x # to :: Rep Listener x -> Listener #
NFData Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods rnf :: Listener -> () #
Hashable Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods hashWithSalt :: Int -> Listener -> Int # hash :: Listener -> Int #
FromJSON Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener Methods parseJSON :: Value -> Parser Listener # parseJSONList :: Value -> Parser [Listener] #
type Rep Listener Source #
Instance details Defined in Amazonka.GlobalAccelerator.Types.Listener type Rep Listener = D1 ('MetaData "Listener" "Amazonka.GlobalAccelerator.Types.Listener" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "Listener'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "portRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty PortRange))) :: S1 ('MetaSel ('Just "listenerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :*: S1 ('MetaSel ('Just "clientAffinity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAffinity)))))

newListener :: Listener Source #

Create a value of Listener with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:portRanges:Listener', listener_portRanges - The list of port ranges for the connections from clients to the accelerator.

$sel:listenerArn:Listener', listener_listenerArn - The Amazon Resource Name (ARN) of the listener.

$sel:protocol:Listener', listener_protocol - The protocol for the connections from clients to the accelerator.

$sel:clientAffinity:Listener', listener_clientAffinity - 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.

listener_portRanges :: Lens' Listener (Maybe (NonEmpty PortRange)) Source #

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

listener_listenerArn :: Lens' Listener (Maybe Text) Source #

The Amazon Resource Name (ARN) of the listener.

listener_protocol :: Lens' Listener (Maybe Protocol) Source #

The protocol for the connections from clients to the accelerator.

listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity) Source #

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.