Class CfnRecordSet
A CloudFormation AWS::Route53::RecordSet.
Inherited Members
Namespace: Amazon.CDK.AWS.Route53
Assembly: Amazon.CDK.AWS.Route53.dll
Syntax (csharp)
public class CfnRecordSet : CfnResource, IConstruct, IDependable, IInspectableSyntax (vb)
Public Class CfnRecordSet
Inherits CfnResource
Implements IConstruct, IDependable, IInspectableRemarks
Information about the record that you want to create.
The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup .
For more information, see ChangeResourceRecordSets in the Amazon Route 53 API Reference .
CloudformationResource: AWS::Route53::RecordSet
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Route53;
var cfnRecordSet = new CfnRecordSet(this, "MyCfnRecordSet", new CfnRecordSetProps {
Name = "name",
Type = "type",
// the properties below are optional
AliasTarget = new AliasTargetProperty {
DnsName = "dnsName",
HostedZoneId = "hostedZoneId",
// the properties below are optional
EvaluateTargetHealth = false
},
CidrRoutingConfig = new CidrRoutingConfigProperty {
CollectionId = "collectionId",
LocationName = "locationName"
},
Comment = "comment",
Failover = "failover",
GeoLocation = new GeoLocationProperty {
ContinentCode = "continentCode",
CountryCode = "countryCode",
SubdivisionCode = "subdivisionCode"
},
HealthCheckId = "healthCheckId",
HostedZoneId = "hostedZoneId",
HostedZoneName = "hostedZoneName",
MultiValueAnswer = false,
Region = "region",
ResourceRecords = new [] { "resourceRecords" },
SetIdentifier = "setIdentifier",
Ttl = "ttl",
Weight = 123
});Synopsis
Constructors
| CfnRecordSet(Construct, String, ICfnRecordSetProps) | Create a new |
| CfnRecordSet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnRecordSet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| AliasTarget | Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| CidrRoutingConfig | The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. |
| Comment | Optional: Any comments you want to include about a change batch request. |
| Failover | Failover resource record sets only: To configure failover, you add the |
| GeoLocation | Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. |
| HealthCheckId | If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the |
| HostedZoneId | The ID of the hosted zone that you want to create records in. |
| HostedZoneName | The name of the hosted zone that you want to create records in. |
| MultiValueAnswer | Multivalue answer resource record sets only : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify |
| Name | For |
| Region | Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. |
| ResourceRecords | One or more values that correspond with the value that you specified for the |
| SetIdentifier | Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of |
| Ttl | The resource record cache time to live (TTL), in seconds. Note the following:. |
| Type | The DNS record type. |
| Weight | Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRecordSet(Construct, String, ICfnRecordSetProps)
Create a new AWS::Route53::RecordSet.
public CfnRecordSet(Construct scope, string id, ICfnRecordSetProps props)Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRecordSetProps
- resource properties.
CfnRecordSet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRecordSet(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRecordSet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRecordSet(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AliasTarget
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
public virtual object AliasTarget { get; set; }Property Value
System.Object
Remarks
If you're creating resource records sets for a private hosted zone, note the following:
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CidrRoutingConfig
The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
public virtual object CidrRoutingConfig { get; set; }Property Value
System.Object
Remarks
A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.
Comment
Optional: Any comments you want to include about a change batch request.
public virtual string Comment { get; set; }Property Value
System.String
Remarks
Failover
Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets.
public virtual string Failover { get; set; }Property Value
System.String
Remarks
For one resource record set, you specify PRIMARY as the value for Failover ; for the other resource record set, you specify SECONDARY . In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:
You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide :
GeoLocation
Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
public virtual object GeoLocation { get; set; }Property Value
System.Object
Remarks
For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111 , create a resource record set with a Type of A and a ContinentCode of AF .
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is . Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a resource record set, Route 53 returns a "no answer" response for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.
HealthCheckId
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.
public virtual string HealthCheckId { get; set; }Property Value
System.String
Remarks
Route 53 determines whether a resource record set is healthy based on one of the following:
Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the <code>Value</code> element. When you add a <code>HealthCheckId</code> element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.
For more information, see the following topics in the Amazon Route 53 Developer Guide :
When to Specify HealthCheckId
Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a <em>group</em> of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has for CountryCode is , which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com . For the value of FullyQualifiedDomainName , specify the domain name of the server (such as us-east-2-www.example.com ), not the name of the resource record sets ( www.example.com ).
Health check results will be unpredictable if you do the following:
HostedZoneId
The ID of the hosted zone that you want to create records in.
public virtual string HostedZoneId { get; set; }Property Value
System.String
Remarks
Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .
HostedZoneName
The name of the hosted zone that you want to create records in.
public virtual string HostedZoneName { get; set; }Property Value
System.String
Remarks
You must include a trailing dot (for example, www.example.com. ) as part of the HostedZoneName .
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.
Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .
MultiValueAnswer
Multivalue answer resource record sets only : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer .
public virtual object MultiValueAnswer { get; set; }Property Value
System.Object
Remarks
Note the following:
You can't create multivalue answer alias records.
Name
For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete.
public virtual string Name { get; set; }Property Value
System.String
Remarks
For ListResourceRecordSets responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide .
You can use the asterisk () wildcard to replace the leftmost label in a domain name, for example, .example.com . Note the following:
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example, .example.com . You can't use an * for one of the middle labels, for example, marketing..example.com . In addition, the * must replace the entire label; for example, you can't specify prod*.example.com .
Region
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.
public virtual string Region { get; set; }Property Value
System.String
Remarks
The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
ResourceRecords
One or more values that correspond with the value that you specified for the Type property.
public virtual string[] ResourceRecords { get; set; }Property Value
System.String[]
Remarks
For example, if you specified A for Type , you specify one or more IP addresses in IPv4 format for ResourceRecords . For information about the format of values for each record type, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
Note the following:
SetIdentifier
Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.
public virtual string SetIdentifier { get; set; }Property Value
System.String
Remarks
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide .
Ttl
The resource record cache time to live (TTL), in seconds. Note the following:.
public virtual string Ttl { get; set; }Property Value
System.String
Remarks
Type
The DNS record type.
public virtual string Type { get; set; }Property Value
System.String
Remarks
For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF . RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1 , has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type .
Values for alias resource record sets:
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA .
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of <code>Type</code> is <code>CNAME</code> . This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Weight
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set.
public virtual Nullable<double> Weight { get; set; }Property Value
System.Nullable<System.Double>
Remarks
Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>