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

Interface NetworkLoadBalancerEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NetworkLoadBalancerEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:21.706Z")
@Stability(Stable)
public interface NetworkLoadBalancerEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for a NetworkLoadBalancerEndpoint.

Example:

 NetworkLoadBalancer nlb;
 Listener listener;
 listener.addEndpointGroup("Group", EndpointGroupOptions.builder()
         .endpoints(List.of(
             NetworkLoadBalancerEndpoint.Builder.create(nlb)
                     .weight(128)
                     .preserveClientIp(true)
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NetworkLoadBalancerEndpointProps.Builder	builder()
default Boolean	getPreserveClientIp()	Forward the client IP address in an X-Forwarded-For header.
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 in an X-Forwarded-For header.

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: false

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

Returns:

a NetworkLoadBalancerEndpointProps.Builder of NetworkLoadBalancerEndpointProps