fix(cli): cannot cdk import resources with multiple identifiers
#24439
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
Some resources that can be imported by CloudFormation allow multiple identifiers. For example, `AWS::DynamoDB::GlobalTable` allows `TableName`, `TableArn`, and `TableStreamArn`. The CLI used to interpret multiple identifiers as "all must be present", but the contract is actually "exactly one must be present": * CloudFormation would fail the import if you supply all the fields; * but CDK would skip the import if you left one out. The effect is that it is impossible to import resources that allow more than one identifier. Fix this by being satisfied as soon as we have one identifier from the set, instead of expecting all of them to be filled. Fixes #20895.
aws-cdk-automation
previously requested changes
Mar 3, 2023
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. 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.
aws-cdk-automation
added
the
pr/needs-cli-test-run
rix0rrr
added
pr-linter/exempt-integ-test
|
Ah the reality is slightly more complicated.
|
rix0rrr
changed the title
cdk import resources that allow multiple identifierscdk import resources with multiple identifiers
rix0rrr
added
the
pr-linter/cli-integ-tested
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.
aws-cdk-automation
removed
the
pr/needs-cli-test-run
RomainMuller
approved these changes
Mar 6, 2023
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
homakk
pushed a commit
to homakk/aws-cdk
that referenced
this pull request
Mar 28, 2023
…s#24439) When CloudFormation tells us about identifiers for resources it can import, it returns a `string[]`. Our CLI used to interpret this as a set of identifiers that all must be present. Instead, the contract is actually: each `string` is a comma-separated list of identifiers that must be present together, but from all `strings` exactly one key combination should be supplied (and not multiple). So: * `['BucketName']` -> Supply BucketName (easy) * `['TableName', 'TableArn']` -> supply exactly one of TableName or TableArn (but not both) * `['HostedZoneId,Name']` -> supply BOTH HostedZoneId and Name. Because of our misinterpretations, both the cases of resources with multiple POSSIBLE identifiers as well as multiple REQUIRED identifiers would fail to import. Make the code correctly model the expect types: identifiers are a `string[][]`, where the outer array indicates `OR` and the inner array indicates `AND`. * For any of the combinations of properties we can lift from the template, prompt the user to confirm (typically 0 or 1, might be more). If the user rejected any of them, we don't do the resource at all. * If we couldn't lift any full key from the template, ask the user for the properties of each compound key, lifting parts of it from the template if possible. Fixes aws#20895. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
When CloudFormation tells us about identifiers for resources it can import, it returns a
string[].Our CLI used to interpret this as a set of identifiers that all must be present. Instead, the contract is actually: each
stringis a comma-separated list of identifiers that must be present together, but from allstringsexactly one key combination should be supplied (and not multiple).So:
['BucketName']-> Supply BucketName (easy)['TableName', 'TableArn']-> supply exactly one of TableName or TableArn (but not both)['HostedZoneId,Name']-> supply BOTH HostedZoneId and Name.Because of our misinterpretations, both the cases of resources with multiple POSSIBLE identifiers as well as multiple REQUIRED identifiers would fail to import.
Make the code correctly model the expect types: identifiers are a
string[][], where the outer array indicatesORand the inner array indicatesAND.Fixes #20895.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license