AWS CloudFormation
User Guide (Version )

AWS::ElasticLoadBalancingV2::LoadBalancer

Specifies an Application Load Balancer or a Network Load Balancer.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ElasticLoadBalancingV2::LoadBalancer", "Properties" : { "IpAddressType" : String, "LoadBalancerAttributes" : [ LoadBalancerAttribute, ... ], "Name" : String, "Scheme" : String, "SecurityGroups" : [ String, ... ], "SubnetMappings" : [ SubnetMapping, ... ], "Subnets" : [ String, ... ], "Tags" : [ Tag, ... ], "Type" : String } }

YAML

Type: AWS::ElasticLoadBalancingV2::LoadBalancer Properties: IpAddressType: String LoadBalancerAttributes: - LoadBalancerAttribute Name: String Scheme: String SecurityGroups: - String SubnetMappings: - SubnetMapping Subnets: - String Tags: - Tag Type: String

Properties

IpAddressType

The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. Network Load Balancers must use ipv4.

Required: No

Type: String

Allowed Values: dualstack | ipv4

Update requires: No interruption

LoadBalancerAttributes

The load balancer attributes.

Required: No

Type: List of LoadBalancerAttribute

Maximum: 20

Update requires: No interruption

Name

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.

Required: No

Type: String

Update requires: Replacement

Scheme

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 only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

Required: No

Type: String

Allowed Values: internal | internet-facing

Update requires: Replacement

SecurityGroups

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

Required: No

Type: List of String

Update requires: No interruption

SubnetMappings

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet.

Required: No

Type: List of SubnetMapping

Update requires: Replacement

Subnets

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. When you specify subnets for an existing Application Load Balancer, they replace the previously enabled subnets.

[Network Load Balancers] You can specify subnets from one or more Availability Zones when you create the load balancer. You can't change the subnets for an existing Network Load Balancer.

Required: No

Type: List of String

Update requires: No interruption

Tags

The tags. Each resource can have a maximum of 10 tags.

Required: No

Type: List of Tag

Update requires: No interruption

Type

The type of load balancer. The default is application.

Required: No

Type: String

Allowed Values: application | network

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the load balancer.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CanonicalHostedZoneID

The ID of the Amazon Route 53 hosted zone associated with the load balancer. For example, Z2P70J7EXAMPLE.

DNSName

The DNS name for the load balancer. For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com.

LoadBalancerFullName

The full name of the load balancer. For example, app/my-load-balancer/50dc6c495c0c9188.

LoadBalancerName

The name of the load balancer. For example, my-load-balancer.

SecurityGroups

The IDs of the security groups for the load balancer.

See Also