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.104.0 (build e79254c)",
           date="2024-11-21T06:34:08.219Z")
@Stability(Stable)
public interface NetworkLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable, BaseLoadBalancerProps

Properties for a network load balancer.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpNlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "lb").vpc(vpc).build();
 NetworkListener listener = lb.addListener("listener", BaseNetworkListenerProps.builder().port(80).build());
 listener.addTargets("target", AddNetworkTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(new HttpNlbIntegration("DefaultIntegration", listener))
         .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	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 Boolean	getZonalShift()	Indicates whether zonal shift is enabled.

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

getCrossZoneEnabled, getDeletionProtection, getDenyAllIgwTraffic, getInternetFacing, getLoadBalancerName, 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

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.

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