docs(toolkit-lib): resource import mapping docs say keys are construct tree paths, but they are logical IDs

[go-to-k]

Problem

Two doc comments in packages/@aws-cdk/toolkit-lib/lib/api/resource-import/importer.ts describe the resource mapping keys as CDK construct tree paths:

• importResourcesFromMap: @param importMap - Mapping from CDK construct tree path to physical resource import identifiers
• The ResourceMap type doc, whose example uses construct-path keys such as "MyStack/MyS3Bucket/Resource"

The implementation matches the mapping keys against CloudFormation logical IDs (resource.logicalId in askForResourceIdentifiers, loadResourceIdentifiers and makeResourcesToImport; the type is also declared as { [logicalResource: string]: ... }, and ImportMap.resourceMap is documented as "Mapping logical IDs to physical names"). Following the doc comment and using construct paths as keys in --resource-mapping / --resource-mapping-inline results in Unrecognized resource identifiers and 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 ResourceMap example.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.30%. Comparing base (785506e) to head (efb7e02).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1817      +/-   ##
==========================================
- Coverage   90.32%   90.30%   -0.02%     
==========================================
  Files          80       80              
  Lines       12124    12124              
  Branches     1716     1716              
==========================================
- Hits        10951    10949       -2     
- Misses       1139     1141       +2     
  Partials       34       34              

Flag	Coverage Δ
suite.unit	90.30% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.