feat(cli): support --import-existing-resources flag in cdk diff
#32831
Conversation
github-actions
bot
added
effort/small
github-actions
bot
added
the
star-contributor
packages/aws-cdk/lib/cdk-toolkit.ts
Outdated
| stream, | ||
| }); | ||
| } else { | ||
| if (options.importExistingResources) { | ||
| throw new ToolkitError(`--import-existing-resources diff cannot be enabled for a stack that does not exist yet. StackName: ${stack.stackName}`); | ||
| } |
There was a problem hiding this comment.
According to #29492, cdk diff will not create changeset when the target stack does not exist. Without changeset, CDK cannot know which resource will be imported, so I just throw an error instead.
There was a problem hiding this comment.
The pull request linter fails with the following errors:
❌ Features must contain a change to an integration test file and the resulting snapshot.
❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32831/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.
❌ CodeCov is indicating a drop in code coverage
If you believe this pull request should receive an exemption, please comment and provide a justification. A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed, add Clarification Request to a comment.
✅ A exemption request has been requested. Please wait for a maintainer's review.
aws-cdk-automation
added
the
pr/needs-cli-test-run
Codecov ReportAttention: Patch coverage is
❌ Your patch check has failed because the patch coverage (50.00%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #32831 +/- ##
==========================================
- Coverage 80.78% 80.77% -0.01%
==========================================
Files 232 232
Lines 14111 14115 +4
Branches 2453 2455 +2
==========================================
+ Hits 11400 11402 +2
- Misses 2431 2432 +1
- Partials 280 281 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
tmokmss
requested a deployment
to
test-pipeline
GitHub Actions
Waiting
tmokmss
requested a deployment
to
test-pipeline
GitHub Actions
Waiting
|
|
||
| try { | ||
| await fixture.cdkDeploy('simplified-import', { | ||
| }); |
There was a problem hiding this comment.
The integ-test steps:
- Create an AWS resource (e.g. ECR repository) to be imported
- Deploy a stack without importing resource (because cdk diff only works for an existing stack)
- Run cdk diff with the stack template that contains the resource to be imported
- assert cdk diff output
- destroy stack
- delete the AWS resource created at step 1
|
Exemption Request: this PR is for cli and will not need to update aws-cdk-lib integ tests. I added cli-integ test instead. |
aws-cdk-automation
added
pr-linter/exemption-requested
tmokmss
requested a deployment
to
test-pipeline
GitHub Actions
Waiting
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Issue # (if applicable)
Closes #32790.
Reason for this change
I want to know which resources are imported before deployment by just executing cdk diff.
Description of changes
This PR adds a new CLI option
--import-existing-resourcesto cdk diff command. The value is passed when cdk diff creates a change set.Describe any new or updated permissions being added
None.
Description of how you validated changes
I added a unit test and cli-integ test. Also I did E2E testing in my local environment.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license