Skip to content

Commit 3e2f05b

Browse files
authored
docs(cdk): updated README with toolkitBucket bootstrap configuration object (#24451)
The `--toolkit-bucket-name` and `--bootstrap-kms-key-id` are specified in `cdk.json` by passing a `toolkitBucket` [object](https://github.com/aws/aws-cdk/blob/3d7505b5a9c3daf5edfecdb4576b555bfe8d7553/packages/aws-cdk/lib/cli.ts#L503-L504). The [documentation on the website](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-config) should also be updated. Closes #24259 . ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 2afad8d commit 3e2f05b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

packages/aws-cdk/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -757,8 +757,11 @@ Some of the interesting keys that can be used in the JSON configuration files:
757757
"key": "value"
758758
},
759759
"toolkitStackName": "foo", // Customize 'bootstrap' stack name (--toolkit-stack-name=foo)
760-
"toolkitBucketName": "fooBucket", // Customize 'bootstrap' bucket name (--toolkit-bucket-name=fooBucket)
761-
"versionReporting": false, // Opt-out of version reporting (--no-version-reporting)
760+
"toolkitBucket": {
761+
"bucketName": "fooBucket", // Customize 'bootstrap' bucket name (--toolkit-bucket-name=fooBucket)
762+
"kmsKeyId": "fooKMSKey" // Customize 'bootstrap' KMS key id (--bootstrap-kms-key-id=fooKMSKey)
763+
},
764+
"versionReporting": false, // Opt-out of version reporting (--no-version-reporting)
762765
}
763766
```
764767

0 commit comments

Comments
 (0)