Package software.amazon.awscdk.services.globalaccelerator

Interface RawEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RawEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.538Z")
@Stability(Stable)
public interface RawEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for RawEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.globalaccelerator.*;
 RawEndpointProps rawEndpointProps = RawEndpointProps.builder()
         .endpointId("endpointId")
         // the properties below are optional
         .preserveClientIp(false)
         .region("region")
         .weight(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RawEndpointProps.Builder	A builder for RawEndpointProps
static final class	RawEndpointProps.Jsii$Proxy	An implementation for RawEndpointProps

Method Summary

Modifier and Type	Method	Description
static RawEndpointProps.Builder	builder()
String	getEndpointId()	Identifier of the endpoint.
default Boolean	getPreserveClientIp()	Forward the client IP address.
default String	getRegion()	The region where this endpoint is located.
default Number	getWeight()	Endpoint weight across all endpoints in the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointId

@Stability(Stable)
@NotNull
String getEndpointId()

Identifier of the endpoint.

Load balancer ARN, instance ID or EIP allocation ID.

getPreserveClientIp

@Stability(Stable)
@Nullable
default Boolean getPreserveClientIp()

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

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

The region where this endpoint is located.

Default: - Unknown what region this endpoint is located

getWeight

@Stability(Stable)
@Nullable
default Number getWeight()

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.

Default: 128

builder

@Stability(Stable)
static RawEndpointProps.Builder builder()

Returns:

a RawEndpointProps.Builder of RawEndpointProps