docs(toolkit-lib): fix resource import mapping docs to say keys are logical IDs - #1817
Merged
Merged
Conversation
go-to-k
had a problem deploying
to
integ-approval
August 11, 2026 11:50 — with
GitHub Actions
Failure
aws-cdk-automation
enabled auto-merge
August 11, 2026 11:50
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1817 +/- ##
=======================================
Coverage 90.38% 90.38%
=======================================
Files 80 80
Lines 12195 12195
Branches 1734 1734
=======================================
Hits 11022 11022
Misses 1139 1139
Partials 34 34
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…onstruct tree paths, but they are logical IDs
mrgrain
force-pushed
the
docs-import-map-keys
branch
from
August 18, 2026 14:35
efb7e02 to
6655142
Compare
mrgrain
approved these changes
Aug 18, 2026
mrgrain
approved these changes
Aug 18, 2026
This file contains hidden or 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
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.
Problem
Two doc comments in
packages/@aws-cdk/toolkit-lib/lib/api/resource-import/importer.tsdescribe the resource mapping keys as CDK construct tree paths:importResourcesFromMap:@param importMap - Mapping from CDK construct tree path to physical resource import identifiersResourceMaptype doc, whose example uses construct-path keys such as"MyStack/MyS3Bucket/Resource"The implementation matches the mapping keys against CloudFormation logical IDs (
resource.logicalIdinaskForResourceIdentifiers,loadResourceIdentifiersandmakeResourcesToImport; the type is also declared as{ [logicalResource: string]: ... }, andImportMap.resourceMapis documented as "Mapping logical IDs to physical names"). Following the doc comment and using construct paths as keys in--resource-mapping/--resource-mapping-inlineresults inUnrecognized resource identifiersand zero resources imported. The confusion is compounded by the interactive display (describeResource), which shows construct paths.Fix
Correct both doc comments to say the keys are CloudFormation logical IDs, and use logical-ID keys in the
ResourceMapexample.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license