CfnLoadBalancer (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.094Z")
 @Stability(value=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 and Description
`static 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.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLoadBalancer(software.constructs.Construct scope, String id)` Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
	`CfnLoadBalancer(software.constructs.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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(IResolvable value)` The load balancer attributes.
`void`	`setLoadBalancerAttributes(List<Object> 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(IResolvable value)` The IDs of the public subnets.
`void`	`setSubnetMappings(List<Object> 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.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

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

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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 Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnLoadBalancer
```
protected CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnLoadBalancer
```
protected CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnLoadBalancer
```
@Stability(value=Stable)
public CfnLoadBalancer(@NotNull
                                                software.constructs.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(value=Stable)
public CfnLoadBalancer(@NotNull
                                                software.constructs.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 Detail
  - inspect
```
@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCanonicalHostedZoneId()
```
    The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    For example, Z2P70J7EXAMPLE .
  - getAttrDnsName
```
@Stability(value=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(value=Stable)
 @NotNull
public String getAttrLoadBalancerFullName()
```
    The full name of the load balancer.
    For example, app/my-load-balancer/50dc6c495c0c9188 .
  - getAttrLoadBalancerName
```
@Stability(value=Stable)
 @NotNull
public String getAttrLoadBalancerName()
```
    The name of the load balancer.
    For example, my-load-balancer .
  - getAttrSecurityGroups
```
@Stability(value=Stable)
 @NotNull
public List<String> getAttrSecurityGroups()
```
    The IDs of the security groups for the load balancer.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    The tags to assign to the load balancer.
  - getIpAddressType
```
@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getLoadBalancerAttributes()
```
    The load balancer attributes.
  - setLoadBalancerAttributes
```
@Stability(value=Stable)
public void setLoadBalancerAttributes(@Nullable
                                                               IResolvable value)
```
    The load balancer attributes.
  - setLoadBalancerAttributes
```
@Stability(value=Stable)
public void setLoadBalancerAttributes(@Nullable
                                                               List<Object> value)
```
    The load balancer attributes.
  - getName
```
@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public List<String> getSecurityGroups()
```
    [Application Load Balancers] The IDs of the security groups for the load balancer.
  - setSecurityGroups
```
@Stability(value=Stable)
public void setSecurityGroups(@Nullable
                                                       List<String> value)
```
    [Application Load Balancers] The IDs of the security groups for the load balancer.
  - getSubnetMappings
```
@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getType()
```
    The type of load balancer.
    The default is application .
  - setType
```
@Stability(value=Stable)
public void setType(@Nullable
                                             String value)
```
    The type of load balancer.
    The default is application .

Class CfnLoadBalancer

Nested Class Summary

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

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnLoadBalancer

CfnLoadBalancer

CfnLoadBalancer

CfnLoadBalancer

Method Detail

inspect

renderProperties

getAttrCanonicalHostedZoneId

getAttrDnsName

getAttrLoadBalancerFullName

getAttrLoadBalancerName

getAttrSecurityGroups

getCfnProperties

getTags

getIpAddressType

setIpAddressType

getLoadBalancerAttributes

setLoadBalancerAttributes

setLoadBalancerAttributes

getName

setName

getScheme

setScheme

getSecurityGroups

setSecurityGroups

getSubnetMappings

setSubnetMappings

setSubnetMappings

getSubnets

setSubnets

getType

setType