libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GlobalAccelerator.CreateListener

Description

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.

Synopsis

Creating a Request

data CreateListener Source #

See: newCreateListener smart constructor.

Constructors

CreateListener' 

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.

    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.

  • acceleratorArn :: Text

    The Amazon Resource Name (ARN) of your accelerator.

  • portRanges :: NonEmpty PortRange

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

  • protocol :: Protocol

    The protocol for connections from clients to your accelerator.

  • idempotencyToken :: Text

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Instances

Instances details
Eq CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Read CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Show CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Generic CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Associated Types

type Rep CreateListener :: Type -> Type #

NFData CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Methods

rnf :: CreateListener -> () #

Hashable CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

ToJSON CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

AWSRequest CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Associated Types

type AWSResponse CreateListener #

ToHeaders CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

ToPath CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

ToQuery CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

type Rep CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

type Rep CreateListener = D1 ('MetaData "CreateListener" "Amazonka.GlobalAccelerator.CreateListener" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "CreateListener'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientAffinity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAffinity)) :*: S1 ('MetaSel ('Just "acceleratorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "portRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PortRange)) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Protocol) :*: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateListener Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

newCreateListener Source #

Create a value of CreateListener 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:clientAffinity:CreateListener', createListener_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.

$sel:acceleratorArn:CreateListener', createListener_acceleratorArn - The Amazon Resource Name (ARN) of your accelerator.

$sel:portRanges:CreateListener', createListener_portRanges - The list of port ranges to support for connections from clients to your accelerator.

$sel:protocol:CreateListener', createListener_protocol - The protocol for connections from clients to your accelerator.

$sel:idempotencyToken:CreateListener', createListener_idempotencyToken - A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Request Lenses

createListener_clientAffinity :: Lens' CreateListener (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.

createListener_acceleratorArn :: Lens' CreateListener Text Source #

The Amazon Resource Name (ARN) of your accelerator.

createListener_portRanges :: Lens' CreateListener (NonEmpty PortRange) Source #

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

createListener_protocol :: Lens' CreateListener Protocol Source #

The protocol for connections from clients to your accelerator.

createListener_idempotencyToken :: Lens' CreateListener Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Destructuring the Response

data CreateListenerResponse Source #

See: newCreateListenerResponse smart constructor.

Constructors

CreateListenerResponse' 

Fields

Instances

Instances details
Eq CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Read CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Show CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Generic CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Associated Types

type Rep CreateListenerResponse :: Type -> Type #

NFData CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

Methods

rnf :: CreateListenerResponse -> () #

type Rep CreateListenerResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateListener

type Rep CreateListenerResponse = D1 ('MetaData "CreateListenerResponse" "Amazonka.GlobalAccelerator.CreateListener" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "CreateListenerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "listener") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Listener)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateListenerResponse Source #

Create a value of CreateListenerResponse 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:CreateListenerResponse', createListenerResponse_listener - The listener that you've created.

$sel:httpStatus:CreateListenerResponse', createListenerResponse_httpStatus - The response's http status code.

Response Lenses