NetworkLoadBalancerProps Struct
Properties for a network load balancer.
Example
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,
});
Properties
clientRoutingPolicyClientRoutingPolicyclient_routing_policyClientRoutingPolicyclientRoutingPolicyClientRoutingPolicyClientRoutingPolicyClientRoutingPolicyClientRoutingPolicyClientRoutingPolicy#Default: AZ affinity is disabled.
crossZoneEnabledbooleancross_zone_enabledboolcrossZoneEnabledBooleanCrossZoneEnabledboolCrossZoneEnabled*bool#Default: false for Network Load Balancers and true for Application Load Balancers. This can not be false for Application Load Balancers.
deletionProtectionbooleandeletion_protectionbooldeletionProtectionBooleanDeletionProtectionboolDeletionProtection*bool= false#denyAllIgwTrafficbooleandeny_all_igw_trafficbooldenyAllIgwTrafficBooleanDenyAllIgwTrafficboolDenyAllIgwTraffic*bool#Default: false for internet-facing load balancers and true for internal load balancers
disableSecurityGroupsbooleandisable_security_groupsbooldisableSecurityGroupsBooleanDisableSecurityGroupsboolDisableSecurityGroups*bool= false#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.
enablePrefixForIpv6SourceNatbooleanenable_prefix_for_ipv6_source_natboolenablePrefixForIpv6SourceNatBooleanEnablePrefixForIpv6SourceNatboolEnablePrefixForIpv6SourceNat*bool#Default: undefined - NLB default behavior is false
The IP address type must be IpAddressType.DUALSTACK.
enforceSecurityGroupInboundRulesOnPrivateLinkTrafficbooleanenforce_security_group_inbound_rules_on_private_link_trafficboolenforceSecurityGroupInboundRulesOnPrivateLinkTrafficBooleanEnforceSecurityGroupInboundRulesOnPrivateLinkTrafficboolEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic*bool= true#internetFacingbooleaninternet_facingboolinternetFacingBooleanInternetFacingboolInternetFacing*bool= false#ipAddressTypeIpAddressTypeip_address_typeIpAddressTypeipAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressType= IpAddressType.IPV4#If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.
loadBalancerNamestringload_balancer_namestrloadBalancerNameStringLoadBalancerNamestringLoadBalancerName*string#Default: Automatically generated name.
minimumCapacityUnitnumberminimum_capacity_unitint | floatminimumCapacityUnitNumberMinimumCapacityUnitdoubleMinimumCapacityUnit*float64#Default: undefined - ELB default is 0 LCU
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup#Default: No security groups associated with the load balancer.
subnetMappingsSubnetMapping[]subnet_mappingstyping.List[SubnetMapping]subnetMappingsList<SubnetMapping>SubnetMappingsSubnetMapping[]SubnetMappings*[]SubnetMapping#Default: undefined - The VPC default strategy for subnets is used
vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection#Default: the Vpc default strategy.