feat: embed construct paths in CloudFormation metadata #1183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
November 13, 2018 16:52
When --language is omitted from a call to "cdk init", instead of just printing the supported languages, we now print all options, including template types.
In order to allow tools that read a CloudFormation template created by the CDK to be able to present the CDK path of resources in the template, the CDK now embeds the full path as CloudFormation metadata "aws:cdk:path" entry for each resource. To disable this behavior use the switch `--no-path-metadata` or set `pathMetadata` to `false` in `cdk.json` or `~/.cdk.json`. The toolkit can control this behavior by setting the "aws:cdk:enable-path-metadata" context key. It sets it to `true` by default. The default behavior of the *Resource class* is _not_ to include metadata. This is in order to maintain backwards compatibility for tests. `cdk-integ` also disables this by default. Fixes #1182 Related #1121
rix0rrr
reviewed
Nov 15, 2018
rix0rrr
approved these changes
Nov 15, 2018
|
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In order to allow tools that read a CloudFormation template created by
the CDK to be able to present the CDK path of resources in the template,
the CDK now embeds the full path as CloudFormation metadata "aws:cdk:path"
entry for each resource.
To disable this behavior use the switch
--no-path-metadataor setpathMetadatatofalseincdk.jsonor~/.cdk.json.The toolkit can control this behavior by setting the
"aws:cdk:enable-path-metadata" context key. It sets it to
truebydefault.
The default behavior of the Resource class is not to include
metadata. This is in order to maintain backwards compatibility
for tests.
cdk-integalso disables this by default.Fixes #1182
Related #1121