AWS CDK v2 개발자 안내서입니다. 구형 CDK v1은 2022년 6월 1일에 유지 보수에 들어갔고 2023년 6월 1일에 지원이 종료되었습니다.

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

기존 리소스 및 AWS CloudFormation 템플릿을 다음으로 마이그레이션하십시오. AWS CDK

AWS Cloud Development Kit (AWS CDK) 명령줄 인터페이스 (AWS CDK CLI) 를 사용하여 배포된 AWS 리소스, 배포된 AWS CloudFormation 스택 및 로컬 AWS CloudFormation 템플릿을 로 마이그레이션할 수 AWS CDK있습니다.

마이그레이션 작동 방식

AWS CDK CLIcdk migrate명령을 사용하여 다음 소스에서 마이그레이션하십시오.

마이그레이션한 후에는 CDK 앱을 관리, 수정, 배포하여 리소스를 프로비저닝하거나 업데이트할 수 있습니다. AWS CloudFormation

Migrate의 CDK 이점

지금까지 리소스를 마이그레이션하는 작업은 수동 프로세스였기 때문에 AWS CDK 시작까지 AWS CloudFormation 시간과 전문 지식이 필요합니다. AWS CDK CDKMigrate를 AWS CDK CLI 사용하면 짧은 시간 안에 마이그레이션 작업의 대부분을 수월하게 처리할 수 있습니다. CDKMigrate를 사용하면 새 응용 프로그램 및 기존 응용 프로그램을 개발하고 관리하는 AWS CDK 데 사용할 수 있는 작업을 빠르게 시작할 수 있습니다. AWS

고려 사항

일반적인 고려 사항

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

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

사전 조건

cdk migrate명령을 사용하기 전에 에서 모든 설정 단계를 완료하십시오시작하기 AWS CDK.

CDKMigrate를 시작하세요

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

함께 cdk migrate 사용할 수 있는 옵션의 전체 목록 및 설명은 을 참조하십시오cdk migrate.

제공할 수 있는 몇 가지 중요한 옵션은 다음과 같습니다.

AWS CloudFormation 스택에서 마이그레이션하세요.

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

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

AWS CDK CLI는 다음과 같은 작업을 수행합니다.

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

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

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

CDKMigrate는 또는 형식의 AWS CloudFormation 템플릿에서 마이그레이션할 수 있도록 지원합니다. JSON YAML

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

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

AWS CDK CLI다음 작업을 수행합니다.

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

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

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

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

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

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

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

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

AWS CDK CLI다음 작업을 수행합니다.

필터 사용

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

IaC 생성기로 리소스 스캔하기

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

쓰기 전용 속성 해결

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

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

쓰기 전용 속성과 IaC Generator가 배포된 리소스를 검색하고 AWS CloudFormation 템플릿을 만들 때 쓰기 전용 속성을 관리하는 방법에 대한 자세한 내용은 사용 설명서의 IaC 생성기 및 쓰기 전용 속성을 참조하십시오.AWS CloudFormation

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

# 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

쓰기 전용 속성 값을 모두 확인했으면 배포를 준비할 준비가 된 것입니다.

마이그레이션.json 파일

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

앱 관리 및 배포 CDK

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

배포 준비

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

앱을 배포하세요. CDK

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

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