Skip to content

Commit 2c14aaa

Browse files
committed
Periodic doc update
1 parent 9076a6a commit 2c14aaa

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

v2/bootstrapping-env.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,11 @@ For information on using CloudFormation StackSets to bootstrap multiple environm
118118

119119
## When to bootstrap your environment<a name="bootstrapping-env-when"></a>
120120

121-
You must bootstrap each environment before you deploy into the environment\. If you attempt to deploy a CDK stack into an environment that hasn’t been bootstrapped, you will see an error like the following:
121+
You must bootstrap each AWS environment before you deploy into the environment\. We recommend that you proactively bootstrap each environment that you plan to use\. You can do this before you plan on actually deploying CDK apps into the environment\. By proactively bootstrapping your environments, you prevent potential future issues such as Amazon S3 bucket name conflicts or deploying CDK apps into environments that haven't been bootstrapped\.
122+
123+
It’s okay to bootstrap an environment more than once\. If an environment has already been bootstrapped, the bootstrap stack will be upgraded if necessary\. Otherwise, nothing will happen\.
124+
125+
If you attempt to deploy a CDK stack into an environment that hasn’t been bootstrapped, you will see an error like the following:
122126

123127
```
124128
$ cdk deploy
@@ -128,8 +132,6 @@ $ cdk deploy
128132
❌ Deployment failed: Error: BootstrapExampleStack: SSM parameter /cdk-bootstrap/hnb659fds/version not found. Has the environment been bootstrapped? Please run 'cdk bootstrap' (see https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html)
129133
```
130134

131-
It’s okay to bootstrap an environment more than once\. If an environment has already been bootstrapped, the bootstrap stack will be upgraded if necessary\. Otherwise, nothing will happen\.
132-
133135
### Update your bootstrap stack<a name="bootstrapping-env-when-update"></a>
134136

135137
Periodically, the CDK team will update the bootstrap template to a new version\. When this happens, we recommend that you update your bootstrap stack\. If you haven’t customized the bootstrapping process, you can update your bootstrap stack by following the same steps that you took to originally bootstrap your environment\. For more information, see [Bootstrap template version history](#bootstrap-template-history)\.

v2/bootstrapping-troubleshoot.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,4 @@ func NewMyStack(scope constructs.Construct, id string, props *MyStackProps) awsc
243243

244244
### Prevention<a name="bootstrapping-troubleshoot-s3-bucket-name-prevention"></a>
245245

246-
**Proactively bootstrap your environments** <a name="bootstrapping-troubleshoot-s3-bucket-name-prevention-proactive"></a>
247-
If you don’t have reasons to customize bootstrapping or synthesis, we recommend that you use the default bootstrapping process and synthesizer, which work together automatically\. To do this, the default Amazon S3 bucket name that will be created during bootstrapping must not yet exist\. To prevent against this from happening, we recommend that you proactively bootstrap each Region for each AWS account that you plan to use\. You can do this before you ever plan on actually deploying CDK applications into the environment\. Specifically for the Amazon S3 bucket naming issue, this will create Amazon S3 buckets in each AWS environment and prevent others from using your Amazon S3 bucket name\.
248-
249-
**Protect your account ID** <a name="bootstrapping-troubleshoot-s3-bucket-name-prevention-protect"></a>
250-
Limit the sharing of your account ID\. This will help to prevent bad actors from using your account ID to generate their own Amazon S3 bucket names\.
246+
We recommend that you proactively bootstrap each AWS environment that you plan to use\. For more information, see [When to bootstrap your environment](bootstrapping-env.md#bootstrapping-env-when)\. Specifically for the Amazon S3 bucket naming issue, this will create Amazon S3 buckets in each AWS environment and prevent others from using your Amazon S3 bucket name\.

0 commit comments

Comments
 (0)