software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnLoadBalancerProps

All Known Implementing Classes:

CfnLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:07.901Z")
public interface CfnLoadBalancerProps

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()
         .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	Interface and Description
static class	CfnLoadBalancerProps.Builder A builder for CfnLoadBalancerProps
static class	CfnLoadBalancerProps.Jsii$Proxy An implementation for CfnLoadBalancerProps

Method Summary

Modifier and Type	Method and Description
static CfnLoadBalancerProps.Builder	builder()
default java.lang.String	getIpAddressType() The IP address type.
default java.lang.Object	getLoadBalancerAttributes() The load balancer attributes.
default java.lang.String	getName() The name of the load balancer.
default java.lang.String	getScheme() The nodes of an Internet-facing load balancer have public IP addresses.
default java.util.List<java.lang.String>	getSecurityGroups() [Application Load Balancers] The IDs of the security groups for the load balancer.
default java.lang.Object	getSubnetMappings() The IDs of the public subnets.
default java.util.List<java.lang.String>	getSubnets() The IDs of the public subnets.
default java.util.List<CfnTag>	getTags() The tags to assign to the load balancer.
default java.lang.String	getType() The type of load balancer.

Method Detail

getIpAddressType

default 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.

getLoadBalancerAttributes

default java.lang.Object getLoadBalancerAttributes()

The load balancer attributes.

getName

default 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.

getScheme

default 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.

getSecurityGroups

default java.util.List<java.lang.String> getSecurityGroups()

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

getSubnetMappings

default 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.

getSubnets

default 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.

getTags

default java.util.List<CfnTag> getTags()

The tags to assign to the load balancer.

getType

default java.lang.String getType()

The type of load balancer.

The default is application .

builder

static CfnLoadBalancerProps.Builder builder()

Returns:

a CfnLoadBalancerProps.Builder of CfnLoadBalancerProps