software.amazon.awscdk.services.globalaccelerator.endpoints

Interface InstanceEndpointProps

All Known Implementing Classes:

InstanceEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:05.014Z")
public interface InstanceEndpointProps

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 and Description
static class	InstanceEndpointProps.Builder A builder for InstanceEndpointProps
static class	InstanceEndpointProps.Jsii$Proxy An implementation for InstanceEndpointProps

Method Summary

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

Method Detail

getPreserveClientIp

default java.lang.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

default java.lang.Number getWeight()

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.

Default: 128

builder

static InstanceEndpointProps.Builder builder()

Returns:

a InstanceEndpointProps.Builder of InstanceEndpointProps