interface SrvRecordProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Route53.SrvRecordProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsroute53#SrvRecordProps |
![]() | software.amazon.awscdk.services.route53.SrvRecordProps |
![]() | aws_cdk.aws_route53.SrvRecordProps |
![]() | aws-cdk-lib » aws_route53 » SrvRecordProps |
Construction properties for a SrvRecord.
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 hostedZone: route53.HostedZone;
const srvRecordProps: route53.SrvRecordProps = {
values: [{
hostName: 'hostName',
port: 123,
priority: 123,
weight: 123,
}],
zone: hostedZone,
// the properties below are optional
comment: 'comment',
deleteExisting: false,
recordName: 'recordName',
ttl: cdk.Duration.minutes(30),
};
Properties
Name | Type | Description |
---|---|---|
values | Srv [] | The values. |
zone | IHosted | The hosted zone in which to define the new record. |
comment? | string | A comment to add on the record. |
delete | boolean | Whether to delete the same record set in the hosted zone if it already exists (dangerous!). |
record | string | The subdomain name for this record. This should be relative to the zone root name. |
ttl? | Duration | The resource record cache time to live (TTL). |
values
Type:
Srv
[]
The values.
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.
deleteExisting?
Type:
boolean
(optional, default: false)
Whether to delete the same record set in the hosted zone if it already exists (dangerous!).
This allows 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
deleteExisting
is set totrue
as soon as the resource is added to the stack. Changing an existing Record Set'sdeleteExisting
property fromfalse -> true
after deployment will delete the record!
recordName?
Type:
string
(optional, default: zone root)
The subdomain name for this record. This should be relative to the zone root name.
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.".
ttl?
Type:
Duration
(optional, default: Duration.minutes(30))
The resource record cache time to live (TTL).