EndpointConfigurationProps

class aws_cdk.aws_globalaccelerator.EndpointConfigurationProps(*, client_ip_reservation=None, weight=None, endpoint_group, endpoint_id)

Bases: aws_cdk.aws_globalaccelerator.EndpointConfigurationOptions

(experimental) Properties to create EndpointConfiguration.

Parameters
  • client_ip_reservation (Optional[bool]) – (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. Default: true

  • weight (Union[int, float, None]) – (experimental) 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. Default: - not specified

  • endpoint_group (EndpointGroup) – (experimental) The endopoint group reesource. [disable-awslint:ref-via-interface]

  • endpoint_id (str) – (experimental) 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 EC2 instances, this is the EC2 instance ID.

Stability

experimental

Attributes

client_ip_reservation

(experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.

Default

true

Stability

experimental

Return type

Optional[bool]

endpoint_group

(experimental) The endopoint group reesource.

[disable-awslint:ref-via-interface]

Stability

experimental

Return type

EndpointGroup

endpoint_id

(experimental) 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 EC2 instances, this is the EC2 instance ID.

Stability

experimental

Return type

str

weight

(experimental) 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.

Default
  • not specified

See

https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html

Stability

experimental

Return type

Union[int, float, None]