amazonka-globalaccelerator-2.0: Amazon Global Accelerator SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GlobalAccelerator.UpdateListener

Description

Update a listener.

Synopsis

Creating a Request

data UpdateListener Source #

See: newUpdateListener smart constructor.

Constructors

UpdateListener' 

Fields

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

    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.

  • portRanges :: Maybe (NonEmpty PortRange)

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

  • protocol :: Maybe Protocol

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

  • listenerArn :: Text

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

Instances

Instances details
ToJSON UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

ToHeaders UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

ToPath UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

ToQuery UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

AWSRequest UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Associated Types

type AWSResponse UpdateListener #

Generic UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Associated Types

type Rep UpdateListener :: Type -> Type #

Read UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Show UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

NFData UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Methods

rnf :: UpdateListener -> () #

Eq UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Hashable UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

type AWSResponse UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

type Rep UpdateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

type Rep UpdateListener = D1 ('MetaData "UpdateListener" "Amazonka.GlobalAccelerator.UpdateListener" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "UpdateListener'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientAffinity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAffinity)) :*: S1 ('MetaSel ('Just "portRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty PortRange)))) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :*: S1 ('MetaSel ('Just "listenerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateListener Source #

Create a value of UpdateListener 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:

UpdateListener, updateListener_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.

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.

UpdateListener, updateListener_portRanges - The updated list of port ranges for the connections from clients to the accelerator.

UpdateListener, updateListener_protocol - The updated protocol for the connections from clients to the accelerator.

UpdateListener, updateListener_listenerArn - The Amazon Resource Name (ARN) of the listener to update.

Request Lenses

updateListener_clientAffinity :: Lens' UpdateListener (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.

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.

updateListener_portRanges :: Lens' UpdateListener (Maybe (NonEmpty PortRange)) Source #

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

updateListener_protocol :: Lens' UpdateListener (Maybe Protocol) Source #

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

updateListener_listenerArn :: Lens' UpdateListener Text Source #

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

Destructuring the Response

data UpdateListenerResponse Source #

See: newUpdateListenerResponse smart constructor.

Constructors

UpdateListenerResponse' 

Fields

Instances

Instances details
Generic UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Associated Types

type Rep UpdateListenerResponse :: Type -> Type #

Read UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Show UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

NFData UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

Methods

rnf :: UpdateListenerResponse -> () #

Eq UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

type Rep UpdateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateListener

type Rep UpdateListenerResponse = D1 ('MetaData "UpdateListenerResponse" "Amazonka.GlobalAccelerator.UpdateListener" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "UpdateListenerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "listener") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Listener)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateListenerResponse Source #

Create a value of UpdateListenerResponse 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:listener:UpdateListenerResponse', updateListenerResponse_listener - Information for the updated listener.

$sel:httpStatus:UpdateListenerResponse', updateListenerResponse_httpStatus - The response's http status code.

Response Lenses