class CaaAmazonRecord (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Route53.CaaAmazonRecord |
Java | software.amazon.awscdk.services.route53.CaaAmazonRecord |
Python | aws_cdk.aws_route53.CaaAmazonRecord |
TypeScript (source) | @aws-cdk/aws-route53 » CaaAmazonRecord |
Implements
IConstruct
, IConstruct
, IDependable
, IResource
, IRecord
A DNS Amazon CAA record.
A CAA record to restrict certificate authorities allowed to issue certificates for a domain to Amazon only.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as route53 from '@aws-cdk/aws-route53';
import * as cdk from '@aws-cdk/core';
declare const hostedZone: route53.HostedZone;
const caaAmazonRecord = new route53.CaaAmazonRecord(this, 'MyCaaAmazonRecord', {
zone: hostedZone,
// the properties below are optional
comment: 'comment',
recordName: 'recordName',
ttl: cdk.Duration.minutes(30),
});
Initializer
new CaaAmazonRecord(scope: Construct, id: string, props: CaaAmazonRecordProps)
Parameters
- scope
Construct
- id
string
- props
Caa
Amazon Record Props
Construct Props
Name | Type | Description |
---|---|---|
zone | IHosted | The hosted zone in which to define the new record. |
comment? | string | A comment to add on the record. |
record | string | The domain name for this record. |
ttl? | Duration | The resource record cache time to live (TTL). |
zone
Type:
IHosted
The hosted zone in which to define the new record.
comment?
Type:
string
(optional, default: no comment)
A comment to add on the record.
recordName?
Type:
string
(optional, default: zone root)
The domain name for this record.
ttl?
Type:
Duration
(optional, default: Duration.minutes(30))
The resource record cache time to live (TTL).
Properties
Name | Type | Description |
---|---|---|
domain | string | The domain name of the record. |
env | Resource | The environment this resource belongs to. |
node | Construct | The construct tree node associated with this construct. |
stack | Stack | The stack in which this resource is defined. |
domainName
Type:
string
The domain name of the record.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Construct
The construct tree node associated with this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
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
).
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.