Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface NetworkLoadBalancerProps

All Superinterfaces:

BaseLoadBalancerProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NetworkLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-03T14:44:51.446Z")
@Stability(Stable)
public interface NetworkLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable, BaseLoadBalancerProps

Properties for a network load balancer.

Example:

 Vpc vpc;
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .ipAddressType(IpAddressType.DUAL_STACK)
         .enablePrefixForIpv6SourceNat(true)
         .build();
 NetworkListener listener = lb.addListener("Listener", BaseNetworkListenerProps.builder()
         .port(1229)
         .protocol(Protocol.UDP)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NetworkLoadBalancerProps.Builder	builder()
default ClientRoutingPolicy	getClientRoutingPolicy()	The AZ affinity routing policy.
default Boolean	getEnablePrefixForIpv6SourceNat()	Indicates whether to use an IPv6 prefix from each subnet for source NAT.
default Boolean	getEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic()	Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.
default IpAddressType	getIpAddressType()	The type of IP addresses to use.
default List<ISecurityGroup>	getSecurityGroups()	Security groups to associate with this load balancer.
default List<SubnetMapping>	getSubnetMappings()	Subnet information for the load balancer.
default Boolean	getZonalShift()	Indicates whether zonal shift is enabled.

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancerProps

getCrossZoneEnabled, getDeletionProtection, getDenyAllIgwTraffic, getInternetFacing, getLoadBalancerName, getMinimumCapacityUnit, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientRoutingPolicy

@Stability(Stable)
@Nullable
default ClientRoutingPolicy getClientRoutingPolicy()

The AZ affinity routing policy.

Default: - AZ affinity is disabled.

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#zonal-dns-affinity

getEnablePrefixForIpv6SourceNat

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

Indicates whether to use an IPv6 prefix from each subnet for source NAT.

The IP address type must be IpAddressType.DUALSTACK.

Default: undefined - NLB default behavior is false

getEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic

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

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.

Default: true

getIpAddressType

@Stability(Stable)
@Nullable
default IpAddressType getIpAddressType()

The type of IP addresses to use.

If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.

Default: IpAddressType.IPV4

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

Security groups to associate with this load balancer.

Default: - No security groups associated with the load balancer.

getSubnetMappings

@Stability(Stable)
@Nullable
default List<SubnetMapping> getSubnetMappings()

Subnet information for the load balancer.

Default: undefined - The VPC default strategy for subnets is used

getZonalShift

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

Indicates whether zonal shift is enabled.

Default: false

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/network/zonal-shift.html

builder

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

Returns:

a NetworkLoadBalancerProps.Builder of NetworkLoadBalancerProps