AWS::GlobalAccelerator::EndpointGroup EndpointConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::GlobalAccelerator::EndpointGroup EndpointConfiguration

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AttachmentArn" : String,
  "ClientIPPreservationEnabled" : Boolean,
  "EndpointId" : String,
  "Weight" : Integer
}

YAML

  AttachmentArn: String
  ClientIPPreservationEnabled: Boolean
  EndpointId: String
  Weight: Integer

Properties

AttachmentArn

The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.

Required: No

Type: String

Maximum: 255

Update requires: No interruption

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 Preserve Client IP Addresses in the Amazon Global Accelerator Developer Guide.

Required: No

Type: Boolean

Update requires: No interruption

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

For cross-account endpoints, this must be the ARN of the resource.

Required: Yes

Type: String

Maximum: 255

Update requires: No interruption

Weight

The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Amazon Global Accelerator Developer Guide.

Required: No

Type: Integer

Minimum: 0

Maximum: 255

Update requires: No interruption