Skip to content

Commit be24b0c

Browse files
author
Jerry Kindall
committed
various minor updates and some churn
1 parent 886790e commit be24b0c

File tree

6 files changed

+21
-20
lines changed

6 files changed

+21
-20
lines changed

doc_source/bootstrapping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The required resources are defined in a AWS CloudFormation stack, called the *bo
1212
The AWS CDK supports two bootstrap templates\. At this writing, the AWS CDK is transitioning from one of these templates to the other, but the original template \(dubbed "legacy"\) is still the default\. The newer template \("modern"\) is required by CDK Pipelines today, and will become the default at some point in the future\. For details, see [Bootstrapping templates](#bootstrapping-templates)\.
1313

1414
**Important**
15-
The modern bootstrap template grants the bootstrapping account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
15+
The modern bootstrap template grants the bootstrapped account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
1616

1717
Environments are independent, so if you want to deploy to multiple environments \(different AWS accounts or different regions in the same account\), each environment must be bootstrapped separately\.
1818

@@ -108,7 +108,7 @@ The main differences between the templates are as follows\.
108108
\* *We will add additional resources to the modern template as needed\.*
109109

110110
**Important**
111-
The modern bootstrap template grants the bootstrapping account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
111+
The modern bootstrap template grants the bootstrapped account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
112112

113113
At some point in the future, the modern template will become the default bootstrapping template\. Until then, manually select the modern template when bootstrapping by setting the `CDK_NEW_BOOTSTRAP` environment variable\.
114114

doc_source/cli.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ Older versions of the modern template created a Customer Master Key by default\.
271271
The AWS CDK Toolkit supports two bootstrap templates: the modern template and the legacy template\. The legacy template is the default, but the modern template is required by CDK Pipelines\. For more inforamtion, see [Bootstrapping](bootstrapping.md)\.
272272

273273
**Important**
274-
The modern bootstrap template grants the bootstrapping account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](bootstrapping.md#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
274+
The modern bootstrap template grants the bootstrapped account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](bootstrapping.md#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
275275

276276
## Creating a new app<a name="cli-init"></a>
277277

@@ -335,7 +335,7 @@ The CDK Toolkit actually runs your app and synthesizes fresh templates before mo
335335

336336
See `cdk synth --help` for all available options\. A few of the most\-frequently\-used options are covered below\.
337337

338-
### Specifying context values<a name="w289aac25b7c31c11"></a>
338+
### Specifying context values<a name="w297aac27b7c31c11"></a>
339339

340340
Use the `--context` or `-c` option to pass [runtime context](context.md) values to your CDK app\.
341341

@@ -354,15 +354,15 @@ When deploying multiple stacks, the specified context values are normally passed
354354
cdk synth --context Stack1:key=value Stack2:key=value Stack1 Stack2
355355
```
356356

357-
### Specifying display format<a name="w289aac25b7c31c13"></a>
357+
### Specifying display format<a name="w297aac27b7c31c13"></a>
358358

359359
By default, the synthesized template is displayed in YAML format\. Add the `--json` flag to display it in JSON format instead\.
360360

361361
```
362362
cdk synth --json MyStack
363363
```
364364

365-
### Specifying output directory<a name="w289aac25b7c31c15"></a>
365+
### Specifying output directory<a name="w297aac27b7c31c15"></a>
366366

367367
Add the `--output` \(`-o`\) option to write the synthesized templates to a directory other than `cdk.out`\.
368368

@@ -386,7 +386,7 @@ The CDK Toolkit runs your app and synthesizes fresh AWS CloudFormation templates
386386

387387
See `cdk deploy --help` for all available options\. A few of the most\-frequently\-used options are covered below\.
388388

389-
### Specifying AWS CloudFormation parameters<a name="w289aac25b7c33c11"></a>
389+
### Specifying AWS CloudFormation parameters<a name="w297aac27b7c33c11"></a>
390390

391391
The AWS CDK Toolkit supports specifying AWS CloudFormation [parameters](parameters.md) at deployment\. You may provide these on the command line following the `--parameters` flag\.
392392

@@ -408,7 +408,7 @@ cdk deploy MyStack YourStack --parameters MyStack:uploadBucketName=UploadBucket
408408

409409
By default, the AWS CDK retains values of parameters from previous deployments and uses them in later deployments if they are not specified explicitly\. Use the `--no-previous-parameters` flag to require all parameters to be specified\.
410410

411-
### Specifying outputs file<a name="w289aac25b7c33c13"></a>
411+
### Specifying outputs file<a name="w297aac27b7c33c13"></a>
412412

413413
If your stack declares AWS CloudFormation outputs, these are normally displayed on the screen at the conclusion of deployment\. To write them to a file in JSON format, use the `--outputs-file` flag\.
414414

@@ -625,7 +625,7 @@ If one of cdk.json or ~/.cdk.json exists, options specified there will be used
625625
as defaults. Settings in cdk.json take precedence.
626626
```
627627

628-
### `cdk list` \(`ls`\)<a name="w289aac25b7c39b7b1"></a>
628+
### `cdk list` \(`ls`\)<a name="w297aac27b7c39b7b1"></a>
629629

630630
```
631631
cdk list [STACKS..]
@@ -638,7 +638,7 @@ Options:
638638
[boolean] [default: false]
639639
```
640640

641-
### `cdk synthesize` \(`synth`\)<a name="w289aac25b7c39b7b3"></a>
641+
### `cdk synthesize` \(`synth`\)<a name="w297aac27b7c39b7b3"></a>
642642

643643
```
644644
cdk synthesize [STACKS..]
@@ -654,7 +654,7 @@ Options:
654654
[boolean] [default: false]
655655
```
656656

657-
### `cdk bootstrap`<a name="w289aac25b7c39b7b5"></a>
657+
### `cdk bootstrap`<a name="w297aac27b7c39b7b5"></a>
658658

659659
```
660660
cdk bootstrap [ENVIRONMENTS..]
@@ -723,7 +723,7 @@ Options:
723723
example) [string]
724724
```
725725

726-
### `cdk deploy`<a name="w289aac25b7c39b7b7"></a>
726+
### `cdk deploy`<a name="w297aac27b7c39b7b7"></a>
727727

728728
```
729729
cdk deploy [STACKS..]
@@ -776,7 +776,7 @@ Options:
776776
[string] [choices: "bar", "events"]
777777
```
778778

779-
### `cdk destroy`<a name="w289aac25b7c39b7b9"></a>
779+
### `cdk destroy`<a name="w297aac27b7c39b7b9"></a>
780780

781781
```
782782
cdk destroy [STACKS..]
@@ -795,7 +795,7 @@ Options:
795795
stacks [boolean]
796796
```
797797

798-
### `cdk diff`<a name="w289aac25b7c39b7c11"></a>
798+
### `cdk diff`<a name="w297aac27b7c39b7c11"></a>
799799

800800
```
801801
cdk diff [STACKS..]
@@ -815,7 +815,7 @@ Options:
815815
with [string]
816816
```
817817

818-
### `cdk init`<a name="w289aac25b7c39b7c13"></a>
818+
### `cdk init`<a name="w297aac27b7c39b7c13"></a>
819819

820820
```
821821
cdk init [TEMPLATE]
@@ -837,7 +837,7 @@ Options:
837837
project [boolean] [default: false]
838838
```
839839

840-
### `cdk context`<a name="w289aac25b7c39b7c15"></a>
840+
### `cdk context`<a name="w297aac27b7c39b7c15"></a>
841841

842842
```
843843
cdk context

doc_source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Amazon's trademarks and trade dress may not be used in
4343
+ [Aspects](aspects.md)
4444
+ [Escape hatches](cfn_layer.md)
4545
+ [Bootstrapping](bootstrapping.md)
46+
+ [Best practices for developing and deploying cloud infrastructure with the AWS CDK](best-practices.md)
4647
+ [API reference](reference.md)
4748
+ [Examples](examples.md)
4849
+ [Creating a serverless application using the AWS CDK](serverless_example.md)

doc_source/tagging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Tags.Of(myConstruct).Remove("key");
9090

9191
------
9292

93-
## Tag priorities<a name="w289aac17c23c21"></a>
93+
## Tag priorities<a name="w297aac17c23c21"></a>
9494

9595
The AWS CDK applies and removes tags recursively\. If there are conflicts, the tagging operation with the highest priority wins\. \(Priorities are set using the optional `priority` property\.\) If the priorities of two operations are the same, the tagging operation closest to the bottom of the construct tree wins\. By default, applying a tag has a priority of 100 \(except for tags added directly to an AWS CloudFormation resource, which has a priority of 50\) and removing a tag has a priority of 200\.
9696

doc_source/use_cfn_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The [https://docs.aws.amazon.com/cdk/api/latest/docs/cloudformation-include-read
44

55
This construct essentially adds an AWS CDK API wrapper to any resource in the template\. You can use this capability to migrate your existing AWS CloudFormation templates to the AWS CDK a piece at a time in order to take advantage of the AWS CDK's convenient higher\-level abstractions, or just to vend your AWS CloudFormation templates to AWS CDK developers by providing an AWS CDK construct API\.\.
66

7-
## Importing an AWS CloudFormation template<a name="w289aac23b9b7"></a>
7+
## Importing an AWS CloudFormation template<a name="w297aac25b9b7"></a>
88

99
Here is a simple AWS CloudFormation template we'll use for the examples in this topic\. Save it as `my-template.json`\. After you've tried these examples with the provided template, you might explore further using a template for an actual stack you've already deployed, which you can obtain from the AWS CloudFormation console\.
1010

doc_source/work-with-cdk-v2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The main changes in CDK v2 are:
1515
+ CDK v2 requires that the environments you deploy into be boostrapped using the modern bootstrap stack; the legacy stack is no longer supported\. CDK v2 furthermore requires a new version of the modern stack\. Simply re\-bootstrap the affected environments to upgrade them\. It is not necessary to set any feature flags or environment variables to specify the modern bootstrap stack\.
1616

1717
**Important**
18-
The modern bootstrap template grants the bootstrapping account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](bootstrapping.md#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
18+
The modern bootstrap template grants the bootstrapped account read and write access to any Amazon S3 bucket in the same environment, as well as the ability to read secrets from AWS KMS\. All accounts trusted in the bootstrapped environment can perform the same actions\. If this is not what you want, use a [custom template](bootstrapping.md#bootstrapping-customizing-extended)\. These permissions are only required by [CDK Pipelines](cdk_pipeline.md)\.
1919

2020
Aside from this topic, the AWS CDK Developer Guide describes CDK v1\.x\. Most of the information in the Guide still applies in CDK v2, or can be adapted with only minor changes\. A v2 Developer Guide will be available at General Availability \(GA\) of CDK v2\. A version of the [AWS CDK API Reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-construct-library.html) is available for CDK v2\.
2121

@@ -29,7 +29,7 @@ Most requirements for AWS CDK v2 are the same as for AWS CDK v1\.x\. See [Prereq
2929

3030
To migrate your app to AWS CDK v2, first update the feature flags in `cdk.json`\. Then update your app's dependencies and imports as necessary for the programming language it is written in\.
3131

32-
### Updating `cdk.json`<a name="w289aac13c11b5"></a>
32+
### Updating `cdk.json`<a name="w297aac13c11b5"></a>
3333

3434
Remove all feature flags from `cdk.json`\. You can add one or more of the three flags listed below, set to `false`, if your app relies on these specific AWS CDK v1\.x behaviors\. Use the `cdk diff` command to inspect the changes to your synthesized template to see if any of these are needed\.
3535

0 commit comments

Comments
 (0)