Class CfnRecordSet
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.route53.CfnRecordSet
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-15T21:09:26.248Z")
@Stability(Stable)
public class CfnRecordSet
extends CfnResource
implements IInspectable
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 .
Example:
// 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()) .geoProximityLocation(GeoProximityLocationProperty.builder() .awsRegion("awsRegion") .bias(123) .coordinates(CoordinatesProperty.builder() .latitude("latitude") .longitude("longitude") .build()) .localZoneGroup("localZoneGroup") .build()) .healthCheckId("healthCheckId") .hostedZoneId("hostedZoneId") .hostedZoneName("hostedZoneName") .multiValueAnswer(false) .region("region") .resourceRecords(List.of("resourceRecords")) .setIdentifier("setIdentifier") .ttl("ttl") .weight(123) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Alias records only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.static final class
A fluent builder forCfnRecordSet
.static interface
The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.static interface
A complex type that lists the coordinates for a geoproximity resource record.static interface
A complex type that contains information about a geographic location.static interface
(Resource record sets only): A complex type that lets you specify where your resources are located.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnRecordSet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnRecordSet
(software.amazon.jsii.JsiiObjectRef objRef) CfnRecordSet
(software.constructs.Construct scope, String id, CfnRecordSetProps props) -
Method Summary
Modifier and TypeMethodDescriptionAlias 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.Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth.The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.Optional: Any comments you want to include about a change batch request.Failover resource record sets only: To configure failover, you add theFailover
element to two resource record sets.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.GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.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 theHealthCheckId
element and specify the ID of the applicable health check.The ID of the hosted zone that you want to create records in.The name of the hosted zone that you want to create records in.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 specifytrue
forMultiValueAnswer
.getName()
ForChangeResourceRecordSets
requests, the name of the record that you want to create, update, or delete.Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.One or more values that correspond with the value that you specified for theType
property.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.getTtl()
The resource record cache time to live (TTL), in seconds.getType()
The DNS record type.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.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAliasTarget
(IResolvable value) 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.void
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.void
setCidrRoutingConfig
(IResolvable value) The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.void
The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.void
setComment
(String value) Optional: Any comments you want to include about a change batch request.void
setFailover
(String value) Failover resource record sets only: To configure failover, you add theFailover
element to two resource record sets.void
setGeoLocation
(IResolvable value) 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.void
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.void
GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.void
GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.void
setHealthCheckId
(String value) 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 theHealthCheckId
element and specify the ID of the applicable health check.void
setHostedZoneId
(String value) The ID of the hosted zone that you want to create records in.void
setHostedZoneName
(String value) The name of the hosted zone that you want to create records in.void
setMultiValueAnswer
(Boolean value) 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 specifytrue
forMultiValueAnswer
.void
setMultiValueAnswer
(IResolvable value) 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 specifytrue
forMultiValueAnswer
.void
ForChangeResourceRecordSets
requests, the name of the record that you want to create, update, or delete.void
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.void
setResourceRecords
(List<String> value) One or more values that correspond with the value that you specified for theType
property.void
setSetIdentifier
(String value) 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.void
The resource record cache time to live (TTL), in seconds.void
The DNS record type.void
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 inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnRecordSet
protected CfnRecordSet(software.amazon.jsii.JsiiObjectRef objRef) -
CfnRecordSet
protected CfnRecordSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnRecordSet
@Stability(Stable) public CfnRecordSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRecordSetProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
ForChangeResourceRecordSets
requests, the name of the record that you want to create, update, or delete. -
setName
ForChangeResourceRecordSets
requests, the name of the record that you want to create, update, or delete. -
getType
The DNS record type. -
setType
The DNS record type. -
getAliasTarget
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. -
setAliasTarget
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. -
setAliasTarget
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. -
getCidrRoutingConfig
The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. -
setCidrRoutingConfig
The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. -
setCidrRoutingConfig
@Stability(Stable) public void setCidrRoutingConfig(@Nullable CfnRecordSet.CidrRoutingConfigProperty value) The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. -
getComment
Optional: Any comments you want to include about a change batch request. -
setComment
Optional: Any comments you want to include about a change batch request. -
getFailover
Failover resource record sets only: To configure failover, you add theFailover
element to two resource record sets. -
setFailover
Failover resource record sets only: To configure failover, you add theFailover
element to two resource record sets. -
getGeoLocation
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. -
setGeoLocation
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. -
setGeoLocation
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. -
getGeoProximityLocation
GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. -
setGeoProximityLocation
GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. -
setGeoProximityLocation
@Stability(Stable) public void setGeoProximityLocation(@Nullable CfnRecordSet.GeoProximityLocationProperty value) GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. -
getHealthCheckId
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 theHealthCheckId
element and specify the ID of the applicable health check. -
setHealthCheckId
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 theHealthCheckId
element and specify the ID of the applicable health check. -
getHostedZoneId
The ID of the hosted zone that you want to create records in. -
setHostedZoneId
The ID of the hosted zone that you want to create records in. -
getHostedZoneName
The name of the hosted zone that you want to create records in. -
setHostedZoneName
The name of the hosted zone that you want to create records in. -
getMultiValueAnswer
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 specifytrue
forMultiValueAnswer
. -
setMultiValueAnswer
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 specifytrue
forMultiValueAnswer
. -
setMultiValueAnswer
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 specifytrue
forMultiValueAnswer
. -
getRegion
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. -
setRegion
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. -
getResourceRecords
One or more values that correspond with the value that you specified for theType
property. -
setResourceRecords
One or more values that correspond with the value that you specified for theType
property. -
getSetIdentifier
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 ofSetIdentifier
must be unique for each resource record set. -
setSetIdentifier
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 ofSetIdentifier
must be unique for each resource record set. -
getTtl
The resource record cache time to live (TTL), in seconds.Note the following:.
-
setTtl
The resource record cache time to live (TTL), in seconds.Note the following:.
-
getWeight
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. -
setWeight
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.
-