aws-cdk-lib.aws_globalaccelerator_endpoints.ApplicationLoadBalancerEndpointOptions

interface ApplicationLoadBalancerEndpointOptions

LanguageType name
.NETAmazon.CDK.AWS.GlobalAccelerator.Endpoints.ApplicationLoadBalancerEndpointOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsglobalacceleratorendpoints#ApplicationLoadBalancerEndpointOptions
Javasoftware.amazon.awscdk.services.globalaccelerator.endpoints.ApplicationLoadBalancerEndpointOptions
Pythonaws_cdk.aws_globalaccelerator_endpoints.ApplicationLoadBalancerEndpointOptions
TypeScript (source)aws-cdk-lib » aws_globalaccelerator_endpoints » ApplicationLoadBalancerEndpointOptions

Properties for a ApplicationLoadBalancerEndpoint.

Example

declare const alb: elbv2.ApplicationLoadBalancer;
declare const listener: globalaccelerator.Listener;

listener.addEndpointGroup('Group', {
  endpoints: [
    new ga_endpoints.ApplicationLoadBalancerEndpoint(alb, {
      weight: 128,
      preserveClientIp: true,
    }),
  ],
});

Properties

NameTypeDescription
preserveClientIp?booleanForward the client IP address in an X-Forwarded-For header.
weight?numberEndpoint weight across all endpoints in the group.

preserveClientIp?

Type: boolean (optional, default: true if available)

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.


weight?

Type: number (optional, default: 128)

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.