aws-cdk-lib.aws_globalaccelerator_endpoints.InstanceEndpointProps

interface InstanceEndpointProps

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

Properties for a NetworkLoadBalancerEndpoint.

Example

declare const listener: globalaccelerator.Listener;
declare const instance: ec2.Instance;

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

Properties

NameTypeDescription
preserveClientIp?booleanForward the client IP address.
weight?numberEndpoint weight across all endpoints in the group.

preserveClientIp?

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

Forward the client IP address.

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.