Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnLoadBalancerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:18.721Z")
@Stability(Stable)
public interface CfnLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLoadBalancer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 CfnLoadBalancerProps cfnLoadBalancerProps = CfnLoadBalancerProps.builder()
         .enableCapacityReservationProvisionStabilize(false)
         .enablePrefixForIpv6SourceNat("enablePrefixForIpv6SourceNat")
         .enforceSecurityGroupInboundRulesOnPrivateLinkTraffic("enforceSecurityGroupInboundRulesOnPrivateLinkTraffic")
         .ipAddressType("ipAddressType")
         .ipv4IpamPoolId("ipv4IpamPoolId")
         .loadBalancerAttributes(List.of(LoadBalancerAttributeProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .minimumLoadBalancerCapacity(MinimumLoadBalancerCapacityProperty.builder()
                 .capacityUnits(123)
                 .build())
         .name("name")
         .scheme("scheme")
         .securityGroups(List.of("securityGroups"))
         .subnetMappings(List.of(SubnetMappingProperty.builder()
                 .subnetId("subnetId")
                 // the properties below are optional
                 .allocationId("allocationId")
                 .iPv6Address("iPv6Address")
                 .privateIPv4Address("privateIPv4Address")
                 .sourceNatIpv6Prefix("sourceNatIpv6Prefix")
                 .build()))
         .subnets(List.of("subnets"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLoadBalancerProps.Builder	builder()
default Object	getEnableCapacityReservationProvisionStabilize()	Indicates whether to enable stabilization when creating or updating an LCU reservation.
default String	getEnablePrefixForIpv6SourceNat()	[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
default String	getEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic()	Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .
default String	getIpAddressType()	The IP address type.
default String	getIpv4IpamPoolId()	The ID of the IPv4 IPAM pool.
default Object	getLoadBalancerAttributes()	The load balancer attributes.
default Object	getMinimumLoadBalancerCapacity()	The minimum capacity for a load balancer.
default String	getName()	The name of the load balancer.
default String	getScheme()	The nodes of an Internet-facing load balancer have public IP addresses.
default List<Object>	getSecurityGroups()	[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
default Object	getSubnetMappings()	The IDs of the subnets.
default List<Object>	getSubnets()	The IDs of the subnets.
default List<CfnTag>	getTags()	The tags to assign to the load balancer.
default String	getType()	The type of load balancer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnableCapacityReservationProvisionStabilize

@Stability(Stable)
@Nullable
default Object getEnableCapacityReservationProvisionStabilize()

Indicates whether to enable stabilization when creating or updating an LCU reservation.

This ensures that the final stack status reflects the status of the LCU reservation. The default is false .

Returns union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enablecapacityreservationprovisionstabilize

getEnablePrefixForIpv6SourceNat

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

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.

The IP address type must be dualstack . The default value is off .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enableprefixforipv6sourcenat

getEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic

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

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

The default is on .

You can't configure this property on a Network Load Balancer unless you associated a security group with the load balancer when you created it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enforcesecuritygroupinboundrulesonprivatelinktraffic

getIpAddressType

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

The IP address type. Internal load balancers must use ipv4 .

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype

getIpv4IpamPoolId

@Stability(Stable)
@Nullable
default String getIpv4IpamPoolId()

The ID of the IPv4 IPAM pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipv4ipampoolid

getLoadBalancerAttributes

@Stability(Stable)
@Nullable
default Object getLoadBalancerAttributes()

The load balancer attributes.

Attributes that you do not modify retain their current values.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLoadBalancer.LoadBalancerAttributeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes

getMinimumLoadBalancerCapacity

@Stability(Stable)
@Nullable
default Object getMinimumLoadBalancerCapacity()

The minimum capacity for a load balancer.

Returns union: either IResolvable or CfnLoadBalancer.MinimumLoadBalancerCapacityProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name

getScheme

@Stability(Stable)
@Nullable
default String getScheme()

The nodes of an Internet-facing load balancer have public IP addresses.

The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

You can't specify a scheme for a Gateway Load Balancer.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme

getSecurityGroups

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

[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.

Returns union: Listinvalid input: '<'either String or ISecurityGroupRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups

getSubnetMappings

@Stability(Stable)
@Nullable
default Object getSubnetMappings()

The IDs of the subnets.

You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLoadBalancer.SubnetMappingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings

getSubnets

@Stability(Stable)
@Nullable
default List<Object> getSubnets()

The IDs of the subnets.

You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

Returns union: Listinvalid input: '<'either String or ISubnetRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to assign to the load balancer.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags

getType

@Stability(Stable)
@Nullable
default String getType()

The type of load balancer.

The default is application .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type

builder

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

Returns:

a CfnLoadBalancerProps.Builder of CfnLoadBalancerProps