Skip to content

Commit f9e357f

Browse files
authored
docs(route53): add more detailed documentation to cname domain name property (#25579)
Closes #25552. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 51f0193 commit f9e357f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/aws-cdk-lib/aws-route53/lib/record-set.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,13 @@ export interface RecordSetOptions {
156156
readonly zone: IHostedZone;
157157

158158
/**
159-
* The domain name for this record.
159+
* The subdomain name for this record. This should be relative to the zone root name.
160+
*
161+
* For example, if you want to create a record for acme.example.com, specify
162+
* "acme".
163+
*
164+
* You can also specify the fully qualified domain name which terminates with a
165+
* ".". For example, "acme.example.com.".
160166
*
161167
* @default zone root
162168
*/
@@ -376,7 +382,7 @@ export class AaaaRecord extends RecordSet {
376382
*/
377383
export interface CnameRecordProps extends RecordSetOptions {
378384
/**
379-
* The domain name.
385+
* The domain name of the target that this record should point to.
380386
*/
381387
readonly domainName: string;
382388
}

0 commit comments

Comments
 (0)