Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Route 53 Resource Types Reference » AWS::Route53::RecordSetGroup

AWS::Route53::RecordSetGroup

The AWS::Route53::RecordSetGroup resource creates record sets for a hosted zone. For more information about constraints and values for each property, see POST CreateHostedZone for hosted zones and POST ChangeResourceRecordSet for resource record sets.

Syntax

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

JSON

{
   "Type" : "AWS::Route53::RecordSetGroup",
   "Properties" : {
      "Comment" : String,
      "HostedZoneId" : String,
      "HostedZoneName" : String,
      "RecordSets" : [ RecordSet1, ... ]
   }
}

YAML

Type: AWS::Route53::RecordSetGroup
Properties: 
  Comment: String
  HostedZoneId: String
  HostedZoneName: String
  RecordSets:
    - RecordSet1

Properties

Comment

Any comments you want to include about the change batch.

Required: No

Type: String

Update requires: No interruption

HostedZoneId

The ID of the hosted zone.

Required: Conditional: You must specify either the HostedZoneName or HostedZoneId, but you cannot specify both.

Type: String

Update requires: Replacement

HostedZoneName

The name of the domain for the hosted zone where you want to add the record set.

When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.

If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using HostedZoneId.

Required: Conditional. You must specify either the HostedZoneName or HostedZoneId, but you cannot specify both.

Type: String

Update requires: Replacement

RecordSets

List of resource record sets to add. The maximum number of records is 1,000.

Required: Yes

Type:: List of AWS::Route53::RecordSet objects, as shown in the following example: 

"RecordSets" : [
  {
    "Name" : "mysite.example.com.",
    "Type" : "CNAME",
    "TTL" : "900",
    "SetIdentifier" : "Frontend One",
    "Weight" : "4",
    "ResourceRecords" : ["example-ec2.amazonaws.com"]
  },
  {
    "Name" : "mysite.example.com.",
    "Type" : "CNAME",
    "TTL" : "900",
    "SetIdentifier" : "Frontend Two",
    "Weight" : "6",
    "ResourceRecords" : ["example-ec2-larger.amazonaws.com"]
  }
]

Update requires: No interruption

Return Value

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name. For example: 

{ "Ref": "MyRecordSetGroup" }

For the resource with the logical ID "MyRecordSetGroup", Ref will return the AWS resource name.

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

Examples

For AWS::Route53::RecordSetGroup snippets, see Route 53 Template Snippets.