Package software.amazon.awscdk.services.globalaccelerator.endpoints

Interface InstanceEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InstanceEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:07.784Z")
@Stability(Stable)
public interface InstanceEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for a NetworkLoadBalancerEndpoint.

Example:

 Listener listener;
 Instance instance;
 listener.addEndpointGroup("Group", EndpointGroupOptions.builder()
         .endpoints(List.of(
             InstanceEndpoint.Builder.create(instance)
                     .weight(128)
                     .preserveClientIp(true)
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InstanceEndpointProps.Builder	builder()
default Boolean	getPreserveClientIp()	Forward the client IP address.
default Number	getWeight()	Endpoint weight across all endpoints in the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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.

Client IP address preservation is supported only in specific AWS Regions. See the GlobalAccelerator Developer Guide for a list.

Default: true if available

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 InstanceEndpointProps.Builder builder()

Returns:

a InstanceEndpointProps.Builder of InstanceEndpointProps