Interface IRawEndpointProps

Properties for RawEndpoint.

Namespace: Amazon.CDK.AWS.GlobalAccelerator

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IRawEndpointProps

Syntax (vb)

Public Interface IRawEndpointProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.GlobalAccelerator;

            var rawEndpointProps = new RawEndpointProps {
                EndpointId = "endpointId",

                // the properties below are optional
                PreserveClientIp = false,
                Region = "region",
                Weight = 123
            };

Synopsis

Properties

EndpointId	Identifier of the endpoint.
PreserveClientIp	Forward the client IP address.
Region	The region where this endpoint is located.
Weight	Endpoint weight across all endpoints in the group.

Properties

EndpointId

Identifier of the endpoint.

string EndpointId { get; }

Property Value

string

Remarks

Load balancer ARN, instance ID or EIP allocation ID.

PreserveClientIp

Forward the client IP address.

bool? PreserveClientIp { get; }

Property Value

bool?

Remarks

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.

Default: true if possible and available

Region

The region where this endpoint is located.

string? Region { get; }

Property Value

string

Remarks

Default: - Unknown what region this endpoint is located

Weight

Endpoint weight across all endpoints in the group.

double? Weight { get; }

Property Value

double?

Remarks

Must be a value between 0 and 255.

Default: 128