Skip to content
v2.278.0

NetworkLoadBalancerProps Struct ​

Properties for a network load balancer.

Example ​

ts
declare const vpc: ec2.Vpc;

const lb = new elbv2.NetworkLoadBalancer(this, 'LB', {
  vpc,
  ipAddressType: elbv2.IpAddressType.DUAL_STACK,
  enablePrefixForIpv6SourceNat: true,
});

const listener = lb.addListener('Listener', {
  port: 1229,
  protocol: elbv2.Protocol.UDP,
});
python
# vpc: ec2.Vpc


lb = elbv2.NetworkLoadBalancer(self, "LB",
    vpc=vpc,
    ip_address_type=elbv2.IpAddressType.DUAL_STACK,
    enable_prefix_for_ipv6_source_nat=True
)

listener = lb.add_listener("Listener",
    port=1229,
    protocol=elbv2.Protocol.UDP
)
java
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());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Vpc vpc;


var lb = new NetworkLoadBalancer(this, "LB", new NetworkLoadBalancerProps {
    Vpc = vpc,
    IpAddressType = IpAddressType.DUAL_STACK,
    EnablePrefixForIpv6SourceNat = true
});

var listener = lb.AddListener("Listener", new BaseNetworkListenerProps {
    Port = 1229,
    Protocol = Protocol.UDP
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc


lb := elbv2.NewNetworkLoadBalancer(this, jsii.String("LB"), &NetworkLoadBalancerProps{
	Vpc: Vpc,
	IpAddressType: elbv2.IpAddressType_DUAL_STACK,
	EnablePrefixForIpv6SourceNat: jsii.Boolean(true),
})

listener := lb.AddListener(jsii.String("Listener"), &BaseNetworkListenerProps{
	Port: jsii.Number(1229),
	Protocol: elbv2.Protocol_UDP,
})

Properties ​

clientRoutingPolicyoptionalClientRoutingPolicyclient_routing_policyoptionalClientRoutingPolicyclientRoutingPolicyoptionalClientRoutingPolicyClientRoutingPolicyoptionalClientRoutingPolicyClientRoutingPolicyoptionalClientRoutingPolicy #
The AZ affinity routing policy.

Default: AZ affinity is disabled.

crossZoneEnabledoptionalbooleancross_zone_enabledoptionalboolcrossZoneEnabledoptionalBooleanCrossZoneEnabledoptionalboolCrossZoneEnabledoptional*bool #
Indicates whether cross-zone load balancing is enabled.

Default: false for Network Load Balancers and true for Application Load Balancers. This can not be false for Application Load Balancers.

deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool = false #
Indicates whether deletion protection is enabled.
denyAllIgwTrafficoptionalbooleandeny_all_igw_trafficoptionalbooldenyAllIgwTrafficoptionalBooleanDenyAllIgwTrafficoptionalboolDenyAllIgwTrafficoptional*bool #
Indicates whether the load balancer blocks traffic through the Internet Gateway (IGW).

Default: false for internet-facing load balancers and true for internal load balancers

disableSecurityGroupsoptionalbooleandisable_security_groupsoptionalbooldisableSecurityGroupsoptionalBooleanDisableSecurityGroupsoptionalboolDisableSecurityGroupsoptional*bool = false #
Create a Network Load Balancer without security groups.
notes

When true, creates an NLB that cannot have security groups attached. This is useful when you need to create a traditional NLB without security group associations.

This property only takes effect when the feature flag @aws-cdk/aws-elasticloadbalancingv2:networkLoadBalancerWithSecurityGroupByDefault is enabled.

enablePrefixForIpv6SourceNatoptionalbooleanenable_prefix_for_ipv6_source_natoptionalboolenablePrefixForIpv6SourceNatoptionalBooleanEnablePrefixForIpv6SourceNatoptionalboolEnablePrefixForIpv6SourceNatoptional*bool #
Indicates whether to use an IPv6 prefix from each subnet for source NAT.

Default: undefined - NLB default behavior is false

The IP address type must be IpAddressType.DUALSTACK.

enforceSecurityGroupInboundRulesOnPrivateLinkTrafficoptionalbooleanenforce_security_group_inbound_rules_on_private_link_trafficoptionalboolenforceSecurityGroupInboundRulesOnPrivateLinkTrafficoptionalBooleanEnforceSecurityGroupInboundRulesOnPrivateLinkTrafficoptionalboolEnforceSecurityGroupInboundRulesOnPrivateLinkTrafficoptional*bool = true #
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.
internetFacingoptionalbooleaninternet_facingoptionalboolinternetFacingoptionalBooleanInternetFacingoptionalboolInternetFacingoptional*bool = false #
Whether the load balancer has an internet-routable address.
ipAddressTypeoptionalIpAddressTypeip_address_typeoptionalIpAddressTypeipAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressType = IpAddressType.IPV4 #
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.

loadBalancerNameoptionalstringload_balancer_nameoptionalstrloadBalancerNameoptionalStringLoadBalancerNameoptionalstringLoadBalancerNameoptional*string #
Name of the load balancer.

Default: Automatically generated name.

minimumCapacityUnitoptionalnumberminimum_capacity_unitoptionalint | floatminimumCapacityUnitoptionalNumberMinimumCapacityUnitoptionaldoubleMinimumCapacityUnitoptional*float64 #
The minimum capacity (LCU) for a load balancer.

Default: undefined - ELB default is 0 LCU

securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup #
Security groups to associate with this load balancer.

Default: No security groups associated with the load balancer.

subnetMappingsoptionalSubnetMapping[]subnet_mappingsoptionaltyping.List[SubnetMapping]subnetMappingsoptionalList<SubnetMapping>SubnetMappingsoptionalSubnetMapping[]SubnetMappingsoptional*[]SubnetMapping #
Subnet information for the load balancer.

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

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc required #
The VPC network to place the load balancer in.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #
Which subnets place the load balancer in.

Default: the Vpc default strategy.

zonalShiftoptionalbooleanzonal_shiftoptionalboolzonalShiftoptionalBooleanZonalShiftoptionalboolZonalShiftoptional*bool = false #
Indicates whether zonal shift is enabled.