CfnRecordSet L1 construct

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 .

CloudFormation: AWS::Route53::RecordSet
Source: Generated code
Type last changed: v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_route53 as route53 } from 'aws-cdk-lib';
const cfnRecordSet = new route53.CfnRecordSet(this, 'MyCfnRecordSet', {
  name: 'name',
  type: 'type',

  // the properties below are optional
  aliasTarget: {
    dnsName: 'dnsName',
    hostedZoneId: 'hostedZoneId',

    // the properties below are optional
    evaluateTargetHealth: false,
  },
  cidrRoutingConfig: {
    collectionId: 'collectionId',
    locationName: 'locationName',
  },
  comment: 'comment',
  failover: 'failover',
  geoLocation: {
    continentCode: 'continentCode',
    countryCode: 'countryCode',
    subdivisionCode: 'subdivisionCode',
  },
  healthCheckId: 'healthCheckId',
  hostedZoneId: 'hostedZoneId',
  hostedZoneName: 'hostedZoneName',
  multiValueAnswer: false,
  region: 'region',
  resourceRecords: ['resourceRecords'],
  setIdentifier: 'setIdentifier',
  ttl: 'ttl',
  weight: 123,
});

python

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

cfn_record_set = route53.CfnRecordSet(self, "MyCfnRecordSet",
    name="name",
    type="type",

    # the properties below are optional
    alias_target=route53.CfnRecordSet.AliasTargetProperty(
        dns_name="dnsName",
        hosted_zone_id="hostedZoneId",

        # the properties below are optional
        evaluate_target_health=False
    ),
    cidr_routing_config=route53.CfnRecordSet.CidrRoutingConfigProperty(
        collection_id="collectionId",
        location_name="locationName"
    ),
    comment="comment",
    failover="failover",
    geo_location=route53.CfnRecordSet.GeoLocationProperty(
        continent_code="continentCode",
        country_code="countryCode",
        subdivision_code="subdivisionCode"
    ),
    health_check_id="healthCheckId",
    hosted_zone_id="hostedZoneId",
    hosted_zone_name="hostedZoneName",
    multi_value_answer=False,
    region="region",
    resource_records=["resourceRecords"],
    set_identifier="setIdentifier",
    ttl="ttl",
    weight=123
)

java

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.route53.*;

CfnRecordSet cfnRecordSet = CfnRecordSet.Builder.create(this, "MyCfnRecordSet")
        .name("name")
        .type("type")

        // the properties below are optional
        .aliasTarget(AliasTargetProperty.builder()
                .dnsName("dnsName")
                .hostedZoneId("hostedZoneId")

                // the properties below are optional
                .evaluateTargetHealth(false)
                .build())
        .cidrRoutingConfig(CidrRoutingConfigProperty.builder()
                .collectionId("collectionId")
                .locationName("locationName")
                .build())
        .comment("comment")
        .failover("failover")
        .geoLocation(GeoLocationProperty.builder()
                .continentCode("continentCode")
                .countryCode("countryCode")
                .subdivisionCode("subdivisionCode")
                .build())
        .healthCheckId("healthCheckId")
        .hostedZoneId("hostedZoneId")
        .hostedZoneName("hostedZoneName")
        .multiValueAnswer(false)
        .region("region")
        .resourceRecords(List.of("resourceRecords"))
        .setIdentifier("setIdentifier")
        .ttl("ttl")
        .weight(123)
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
// 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
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnRecordSet := awscdk.Aws_route53.NewCfnRecordSet(this, jsii.String("MyCfnRecordSet"), &CfnRecordSetProps{
	Name: jsii.String("name"),
	Type: jsii.String("type"),

	// the properties below are optional
	AliasTarget: &AliasTargetProperty{
		DnsName: jsii.String("dnsName"),
		HostedZoneId: jsii.String("hostedZoneId"),

		// the properties below are optional
		EvaluateTargetHealth: jsii.Boolean(false),
	},
	CidrRoutingConfig: &CidrRoutingConfigProperty{
		CollectionId: jsii.String("collectionId"),
		LocationName: jsii.String("locationName"),
	},
	Comment: jsii.String("comment"),
	Failover: jsii.String("failover"),
	GeoLocation: &GeoLocationProperty{
		ContinentCode: jsii.String("continentCode"),
		CountryCode: jsii.String("countryCode"),
		SubdivisionCode: jsii.String("subdivisionCode"),
	},
	HealthCheckId: jsii.String("healthCheckId"),
	HostedZoneId: jsii.String("hostedZoneId"),
	HostedZoneName: jsii.String("hostedZoneName"),
	MultiValueAnswer: jsii.Boolean(false),
	Region: jsii.String("region"),
	ResourceRecords: []*string{
		jsii.String("resourceRecords"),
	},
	SetIdentifier: jsii.String("setIdentifier"),
	Ttl: jsii.String("ttl"),
	Weight: jsii.Number(123),
})

Initializer

new CfnRecordSet(scope: Construct, id: string, props: CfnRecordSetProps)

python

CfnRecordSet(scope: Construct, id: str, props: CfnRecordSetProps)

java

new CfnRecordSet(Construct scope, String id, CfnRecordSetProps props)

csharp

new CfnRecordSet(Construct scope, string id, CfnRecordSetProps props)

NewCfnRecordSet(Scope Construct, Id *string, Props CfnRecordSetProps)

Construct Props

aliasTargetoptionalIResolvable | CfnRecordSet.AliasTargetPropertyalias_targetoptionaltyping.Union[IResolvable, AliasTargetProperty]aliasTargetoptionalIResolvableAliasTargetoptionalIResolvableAliasTargetoptionalinterface{}#

*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.

notes

If you're creating resource records sets for a private hosted zone, note the following:

You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide .

cidrRoutingConfigoptionalIResolvable | CfnRecordSet.CidrRoutingConfigPropertycidr_routing_configoptionaltyping.Union[IResolvable, CidrRoutingConfigProperty]cidrRoutingConfigoptionalIResolvableCidrRoutingConfigoptionalIResolvableCidrRoutingConfigoptionalinterface{}#

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

*Optional:* Any comments you want to include about a change batch request.

failoveroptionalstringfailoveroptionalstrfailoveroptionalStringFailoveroptionalstringFailoveroptional*string#

*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets.

notes

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:

When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

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 :

geoLocationoptionalIResolvable | CfnRecordSet.GeoLocationPropertygeo_locationoptionaltyping.Union[IResolvable, GeoLocationProperty]geoLocationoptionalIResolvableGeoLocationoptionalIResolvableGeoLocationoptionalinterface{}#

*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.

notes

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 .

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.

healthCheckIdoptionalstringhealth_check_idoptionalstrhealthCheckIdoptionalStringHealthCheckIdoptionalstringHealthCheckIdoptional*string#

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.

notes

Route 53 determines whether a resource record set is healthy based on one of the following:

By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

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 Value element. When you add a HealthCheckId 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:

Non-alias resource record sets : You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

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.

Alias resource record sets : You specify the following settings:
You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).
You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
You specify a health check ID for the non-alias resource record set.

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 group 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:

The United States
North America
The default resource record set

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:
Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.
Associate that health check with the resource record set.

hostedZoneIdoptionalstringhosted_zone_idoptionalstrhostedZoneIdoptionalStringHostedZoneIdoptionalstringHostedZoneIdoptional*string#

The ID of the hosted zone that you want to create records in.

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 .

hostedZoneNameoptionalstringhosted_zone_nameoptionalstrhostedZoneNameoptionalStringHostedZoneNameoptionalstringHostedZoneNameoptional*string#

The name of the hosted zone that you want to create records in.

notes

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 .

multiValueAnsweroptionalboolean | IResolvablemulti_value_answeroptionaltyping.Union[bool, IResolvable]multiValueAnsweroptionalBooleanMultiValueAnsweroptionalboolMultiValueAnsweroptionalinterface{}#

*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` .

notes

Note the following:

If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the record that you want to create, update, or delete.

notes

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:

The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com .
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

You can't use the * wildcard for resource records sets that have a type of NS.

regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#

*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to.

notes

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:

You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

resourceRecordsoptionalstring[]resource_recordsoptionaltyping.List[str]resourceRecordsoptionalList<String>ResourceRecordsoptionalstring[]ResourceRecordsoptional*[]*string#

One or more values that correspond with the value that you specified for the `Type` property.

notes

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:

You can specify more than one value for all record types except CNAME and SOA.
The maximum length of a value is 4000 characters.
If you're creating an alias record, omit ResourceRecords .

setIdentifieroptionalstringset_identifieroptionalstrsetIdentifieroptionalStringSetIdentifieroptionalstringSetIdentifieroptional*string#

*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.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide .

ttloptionalstringttloptionalstrttloptionalStringTtloptionalstringTtloptional*string#

The resource record cache time to live (TTL), in seconds. Note the following:.

notes

If you're creating or updating an alias resource record set, omit TTL . Amazon Route 53 uses the value of TTL for the alias target.
If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.
All of the resource record sets in a group of weighted resource record sets must have the same value for TTL .
If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight .

typestringtypestrtypeStringTypestringType*stringrequired#

The DNS record type.

notes

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 | TLSA | SSHFP | SVCB | HTTPS

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT | TLSA | SSHFP | SVCB | HTTPS . 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 | CAA | TLSA | SSHFP | SVCB | HTTPS

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:

Amazon API Gateway custom regional APIs and edge-optimized APIs: A
CloudFront distributions: A

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 .

Amazon API Gateway environment that has a regionalized subdomain : A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Amazon Virtual Private Cloud interface VPC endpoints A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA .

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 Type is CNAME . 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.

weightoptionalnumberweightoptionalint | floatweightoptionalNumberWeightoptionaldoubleWeightoptional*float64#

*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.

notes

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:

You must specify a value for the Weight element for every weighted resource record set.
You can only specify one ResourceRecord per weighted resource record set.
You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

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 .

Properties

aliasTargetmay be undefinedIResolvable | CfnRecordSet.AliasTargetPropertyalias_targetmay be undefinedtyping.Union[IResolvable, AliasTargetProperty]aliasTargetmay be undefinedIResolvableAliasTargetmay be undefinedIResolvableAliasTargetmay be undefinedinterface{}#

*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_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

cidrRoutingConfigmay be undefinedIResolvable | CfnRecordSet.CidrRoutingConfigPropertycidr_routing_configmay be undefinedtyping.Union[IResolvable, CidrRoutingConfigProperty]cidrRoutingConfigmay be undefinedIResolvableCidrRoutingConfigmay be undefinedIResolvableCidrRoutingConfigmay be undefinedinterface{}#

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

commentmay be undefinedstringcommentmay be undefinedstrcommentmay be undefinedStringCommentmay be undefinedstringCommentmay be undefined*string#

*Optional:* Any comments you want to include about a change batch request.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

failovermay be undefinedstringfailovermay be undefinedstrfailovermay be undefinedStringFailovermay be undefinedstringFailovermay be undefined*string#

*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets.

geoLocationmay be undefinedIResolvable | CfnRecordSet.GeoLocationPropertygeo_locationmay be undefinedtyping.Union[IResolvable, GeoLocationProperty]geoLocationmay be undefinedIResolvableGeoLocationmay be undefinedIResolvableGeoLocationmay be undefinedinterface{}#

*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.

healthCheckIdmay be undefinedstringhealth_check_idmay be undefinedstrhealthCheckIdmay be undefinedStringHealthCheckIdmay be undefinedstringHealthCheckIdmay be undefined*string#

hostedZoneIdmay be undefinedstringhosted_zone_idmay be undefinedstrhostedZoneIdmay be undefinedStringHostedZoneIdmay be undefinedstringHostedZoneIdmay be undefined*string#

The ID of the hosted zone that you want to create records in.

hostedZoneNamemay be undefinedstringhosted_zone_namemay be undefinedstrhostedZoneNamemay be undefinedStringHostedZoneNamemay be undefinedstringHostedZoneNamemay be undefined*string#

The name of the hosted zone that you want to create records in.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

multiValueAnswermay be undefinedboolean | IResolvablemulti_value_answermay be undefinedtyping.Union[bool, IResolvable]multiValueAnswermay be undefinedBooleanMultiValueAnswermay be undefinedboolMultiValueAnswermay be undefinedinterface{}#

namestringnamestrnameStringNamestringName*string#

The name of the record that you want to create, update, or delete.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

recordSetRefRecordSetReferencerecord_set_refRecordSetReferencerecordSetRefRecordSetReferenceRecordSetRefRecordSetReferenceRecordSetRefRecordSetReference#

A reference to a RecordSet resource.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

regionmay be undefinedstringregionmay be undefinedstrregionmay be undefinedStringRegionmay be undefinedstringRegionmay be undefined*string#

*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to.

resourceRecordsmay be undefinedstring[]resource_recordsmay be undefinedtyping.List[str]resourceRecordsmay be undefinedList<String>ResourceRecordsmay be undefinedstring[]ResourceRecordsmay be undefined*[]*string#

One or more values that correspond with the value that you specified for the `Type` property.

setIdentifiermay be undefinedstringset_identifiermay be undefinedstrsetIdentifiermay be undefinedStringSetIdentifiermay be undefinedstringSetIdentifiermay be undefined*string#

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

ttlmay be undefinedstringttlmay be undefinedstrttlmay be undefinedStringTtlmay be undefinedstringTtlmay be undefined*string#

The resource record cache time to live (TTL), in seconds.

Note the following:.

typestringtypestrtypeStringTypestringType*string#

The DNS record type.

weightmay be undefinednumberweightmay be undefinedint | floatweightmay be undefinedNumberWeightmay be undefineddoubleWeightmay be undefined*float64#

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

typescript

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

json

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

def apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> None

public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnRecordSet(x: any): boolean@staticmethod def is_cfn_record_set(x: Any) -> boolpublic static Boolean isCfnRecordSet(Object x)public static bool IsCfnRecordSet(object x)func IsCfnRecordSet(X interface{}) *boolstatic#

Checks whether the given object is a CfnRecordSet.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

targettargettargettargetTarget — The dependency to replace.
newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

CfnRecordSet L1 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

CfnRecordSet L1 construct

Example

Initializer

Construct Props

Properties

Methods