CfnLoadBalancer

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.609Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLoadBalancer(Construct scope, java.lang.String id)` Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
	`CfnLoadBalancer(Construct scope, java.lang.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
`java.lang.String`	`getAttrCanonicalHostedZoneId()` The ID of the Amazon Route 53 hosted zone associated with the load balancer.
`java.lang.String`	`getAttrDnsName()` The DNS name for the load balancer.
`java.lang.String`	`getAttrLoadBalancerFullName()` The full name of the load balancer.
`java.lang.String`	`getAttrLoadBalancerName()` The name of the load balancer.
`java.util.List<java.lang.String>`	`getAttrSecurityGroups()` The IDs of the security groups for the load balancer.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getIpAddressType()` The IP address type.
`java.lang.Object`	`getLoadBalancerAttributes()` The load balancer attributes.
`java.lang.String`	`getName()` The name of the load balancer.
`java.lang.String`	`getScheme()` The nodes of an Internet-facing load balancer have public IP addresses.
`java.util.List<java.lang.String>`	`getSecurityGroups()` [Application Load Balancers] The IDs of the security groups for the load balancer.
`java.lang.Object`	`getSubnetMappings()` The IDs of the public subnets.
`java.util.List<java.lang.String>`	`getSubnets()` The IDs of the public subnets.
`TagManager`	`getTags()` The tags to assign to the load balancer.
`java.lang.String`	`getType()` The type of load balancer.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setIpAddressType(java.lang.String value)` The IP address type.
`void`	`setLoadBalancerAttributes(IResolvable value)` The load balancer attributes.
`void`	`setLoadBalancerAttributes(java.util.List<java.lang.Object> value)` The load balancer attributes.
`void`	`setName(java.lang.String value)` The name of the load balancer.
`void`	`setScheme(java.lang.String value)` The nodes of an Internet-facing load balancer have public IP addresses.
`void`	`setSecurityGroups(java.util.List<java.lang.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(java.util.List<java.lang.Object> value)` The IDs of the public subnets.
`void`	`setSubnets(java.util.List<java.lang.String> value)` The IDs of the public subnets.
`void`	`setType(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnLoadBalancer(Construct scope,
                       java.lang.String id,
                       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
```
public CfnLoadBalancer(Construct scope,
                       java.lang.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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrCanonicalHostedZoneId
```
public java.lang.String getAttrCanonicalHostedZoneId()
```
    The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    For example, Z2P70J7EXAMPLE .
  - getAttrDnsName
```
public java.lang.String getAttrDnsName()
```
    The DNS name for the load balancer.
    For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com .
  - getAttrLoadBalancerFullName
```
public java.lang.String getAttrLoadBalancerFullName()
```
    The full name of the load balancer.
    For example, app/my-load-balancer/50dc6c495c0c9188 .
  - getAttrLoadBalancerName
```
public java.lang.String getAttrLoadBalancerName()
```
    The name of the load balancer.
    For example, my-load-balancer .
  - getAttrSecurityGroups
```
public java.util.List<java.lang.String> getAttrSecurityGroups()
```
    The IDs of the security groups for the load balancer.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to assign to the load balancer.
  - getIpAddressType
```
public java.lang.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
```
public void setIpAddressType(java.lang.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
```
public java.lang.Object getLoadBalancerAttributes()
```
    The load balancer attributes.
  - setLoadBalancerAttributes
```
public void setLoadBalancerAttributes(IResolvable value)
```
    The load balancer attributes.
  - setLoadBalancerAttributes
```
public void setLoadBalancerAttributes(java.util.List<java.lang.Object> value)
```
    The load balancer attributes.
  - getName
```
public java.lang.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
```
public void setName(java.lang.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
```
public java.lang.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
```
public void setScheme(java.lang.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
```
public java.util.List<java.lang.String> getSecurityGroups()
```
    [Application Load Balancers] The IDs of the security groups for the load balancer.
  - setSecurityGroups
```
public void setSecurityGroups(java.util.List<java.lang.String> value)
```
    [Application Load Balancers] The IDs of the security groups for the load balancer.
  - getSubnetMappings
```
public java.lang.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
```
public void setSubnetMappings(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
```
public void setSubnetMappings(java.util.List<java.lang.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
```
public java.util.List<java.lang.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
```
public void setSubnets(java.util.List<java.lang.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
```
public java.lang.String getType()
```
    The type of load balancer.
    The default is application .
  - setType
```
public void setType(java.lang.String value)
```
    The type of load balancer.
    The default is application .

Class CfnLoadBalancer

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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