interface RawEndpointProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.GlobalAccelerator.RawEndpointProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsglobalaccelerator#RawEndpointProps |
 Java | software.amazon.awscdk.services.globalaccelerator.RawEndpointProps |
 Python | aws_cdk.aws_globalaccelerator.RawEndpointProps |
 TypeScript (source) | aws-cdk-lib » aws_globalaccelerator » RawEndpointProps |
Properties for RawEndpoint.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_globalaccelerator as globalaccelerator } from 'aws-cdk-lib';
const rawEndpointProps: globalaccelerator.RawEndpointProps = {
endpointId: 'endpointId',
// the properties below are optional
preserveClientIp: false,
region: 'region',
weight: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| endpoint | string | Identifier of the endpoint. |
| preserve | boolean | Forward the client IP address. |
| region? | string | The region where this endpoint is located. |
| weight? | number | Endpoint weight across all endpoints in the group. |
endpointId
Type:
string
Identifier of the endpoint.
Load balancer ARN, instance ID or EIP allocation ID.
preserveClientIp?
Type:
boolean
(optional, default: true if possible and available)
Forward the client IP address.
GlobalAccelerator will create Network Interfaces in your VPC in order to preserve the client IP address.
Only applies to Application Load Balancers and EC2 instances.
Client IP address preservation is supported only in specific AWS Regions. See the GlobalAccelerator Developer Guide for a list.
region?
Type:
string
(optional, default: Unknown what region this endpoint is located)
The region where this endpoint is located.
weight?
Type:
number
(optional, default: 128)
Endpoint weight across all endpoints in the group.
Must be a value between 0 and 255.