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.Types.EndpointDescription

Description

 
Synopsis

Documentation

data EndpointDescription Source #

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

See: newEndpointDescription smart constructor.

Constructors

EndpointDescription' 

Fields

  • healthReason :: Maybe Text

    Returns a null result.

  • weight :: Maybe Natural

    The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

  • clientIPPreservationEnabled :: Maybe Bool

    Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

    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 Application Load Balancer endpoint fronted by the accelerator.

    For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

  • healthState :: Maybe HealthState

    The health status of the endpoint.

  • endpointId :: Maybe 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

Instances details
Eq EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

Read EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

Show EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

Generic EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

Associated Types

type Rep EndpointDescription :: Type -> Type #

NFData EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

Methods

rnf :: EndpointDescription -> () #

Hashable EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

FromJSON EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

type Rep EndpointDescription Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.Types.EndpointDescription

type Rep EndpointDescription = D1 ('MetaData "EndpointDescription" "Amazonka.GlobalAccelerator.Types.EndpointDescription" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "EndpointDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "healthReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "weight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "clientIPPreservationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "healthState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthState)) :*: S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointDescription :: EndpointDescription Source #

Create a value of EndpointDescription 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:healthReason:EndpointDescription', endpointDescription_healthReason - Returns a null result.

$sel:weight:EndpointDescription', endpointDescription_weight - The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

$sel:clientIPPreservationEnabled:EndpointDescription', endpointDescription_clientIPPreservationEnabled - Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

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 Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

$sel:healthState:EndpointDescription', endpointDescription_healthState - The health status of the endpoint.

$sel:endpointId:EndpointDescription', endpointDescription_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.

endpointDescription_weight :: Lens' EndpointDescription (Maybe Natural) Source #

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

endpointDescription_clientIPPreservationEnabled :: Lens' EndpointDescription (Maybe Bool) Source #

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

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 Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

endpointDescription_endpointId :: Lens' EndpointDescription (Maybe Text) Source #

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.