EndpointDescription
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
Contents
- ClientIPPreservationEnabled
-
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
If the value is set to true, the client's IP address is preserved in the
X-Forwarded-Forrequest header as traffic travels to applications on the endpoint fronted by the accelerator.Client IP address preservation is supported, in specific AWS Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
Type: Boolean
Required: No
- 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- HealthReason
-
Returns a null result.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- HealthState
-
The health status of the endpoint.
Type: String
Valid Values:
INITIAL | HEALTHY | UNHEALTHYRequired: No
- 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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
