cdk import - AWS Cloud Development Kit (AWS CDK) v2
사용량인수옵션

v AWS CDK 2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔고 2023년 6월 1일에 지원을 종료했습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

cdk import

AWS CloudFormation 리소스 가져오기를 사용하여 기존 AWS 리소스를 CDK 스택으로 가져옵니다.

이 명령을 사용하면 다른 방법을 사용하여 생성된 기존 리소스를 가져와 를 사용하여 관리할 수 있습니다 AWS CDK.

리소스를 CDK 관리로 이전하는 것을 고려할 때 IAM 역할, Lambda 함수 및 이벤트 규칙과 같은 새 리소스를 생성하는 것이 허용되는 경우가 있습니다. Amazon S3 버킷 및 DynamoDB 테이블과 같은 상태 저장 리소스와 같은 다른 리소스의 경우 새 리소스를 생성하면 서비스에 영향을 미칠 수 있습니다. cdk import 를 사용하여 서비스에 대한 중단을 최소화하면서 기존 리소스를 가져올 수 있습니다. 지원되는 AWS 리소스 목록은 AWS CloudFormation 사용 설명서의 리소스 유형 지원을 참조하세요.

기존 리소스를 CDK 스택으로 가져오려면

  1. 를 실행cdk diff하여 CDK 스택에 보류 중인 변경 사항이 없는지 확인합니다. 를 수행할 때 가져오기 작업에서 허용되는 cdk import유일한 변경 사항은 가져오려는 새 리소스를 추가하는 것입니다.

  2. 스택으로 가져오려는 리소스의 구성 요소를 추가합니다. 예를 들어 Amazon S3 버킷에 대해 다음을 추가합니다.

    new s3.Bucket(this, 'ImportedS3Bucket', {});

    다른 변경 사항은 추가하지 마세요. 또한 리소스의 현재 상태를 정확하게 모델링해야 합니다. 버킷 예제의 경우 AWS KMS 키, 수명 주기 정책 및 버킷과 관련된 기타 사항을 포함해야 합니다. 그렇지 않으면 후속 업데이트 작업이 예상대로 수행되지 않을 수 있습니다.

  3. cdk import를 실행합니다. CDK 앱에 스택이 여러 개 있는 경우 특정 스택 이름을 인수로 전달합니다.

  4. 는 CDK CLI 는 가져오려는 리소스의 실제 이름을 전달하라는 메시지를 표시합니다. 이 정보를 제공하면 가져오기가 시작됩니다.

  5. 가 cdk import 성공하면 리소스는 에서 관리됩니다CDK. 구성 구성의 모든 후속 변경 사항은 리소스에 반영됩니다.

이 기능은 현재 다음과 같은 제한이 따릅니다.

  • 리소스를 중첩된 스택으로 가져오는 것은 불가능합니다.

  • 지정한 속성이 가져온 리소스에 대해 올바르고 완전한지 확인할 수 없습니다. 가져오기 후 드리프트 감지 작업을 시작해 보세요.

  • 다른 리소스에 의존하는 리소스는 모두 함께 또는 개별적으로 올바른 순서로 가져와야 합니다. 그렇지 않으면 확인되지 않은 참조와 함께 CloudFormation 배포가 실패합니다.

  • 이 명령은 배포 역할 자격 증명을 사용하며, 암호화된 스테이징 버킷을 읽는 데 필요합니다. 이를 위해서는 배포 역할에 필요한 IAM 권한이 포함된 부트스트랩 템플릿 버전 12가 필요합니다.

사용량

$ cdk import <arguments> <options>

인수

CDK 스택 ID

리소스를 가져올 앱에서 CDK 스택의 구성 ID입니다. 이 인수는 단일 명령으로 여러 번 제공될 수 있습니다.

유형: 문자열

필수 항목 여부: 아니요

옵션

모든 과 함께 작동하는 글로벌 옵션 목록 CDK CLI 명령을 참조하세요글로벌 옵션.

--change-set-name STRING

생성할 CloudFormation 변경 세트의 이름입니다.

--execute BOOLEAN

변경 세트를 실행할지 여부를 지정합니다.

기본값: true

--force, -f BOOLEAN

기본적으로 CDK CLI 템플릿 diff에 업데이트 또는 삭제가 포함된 경우 가 프로세스를 종료합니다. 이 동작을 재정의하고 항상 가져오기true를 계속하려면 를 지정합니다.

--help, -h BOOLEAN

명령에 대한 cdk import 명령 참조 정보를 표시합니다.

--record-resource-mapping, -r STRING

이 옵션을 사용하여 가져올 리소스에 대한 기존 물리적 CDK 리소스의 매핑을 생성합니다. 매핑은 사용자가 제공하는 파일 경로에 기록됩니다. 실제 가져오기 작업은 수행되지 않습니다.

--resource-mapping, -m STRING

이 옵션을 사용하여 리소스 매핑을 정의하는 파일을 지정합니다. 는 CDK CLI 는 이 파일을 사용하여 물리적 리소스를 대화형으로 요청하는 대신 가져올 리소스에 매핑합니다.

이 옵션은 스크립트에서 실행할 수 있습니다.

--rollback BOOLEAN

실패 시 스택을 안정적인 상태로 롤백합니다.

를 지정하려면 --no-rollback 또는 를 사용할 false수 있습니다-R.

더 빠르게 반복false하도록 지정합니다. 리소스 교체가 포함된 배포는 항상 실패합니다.

기본값: true

--toolkit-stack-name STRING

생성할 CDK Toolkit 스택의 이름입니다.

기본적으로 는 라는 스택CDKToolkit을 지정된 AWS 환경에 cdk bootstrap 배포합니다. 이 옵션을 사용하여 부트스트랩 스택의 다른 이름을 입력합니다.

는 CDK CLI 는 이 값을 사용하여 부트스트랩 스택 버전을 확인합니다.