Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnLoadBalancer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:15.872Z")
@Stability(Stable)
public class CfnLoadBalancer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElasticLoadBalancingV2::LoadBalancer`.

Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

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.*;
 CfnLoadBalancer cfnLoadBalancer = CfnLoadBalancer.Builder.create(this, "MyCfnLoadBalancer")
         .ipAddressType("ipAddressType")
         .loadBalancerAttributes(List.of(LoadBalancerAttributeProperty.builder()
                 .key("key")
                 .value("value")
                 .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")
                 .build()))
         .subnets(List.of("subnets"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnLoadBalancer.Builder	A fluent builder for CfnLoadBalancer.
static interface	CfnLoadBalancer.LoadBalancerAttributeProperty	Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
static interface	CfnLoadBalancer.SubnetMappingProperty	Specifies a subnet for a load balancer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnLoadBalancer(Construct scope, String id)	Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
	CfnLoadBalancer(Construct scope, String id, CfnLoadBalancerProps props)	Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
protected	CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAttrCanonicalHostedZoneId()	The ID of the Amazon Route 53 hosted zone associated with the load balancer.
String	getAttrDnsName()	The DNS name for the load balancer.
String	getAttrLoadBalancerFullName()	The full name of the load balancer.
String	getAttrLoadBalancerName()	The name of the load balancer.
List<String>	getAttrSecurityGroups()	The IDs of the security groups for the load balancer.
protected Map<String,Object>	getCfnProperties()
String	getIpAddressType()	The IP address type.
Object	getLoadBalancerAttributes()	The load balancer attributes.
String	getName()	The name of the load balancer.
String	getScheme()	The nodes of an Internet-facing load balancer have public IP addresses.
List<String>	getSecurityGroups()	[Application Load Balancers] The IDs of the security groups for the load balancer.
Object	getSubnetMappings()	The IDs of the public subnets.
List<String>	getSubnets()	The IDs of the public subnets.
TagManager	getTags()	The tags to assign to the load balancer.
String	getType()	The type of load balancer.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setIpAddressType(String value)	The IP address type.
void	setLoadBalancerAttributes(List<Object> value)	The load balancer attributes.
void	setLoadBalancerAttributes(IResolvable value)	The load balancer attributes.
void	setName(String value)	The name of the load balancer.
void	setScheme(String value)	The nodes of an Internet-facing load balancer have public IP addresses.
void	setSecurityGroups(List<String> value)	[Application Load Balancers] The IDs of the security groups for the load balancer.
void	setSubnetMappings(List<Object> value)	The IDs of the public subnets.
void	setSubnetMappings(IResolvable value)	The IDs of the public subnets.
void	setSubnets(List<String> value)	The IDs of the public subnets.
void	setType(String value)	The type of load balancer.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnLoadBalancer

protected CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)

CfnLoadBalancer

protected CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLoadBalancer

@Stability(Stable)
public CfnLoadBalancer(@NotNull
 Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnLoadBalancerProps props)

Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnLoadBalancer

@Stability(Stable)
public CfnLoadBalancer(@NotNull
 Construct scope,
 @NotNull
 String id)

Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCanonicalHostedZoneId

@Stability(Stable)
@NotNull
public String getAttrCanonicalHostedZoneId()

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

For example, Z2P70J7EXAMPLE .

getAttrDnsName

@Stability(Stable)
@NotNull
public String getAttrDnsName()

The DNS name for the load balancer.

For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com .

getAttrLoadBalancerFullName

@Stability(Stable)
@NotNull
public String getAttrLoadBalancerFullName()

The full name of the load balancer.

For example, app/my-load-balancer/50dc6c495c0c9188 .

getAttrLoadBalancerName

@Stability(Stable)
@NotNull
public String getAttrLoadBalancerName()

The name of the load balancer.

For example, my-load-balancer .

getAttrSecurityGroups

@Stability(Stable)
@NotNull
public List<String> getAttrSecurityGroups()

The IDs of the security groups for the load balancer.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

The tags to assign to the load balancer.

getIpAddressType

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

The IP address type.

The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.

setIpAddressType

@Stability(Stable)
public void setIpAddressType(@Nullable
 String value)

The IP address type.

The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.

getLoadBalancerAttributes

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

The load balancer attributes.

setLoadBalancerAttributes

@Stability(Stable)
public void setLoadBalancerAttributes(@Nullable
 IResolvable value)

The load balancer attributes.

setLoadBalancerAttributes

@Stability(Stable)
public void setLoadBalancerAttributes(@Nullable
 List<Object> value)

The load balancer attributes.

getName

@Stability(Stable)
@Nullable
public 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.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

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.

getScheme

@Stability(Stable)
@Nullable
public 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 cannot specify a scheme for a Gateway Load Balancer.

setScheme

@Stability(Stable)
public void setScheme(@Nullable
 String value)

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 cannot specify a scheme for a Gateway Load Balancer.

getSecurityGroups

@Stability(Stable)
@Nullable
public List<String> getSecurityGroups()

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

setSecurityGroups

@Stability(Stable)
public void setSecurityGroups(@Nullable
 List<String> value)

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

getSubnetMappings

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

The IDs of the public 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 cannot 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 cannot specify Elastic IP addresses for your subnets.

setSubnetMappings

@Stability(Stable)
public void setSubnetMappings(@Nullable
 IResolvable value)

The IDs of the public 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 cannot 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 cannot specify Elastic IP addresses for your subnets.

setSubnetMappings

@Stability(Stable)
public void setSubnetMappings(@Nullable
 List<Object> value)

The IDs of the public 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 cannot 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 cannot specify Elastic IP addresses for your subnets.

getSubnets

@Stability(Stable)
@Nullable
public List<String> getSubnets()

The IDs of the public 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] You can specify subnets from one or more Availability Zones.

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

setSubnets

@Stability(Stable)
public void setSubnets(@Nullable
 List<String> value)

The IDs of the public 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] You can specify subnets from one or more Availability Zones.

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

getType

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

The type of load balancer.

The default is application .

setType

@Stability(Stable)
public void setType(@Nullable
 String value)

The type of load balancer.

The default is application .