Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(route53): Fix headings list and minor doc fixes #31030

Closed
wants to merge 2 commits into from
Closed

docs(route53): Fix headings list and minor doc fixes #31030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
326be0a
docs: fix headings list + minor fixes
frankpengau Aug 6, 2024
66e360a
docs: spring cleaning the code prompts/class docs
frankpengau Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/aws-cdk-lib/aws-route53/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ new route53.ARecord(this, 'ARecord', {
```

To create an A record of type alias with target set to another record created outside CDK:
### This function registers the given input i.e. DNS Name(string) of an existing record as an AliasTarget to the new ARecord. To register a target that is created as part of CDK use this instead https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53_targets-readme.html
> NOTE: This function `fromARecordAttributes` registers the given input i.e. DNS Name(string) of an existing record as an Alias Target to the new A Record.
> To register a target that is created as part of CDK use this instead: [aws_route53_targets](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53_targets-readme.html).

```ts

declare const myZone: route53.HostedZone;
const targetRecord = 'existing.record.cdk.local';
const record = route53.ARecord.fromARecordAttributes(this, 'A', {
Expand Down Expand Up @@ -228,7 +228,7 @@ stack with a record set that already exists. This is typically the case for reco
are not already "owned" by CloudFormation or "owned" by another stack or construct that is
going to be deleted (migration).

> **N.B.:** this feature is dangerous, use with caution! It can only be used safely when
> NOTE: This feature is dangerous, use with caution! It can only be used safely when
> `deleteExisting` is set to `true` as soon as the resource is added to the stack. Changing
> an existing Record Set's `deleteExisting` property from `false -> true` after deployment
> will delete the record!
Expand Down Expand Up @@ -414,7 +414,7 @@ out the [documentation](https://docs.aws.amazon.com/cdk/latest/guide/environment
automatically looks into your `~/.aws/config` file for the `[default]` profile.
If you want to specify a different account run `cdk deploy --profile [profile]`.

```text
```ts
new MyDevStack(app, 'dev', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-route53/lib/record-set.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ export interface RecordSetOptions {
* 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
* > NOTE: This feature is dangerous, use with caution! It can only be used safely when
* > `deleteExisting` is set to `true` as soon as the resource is added to the stack. Changing
* > an existing Record Set's `deleteExisting` property from `false -> true` after deployment
* > will delete the record!
Expand Down Expand Up @@ -465,8 +465,8 @@ export class ARecord extends RecordSet {

/**
* Creates new A record of type alias with target set to an existing A Record DNS.
* Use when the target A record is created outside of CDK
* For records created as part of CDK use @aws-cdk-lib/aws-route53-targets/route53-record.ts
* Use when the target A record is created outside of CDK.
* For records created as part of CDK use `@aws-cdk-lib/aws-route53-targets/route53-record.ts`.
* @param scope the parent Construct for this Construct
* @param id Logical Id of the resource
* @param attrs the ARecordAttributes (Target Arecord DNS name and HostedZone)
Expand Down
Loading