ApplicationLoadBalancerEndpointOptions

class aws_cdk.aws_globalaccelerator_endpoints.ApplicationLoadBalancerEndpointOptions(*, preserve_client_ip=None, weight=None)

Bases: object

Properties for a ApplicationLoadBalancerEndpoint.

Parameters:

preserve_client_ip (Optional[bool]) – Forward the client IP address in an X-Forwarded-For header. GlobalAccelerator will create Network Interfaces in your VPC in order to preserve the client IP address. Client IP address preservation is supported only in specific AWS Regions. See the GlobalAccelerator Developer Guide for a list. Default: true if available
weight (Union[int, float, None]) – Endpoint weight across all endpoints in the group. Must be a value between 0 and 255. Default: 128

ExampleMetadata:

infused

Example:

# alb: elbv2.ApplicationLoadBalancer
# listener: globalaccelerator.Listener


listener.add_endpoint_group("Group",
    endpoints=[
        ga_endpoints.ApplicationLoadBalancerEndpoint(alb,
            weight=128,
            preserve_client_ip=True
        )
    ]
)

Attributes

preserve_client_ip

Forward the client IP address in an X-Forwarded-For header.

GlobalAccelerator will create Network Interfaces in your VPC in order to preserve the client IP address.

Client IP address preservation is supported only in specific AWS Regions. See the GlobalAccelerator Developer Guide for a list.

Default:: true if available

weight

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.

Default:: 128