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.

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

cdk diff: show element path and not only logical id #1121

Closed
eladb opened this issue Nov 8, 2018 · 0 comments · Fixed by #1187
Closed

cdk diff: show element path and not only logical id #1121

eladb opened this issue Nov 8, 2018 · 0 comments · Fixed by #1187
Labels
feature-request A feature should be added or improved. package/tools Related to AWS CDK Tools or CLI ui Related to CLI User Interface issues

Comments

@eladb
Copy link
Contributor

eladb commented Nov 8, 2018

diff should also show the element's construct path

@rix0rrr rix0rrr added feature-request A feature should be added or improved. package/tools Related to AWS CDK Tools or CLI labels Nov 11, 2018
@eladb eladb added the ui Related to CLI User Interface issues label Nov 13, 2018
eladb pushed a commit that referenced this issue Nov 15, 2018
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
eladb pushed a commit that referenced this issue Nov 15, 2018
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
eladb pushed a commit that referenced this issue Nov 15, 2018
- When possible, display element's construct path alongside 
  logical ID (fixes #1121)
- Sort changes according to type: removed > added > updated > other
- Add section headers: parameters, resources, 
  output (fixes #1120)
- Reduce clutter and emojis
 
To display construct path we fuse metadata from the synthesized output
(CDK metadata) and info from the the "aws:cdk:path" CloudFormation
metadata (if exists).
eladb pushed a commit that referenced this issue Nov 18, 2018
- When possible, display element's construct path alongside 
  logical ID (fixes #1121)
- Sort changes according to type: removed > added > updated > other
- Add section headers: parameters, resources, 
  output (fixes #1120)
- Reduce clutter and emojis
 
To display construct path we fuse metadata from the synthesized output
(CDK metadata) and info from the the "aws:cdk:path" CloudFormation
metadata (if exists).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. package/tools Related to AWS CDK Tools or CLI ui Related to CLI User Interface issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants