class Aws::GlobalAccelerator::Types::EndpointConfiguration

A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

@note When making an API call, you may pass EndpointConfiguration

data as a hash:

    {
      endpoint_id: "GenericString",
      weight: 1,
      client_ip_preservation_enabled: false,
    }

@!attribute [rw] endpoint_id

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. A resource must be valid and active when you
add it as an endpoint.

An Application Load Balancer can be either internal or
internet-facing.
@return [String]

@!attribute [rw] 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][1] in the *AWS Global Accelerator Developer
Guide*.

[1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html
@return [Integer]

@!attribute [rw] client_ip_preservation_enabled

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 [ Preserve Client IP Addresses in AWS
Global Accelerator][1] in the *AWS Global Accelerator Developer
Guide*.

[1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/EndpointConfiguration AWS API Documentation

Constants

SENSITIVE