AWS::Lightsail::Domain DomainEntry - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lightsail::Domain DomainEntry

Describes a domain recordset entry.

Syntax

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

JSON

{
  "Id" : String,
  "IsAlias" : Boolean,
  "Name" : String,
  "Target" : String,
  "Type" : String
}

YAML

  Id: String
  IsAlias: Boolean
  Name: String
  Target: String
  Type: String

Properties

Id

The ID of the domain recordset entry.

Required: No

Type: String

Pattern: .*\S.*

Update requires: No interruption

IsAlias

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.

Required: No

Type: Boolean

Update requires: No interruption

Name

The name of the domain.

Required: Yes

Type: String

Update requires: No interruption

Target

The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

Required: Yes

Type: String

Update requires: No interruption

Type

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • AAAA

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

Required: Yes

Type: String

Allowed values: A | AAAA | CNAME | MX | NS | SOA | SRV | TXT

Update requires: No interruption