CDK AWS v2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔으며 2023년 6월 1일에 지원이 종료되었습니다.

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

기존 리소스 및 AWS CloudFormation 템플릿을 AWS CDK로 마이그레이션

AWS 클라우드 개발 키트(AWS CDK) 명령줄 인터페이스(AWS CDK CLI)를 사용하여 배포된 AWS 리소스, 배포된 AWS CloudFormation 스택 및 로컬 AWS CloudFormation 템플릿을 AWS CDK로 마이그레이션합니다.

마이그레이션 작동 방식

AWS CDK CLI cdk migrate 명령을 사용하여 다음 소스에서 마이그레이션합니다.

CDK Migrate의 이점

리소스를 AWS CDK로 마이그레이션하는 것은 과거에는 AWS CloudFormation 및 AWS CDK의 시간과 전문 지식이 필요한 수동 프로세스였습니다. CDK Migrate를 사용하면 AWS CDK CLI를 사용하면 짧은 시간 내에 대부분의 마이그레이션 작업을 수행할 수 있습니다. CDK Migrate를 사용하면 AWS CDK를 사용하여에서 신규 및 기존 애플리케이션을 빠르게 개발하고 관리할 수 있습니다 AWS.

고려 사항

일반적인 고려 사항

AWS CloudFormation 템플릿에서 마이그레이션할 때 고려 사항

배포된 리소스에서 마이그레이션할 때 고려 사항

사전 조건

cdk migrate 명령을 사용하기 전에 AWS CDK 시작하기의 모든 설정 단계를 완료합니다.

CDK Migrate 시작하기

시작하려면 선택한 디렉터리에서 AWS CDK CLI cdk migrate 명령을 실행합니다. 수행 중인 마이그레이션 유형에 따라 필수 및 선택적 옵션을 제공합니다.

에서 사용할 수 있는 옵션의 전체 목록과 설명은 cdk 마이그레이션을 cdk migrate참조하세요.

다음은 제공하고자 하는 몇 가지 중요한 옵션입니다.

AWS CloudFormation 스택에서 마이그레이션

배포된 AWS CloudFormation 스택에서 마이그레이션하려면 --from-stack 옵션을 제공합니다. 를 사용하여 배포된 AWS CloudFormation 스택의 이름을 제공합니다--stack-name. 다음은 예제입니다.

$ cdk migrate --from-stack --stack-name "myCloudFormationStack"

AWS CDK CLI는 다음을 수행합니다.

배포된 AWS CloudFormation 스택에서 마이그레이션하면 AWS CDK CLI는 배포된 리소스 논리적 IDs 및 배포된 AWS CloudFormation 스택 이름을 새 CDK 앱의 마이그레이션된 리소스 및 스택과 일치시키려고 시도합니다.

마이그레이션 후 CDK 앱을 정상적으로 관리하고 수정할 수 있습니다. 배포 시 AWS CloudFormation은 일치하는 AWS CloudFormation 스택 이름으로 인해 배포를 AWS CloudFormation 스택 업데이트로 식별합니다. 일치하는 논리적 ID가 있는 리소스가 업데이트됩니다. 배포에 대한 자세한 내용은 CDK 앱 관리 및 배포를 참조하세요.

AWS CloudFormation 템플릿에서 마이그레이션

CDK Migrate는 JSON 또는 형식의 AWS CloudFormation 템플릿에서 마이그레이션을 지원합니다YAML.

local AWS CloudFormation 템플릿에서 마이그레이션하려면 --from-path 옵션을 사용하고 로컬 템플릿의 경로를 제공합니다. 필요한 --stack-name 옵션도 제공해야 합니다. 다음은 예제입니다.

$ cdk migrate --from-path "./template.json" --stack-name "myCloudFormationStack"

AWS CDK CLI는 다음을 수행합니다.

마이그레이션 후 CDK 앱을 정상적으로 관리하고 수정할 수 있습니다. 배포 시 다음 옵션이 있습니다.

AWS SAM 템플릿에서 마이그레이션

AWS 서버리스 애플리케이션 모델(AWS SAM) 템플릿에서 마이그레이션하려면 먼저 이를 AWS CloudFormation 템플릿으로 변환하거나 배포하여 AWS CloudFormation 스택을 생성해야 합니다.

AWS SAM 템플릿을 AWS CloudFormation으로 변환하려면 AWS SAM CLI sam validate --debug 명령을 사용할 수 있습니다. 이 명령을 실행하기 전에 samconfig.toml 파일에서 lint를 false로 설정해야 할 수도 있습니다.

AWS CloudFormation 스택으로 변환하려면 AWS SAM CLI를 사용하여 AWS SAM 템플릿을 배포합니다. 그런 다음 배포된 스택에서 마이그레이션합니다.

배포된 리소스에서 마이그레이션

배포된 AWS 리소스에서 마이그레이션하려면 --from-scan 옵션을 제공합니다. 필요한 --stack-name 옵션도 제공해야 합니다. 다음은 예제입니다.

$ cdk migrate --from-scan --stack-name "myCloudFormationStack"

AWS CDK CLI는 다음을 수행합니다.

필터 사용

기본적으로 AWS CDK CLI는 전체 AWS 환경을 스캔하고 IaC 생성기의 최대 할당량 한도까지 리소스를 마이그레이션합니다. AWS CDK CLI로 필터를 제공하여 리소스가 계정에서 새 CDK 앱으로 마이그레이션되는 기준을 지정할 수 있습니다. 자세한 내용은 --filter 를 참조하세요.

IaC 생성기를 사용하여 리소스 스캔

계정의 리소스 수에 따라 스캔에 몇 분이 걸릴 수 있습니다. 스캔 프로세스 중 진행률 표시줄이 표시됩니다.

쓰기 전용 속성 해결

지원되는 일부 리소스에는 쓰기 전용 속성이 포함되어 있습니다. 이러한 속성은 속성을 구성하기 위해에 쓸 수 있지만 값을 가져오기 위해 IaC 생성기 또는 AWS CloudFormation에서 읽을 수는 없습니다. 예를 들어 데이터베이스 암호를 지정하는 데 사용되는 속성은 보안상의 이유로 쓰기 전용일 수 있습니다.

마이그레이션 중 리소스를 스캔할 때 IaC 생성기는 쓰기 전용 속성을 포함할 수 있는 리소스를 탐지하고 다음 유형 중 하나로 분류합니다.

쓰기 전용 속성과 배포된 리소스를 스캔하고 AWS CloudFormation 템플릿을 생성할 때 IaC 생성기가 이를 관리하는 방법에 대한 자세한 내용은 AWS CloudFormation 사용 설명서의 IaC 생성기 및 쓰기 전용 속성을 참조하세요.

마이그레이션 후 새 CDK 앱에서 쓰기 전용 속성 값을 지정해야 합니다. AWS CDK CLI는 CDK 프로젝트의 ReadMe 파일에 경고 섹션을 추가하여 IaC 생성기로 식별된 모든 쓰기 전용 속성을 문서화합니다. 다음은 예제입니다.

# Welcome to your CDK TypeScript project
...
## Warnings
### Write-only properties
Write-only properties are resource property values that can be written to but can't be read by AWS CloudFormation or CDK Migrate. For more information, see [IaC generator and write-only properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html).

Write-only properties discovered during migration are organized here by resource ID and categorized by write-only property type. Resolve write-only properties by providing property values in your CDK app. For guidance, see [Resolve write-only properties](https://docs.aws.amazon.com/cdk/v2/guide/migrate.html#migrate-resources-writeonly).
### MyLambdaFunction
- **UNSUPPORTED_PROPERTIES**:
  - SnapStart/ApplyOn: Applying SnapStart setting on function resource type.Possible values: [PublishedVersions, None]
This property can be replaced with other types
  - Code/S3ObjectVersion: For versioned objects, the version of the deployment package object to use.
This property can be replaced with other exclusive properties
- **MUTUALLY_EXCLUSIVE_PROPERTIES**:
  - Code/S3Bucket: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
This property can be replaced with other exclusive properties
  - Code/S3Key: The Amazon S3 key of the deployment package.
This property can be replaced with other exclusive properties

migration.json 파일

AWS CDK CLI는 마이그레이션 중에 AWS CDK 프로젝트에 migrate.json 파일을 생성합니다. 이 파일에는 배포된 리소스에 대한 참조 정보가 있습니다. CDK 앱을 처음 배포하면 AWS CDK CLI는이 파일을 사용하여 배포된 리소스를 참조하고, 리소스를 새 AWS CloudFormation 스택과 연결하고, 파일을 삭제합니다.

CDK 앱 관리 및 배포

AWS CDK로 마이그레이션할 때 새 CDK 앱이 즉시 배포 준비가 되지 않을 수 있습니다. 이 주제에서는 새 CDK 앱을 관리하고 배포할 때 고려해야 할 작업 항목을 설명합니다.

배포 준비

배포하기 전에 CDK 앱을 준비해야 합니다.

CDK 앱 배포

CDK 앱을 배포할 때 AWS CDK CLI는 AWS CloudFormation 서비스를 사용하여 리소스를 프로비저닝합니다. 리소스는 CDK 앱의 단일 스택으로 번들링되고 단일 AWS CloudFormation 스택으로 배포됩니다.

마이그레이션한 위치에 따라를 배포하여 새 AWS CloudFormation 스택을 생성하거나 기존 AWS CloudFormation 스택을 업데이트할 수 있습니다.