AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

AWS::Route53::RecordSetGroup

Note

Before you use AWS CloudFormation to add a record set to a hosted zone, that hosted zone must already be created in Amazon Route 53. AWS CloudFormation does not create new hosted zones.

This type supports updates. For details and constraints on updates for resource record sets, see Changing Your Resource Record Sets. For more information about updating stacks, see AWS CloudFormation Stacks Updates.

For more information about constraints and values for each property, see POST CreateHostedZone for hosted zones and POST ChangeResourceRecordSet for resource record sets.

Syntax

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

Properties

HostedZoneId

The ID of the hosted zone.

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

Type: String

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

RecordSets

List of resource record sets to add.

Required: Yes

Type: list of AWS::Route53::RecordSet

Comment

Any comments you want to include about the hosted zone.

Required: No

Type: String

Return Value

When the logical ID of this resource is provided to the Ref intrinsic function, it 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.

Template Examples

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