Syntax Properties Return values See also

AWS::ElasticLoadBalancingV2::LoadBalancer

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

Syntax

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

JSON


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

YAML


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

Properties

EnablePrefixForIpv6SourceNat

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.

Required: No

Type: String

Allowed values: on | off

Update requires: No interruption

EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.

Required: No

Type: String

Update requires: No interruption

IpAddressType

The IP address type. Internal load balancers must use ipv4.

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

Required: No

Type: String

Allowed values: ipv4 | dualstack | dualstack-without-public-ipv4

Update requires: No interruption

LoadBalancerAttributes

The load balancer attributes.

Required: No

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

The default is an Internet-facing load balancer.

You can't specify a scheme for a Gateway Load Balancer.

Required: No

Type: String

Allowed values: internet-facing | internal

Update requires: Replacement

SecurityGroups

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

Required: No

Type: Array of String

Update requires: No interruption

SubnetMappings

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

Required: Conditional

Type: Array of SubnetMapping

Update requires: No interruption

Subnets

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

Required: Conditional

Type: Array of String

Update requires: No interruption

Tags

The tags to assign to the load balancer.

Required: No

Type: Array of Tag

Minimum: 1

Update requires: No interruption

Type

The type of load balancer. The default is application.

Required: No

Type: String

Allowed values: application | network | gateway

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.
LoadBalancerArn: The Amazon Resource Name (ARN) of the load balancer.
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.