Skip to content

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

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.

Sign up for GitHub

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

Open
go-to-k wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/@aws-cdk/toolkit-lib/lib/api/resource-import/importer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ export type ResourceIdentifiers = { [resourceType: string]: string[][] };
type ResourceIdentifierProperties = Record<string, string>;

/**
* Mapping of CDK resources (L1 constructs) to physical resources to be imported
* in their place, example:
* Mapping of CDK resources (by their CloudFormation logical ID) to physical
* resources to be imported in their place, example:
*
* ```
* {
* "MyStack/MyS3Bucket/Resource": {
* "MyS3Bucket1A2B3C4D": {
* "BucketName": "my-manually-created-s3-bucket"
* },
* "MyStack/MyVpc/Resource": {
* "MyVpc5E6F7G8H": {
* "VpcId": "vpc-123456789"
* }
* }
Expand Down Expand Up @@ -192,7 +192,7 @@ export class ResourceImporter {
* Based on the provided resource mapping, prepare CFN structures for import (template,
* ResourcesToImport structure) and perform the import operation (CloudFormation deployment)
*
* @param importMap - Mapping from CDK construct tree path to physical resource import identifiers
* @param importMap - Mapping from CloudFormation logical ID to physical resource import identifiers
* @param options - Options to pass to CloudFormation deploy operation
*/
public async importResourcesFromMap(importMap: ImportMap, options: ImportDeploymentOptions = {}) {
Expand Down
Loading