RecordSet L2 construct
A record set.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';
declare const cidrRoutingConfig: route53.CidrRoutingConfig;
declare const geoLocation: route53.GeoLocation;
declare const healthCheck: route53.HealthCheck;
declare const hostedZone: route53.HostedZone;
declare const recordTarget: route53.RecordTarget;
const recordSet = new route53.RecordSet(this, 'MyRecordSet', {
recordType: route53.RecordType.A,
target: recordTarget,
zone: hostedZone,
// the properties below are optional
cidrRoutingConfig: cidrRoutingConfig,
comment: 'comment',
deleteExisting: false,
failover: route53.Failover.PRIMARY,
geoLocation: geoLocation,
healthCheck: healthCheck,
multiValueAnswer: false,
recordName: 'recordName',
region: 'region',
setIdentifier: 'setIdentifier',
ttl: cdk.Duration.minutes(30),
weight: 123,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_route53 as route53
# cidr_routing_config: route53.CidrRoutingConfig
# geo_location: route53.GeoLocation
# health_check: route53.HealthCheck
# hosted_zone: route53.HostedZone
# record_target: route53.RecordTarget
record_set = route53.RecordSet(self, "MyRecordSet",
record_type=route53.RecordType.A,
target=record_target,
zone=hosted_zone,
# the properties below are optional
cidr_routing_config=cidr_routing_config,
comment="comment",
delete_existing=False,
failover=route53.Failover.PRIMARY,
geo_location=geo_location,
health_check=health_check,
multi_value_answer=False,
record_name="recordName",
region="region",
set_identifier="setIdentifier",
ttl=cdk.Duration.minutes(30),
weight=123
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.route53.*;
CidrRoutingConfig cidrRoutingConfig;
GeoLocation geoLocation;
HealthCheck healthCheck;
HostedZone hostedZone;
RecordTarget recordTarget;
RecordSet recordSet = RecordSet.Builder.create(this, "MyRecordSet")
.recordType(RecordType.A)
.target(recordTarget)
.zone(hostedZone)
// the properties below are optional
.cidrRoutingConfig(cidrRoutingConfig)
.comment("comment")
.deleteExisting(false)
.failover(Failover.PRIMARY)
.geoLocation(geoLocation)
.healthCheck(healthCheck)
.multiValueAnswer(false)
.recordName("recordName")
.region("region")
.setIdentifier("setIdentifier")
.ttl(Duration.minutes(30))
.weight(123)
.build();
// 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;
using Amazon.CDK.AWS.Route53;
CidrRoutingConfig cidrRoutingConfig;
GeoLocation geoLocation;
HealthCheck healthCheck;
HostedZone hostedZone;
RecordTarget recordTarget;
var recordSet = new RecordSet(this, "MyRecordSet", new RecordSetProps {
RecordType = RecordType.A,
Target = recordTarget,
Zone = hostedZone,
// the properties below are optional
CidrRoutingConfig = cidrRoutingConfig,
Comment = "comment",
DeleteExisting = false,
Failover = Failover.PRIMARY,
GeoLocation = geoLocation,
HealthCheck = healthCheck,
MultiValueAnswer = false,
RecordName = "recordName",
Region = "region",
SetIdentifier = "setIdentifier",
Ttl = Duration.Minutes(30),
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 cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var cidrRoutingConfig CidrRoutingConfig
var geoLocation GeoLocation
var healthCheck HealthCheck
var hostedZone HostedZone
var recordTarget RecordTarget
recordSet := awscdk.Aws_route53.NewRecordSet(this, jsii.String("MyRecordSet"), &RecordSetProps{
RecordType: awscdk.*Aws_route53.RecordType_A,
Target: recordTarget,
Zone: hostedZone,
// the properties below are optional
CidrRoutingConfig: cidrRoutingConfig,
Comment: jsii.String("comment"),
DeleteExisting: jsii.Boolean(false),
Failover: awscdk.*Aws_route53.Failover_PRIMARY,
GeoLocation: geoLocation,
HealthCheck: healthCheck,
MultiValueAnswer: jsii.Boolean(false),
RecordName: jsii.String("recordName"),
Region: jsii.String("region"),
SetIdentifier: jsii.String("setIdentifier"),
Ttl: cdk.Duration_Minutes(jsii.Number(30)),
Weight: jsii.Number(123),
})
Initializer
new RecordSet(scope: Construct, id: string, props: RecordSetProps)
RecordSet(scope: Construct, id: str, props: RecordSetProps)
new RecordSet(Construct scope, String id, RecordSetProps props)
new RecordSet(Construct scope, string id, RecordSetProps props)
NewRecordSet(Scope Construct, Id *string, Props RecordSetProps)
Construct Props
cidrRoutingConfigoptionalCidrRoutingConfigcidr_routing_configoptionalCidrRoutingConfigcidrRoutingConfigoptionalCidrRoutingConfigCidrRoutingConfigoptionalCidrRoutingConfigCidrRoutingConfigoptionalCidrRoutingConfig#Default: No CIDR routing configured
A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: no comment
deleteExistingoptionalbooleandelete_existingoptionalbooldeleteExistingoptionalBooleanDeleteExistingoptionalboolDeleteExistingoptional*bool= falsedeprecated#notes
This allows you to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets.
N.B.: this feature is dangerous, use with caution! It can only be used safely when
deleteExistingis set totrueas soon as the resource is added to the stack. Changing an existing Record Set'sdeleteExistingproperty fromfalse -> trueafter deployment will delete the record!
failoveroptionalFailoverfailoveroptionalFailoverfailoveroptionalFailoverFailoveroptionalFailoverFailoveroptionalFailover#Default: No failover configuration
notes
To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY.
You must also include the HealthCheckId element for PRIMARY configurations.
geoLocationoptionalGeoLocationgeo_locationoptionalGeoLocationgeoLocationoptionalGeoLocationGeoLocationoptionalGeoLocationGeoLocationoptionalGeoLocation#healthCheckoptionalIHealthCheckhealth_checkoptionalIHealthCheckhealthCheckoptionalIHealthCheckHealthCheckoptionalIHealthCheckHealthCheckoptionalIHealthCheck#Default: No health check configured
Route53 will return this record set in response to DNS queries only if the health check is passing.
multiValueAnsweroptionalbooleanmulti_value_answeroptionalboolmultiValueAnsweroptionalBooleanMultiValueAnsweroptionalboolMultiValueAnsweroptional*bool= false#recordNameoptionalstringrecord_nameoptionalstrrecordNameoptionalStringRecordNameoptionalstringRecordNameoptional*string#Default: zone root
For example, if you want to create a record for acme.example.com, specify "acme".
You can also specify the fully qualified domain name which terminates with a ".". For example, "acme.example.com.".
recordTypeRecordTyperecord_typeRecordTyperecordTypeRecordTypeRecordTypeRecordTypeRecordTypeRecordTyperequired#Default: Do not set latency based routing
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.
setIdentifieroptionalstringset_identifieroptionalstrsetIdentifieroptionalStringSetIdentifieroptionalstringSetIdentifieroptional*string#Default: Auto generated string
It can only be set when either weight or geoLocation is defined.
This parameter must be between 1 and 128 characters in length.
ttloptionalDurationttloptionalDurationttloptionalDurationTtloptionalDurationTtloptionalDuration= Duration.minutes(30)#weightoptionalnumberweightoptionalint | floatweightoptionalNumberWeightoptionaldoubleWeightoptional*float64#Default: Do not set weighted routing
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.
This value can be a number between 0 and 255.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#recordSetRefRecordSetReferencerecord_set_refRecordSetReferencerecordSetRefRecordSetReferenceRecordSetRefRecordSetReferenceRecordSetRefRecordSetReferencerequired#Methods
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)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#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).
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#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.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.