RawEndpointProps

class aws_cdk.aws_globalaccelerator.RawEndpointProps(*, endpoint_id, preserve_client_ip=None, region=None, weight=None)

Bases: object

Properties for RawEndpoint.

Parameters

  • endpoint_id (str) – Identifier of the endpoint. Load balancer ARN, instance ID or EIP allocation ID.

  • preserve_client_ip (Optional[bool]) – 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. Default: true if possible and available

  • region (Optional[str]) – The region where this endpoint is located. Default: - Unknown what region this endpoint is located

  • weight (Union[int, float, None]) – Endpoint weight across all endpoints in the group. Must be a value between 0 and 255. Default: 128

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_globalaccelerator as globalaccelerator

raw_endpoint_props = globalaccelerator.RawEndpointProps(
    endpoint_id="endpointId",

    # the properties below are optional
    preserve_client_ip=False,
    region="region",
    weight=123
)

Attributes

endpoint_id

Identifier of the endpoint.

Load balancer ARN, instance ID or EIP allocation ID.

Return type

str

preserve_client_ip

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.

Default

true if possible and available

Return type

Optional[bool]

region

The region where this endpoint is located.

Default

  • Unknown what region this endpoint is located

Return type

Optional[str]

weight

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.

Default

128

Return type

Union[int, float, None]