Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Documentation

data EndpointIdentifier

A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.

See: newEndpointIdentifier smart constructor.

Constructors

EndpointIdentifier'

Fields

• clientIPPreservationEnabled :: Maybe Bool

  Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

  If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

• endpointId :: Text

  An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

  An Application Load Balancer can be either internal or internet-facing.

Instances

ToJSON EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

toJSON :: EndpointIdentifier -> Value

toEncoding :: EndpointIdentifier -> Encoding

toJSONList :: [EndpointIdentifier] -> Value

toEncodingList :: [EndpointIdentifier] -> Encoding

Generic EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Associated Types

type Rep EndpointIdentifier :: Type -> Type

Methods

from :: EndpointIdentifier -> Rep EndpointIdentifier x

to :: Rep EndpointIdentifier x -> EndpointIdentifier

Read EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

readsPrec :: Int -> ReadS EndpointIdentifier

readList :: ReadS [EndpointIdentifier]

readPrec :: ReadPrec EndpointIdentifier

readListPrec :: ReadPrec [EndpointIdentifier]

Show EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

showsPrec :: Int -> EndpointIdentifier -> ShowS

show :: EndpointIdentifier -> String

showList :: [EndpointIdentifier] -> ShowS

NFData EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

rnf :: EndpointIdentifier -> ()

Eq EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

(==) :: EndpointIdentifier -> EndpointIdentifier -> Bool

(/=) :: EndpointIdentifier -> EndpointIdentifier -> Bool

Hashable EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

Methods

hashWithSalt :: Int -> EndpointIdentifier -> Int

hash :: EndpointIdentifier -> Int

type Rep EndpointIdentifier

Defined in Amazonka.GlobalAccelerator.Types.EndpointIdentifier

type Rep EndpointIdentifier = D1 ('MetaData "EndpointIdentifier" "Amazonka.GlobalAccelerator.Types.EndpointIdentifier" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "EndpointIdentifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientIPPreservationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEndpointIdentifier

Arguments

:: Text

$sel:endpointId:EndpointIdentifier'

-> EndpointIdentifier

Create a value of EndpointIdentifier 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:clientIPPreservationEnabled:EndpointIdentifier', endpointIdentifier_clientIPPreservationEnabled - Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

$sel:endpointId:EndpointIdentifier', endpointIdentifier_endpointId - An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

An Application Load Balancer can be either internal or internet-facing.

endpointIdentifier_clientIPPreservationEnabled :: Lens' EndpointIdentifier (Maybe Bool)

Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

endpointIdentifier_endpointId :: Lens' EndpointIdentifier Text

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

An Application Load Balancer can be either internal or internet-facing.