これは AWS CDK v2 デベロッパーガイドです。古い v1 CDK は 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 CLI cdk migrate 次のソースから移行する コマンド。

移行後、 CDK アプリケーションを管理、変更、デプロイ AWS CloudFormation して、 リソースをプロビジョニングまたは更新できます。

CDK 移行の利点

リソースを に移行する AWS CDK のは、これまで手動プロセスでした。そのためには、 AWS CloudFormation と との時間と専門知識 AWS CDK が必要です。CDK Migrate では、 AWS CDK CLI は、移行作業の大部分を短時間で促進します。CDK Migrate を使用すると、 を使用して で新規および既存のアプリケーションを開発および管理 AWS CDK し始めることができます AWS。

考慮事項

一般的な考慮事項

AWS CloudFormation テンプレートから移行する際の考慮事項

デプロイされたリソースから移行する際の考慮事項

前提条件

cdk migrate コマンドを使用する前に、 のすべてのセットアップ手順を完了しますの開始方法 AWS CDK。

CDK 移行の開始方法

開始するには、 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 スタックから移行すると、 AWS CDK CLI は、デプロイされたリソース論理IDsとデプロイされた AWS CloudFormation スタック名を、移行されたリソースと新しいCDKアプリケーションのスタックと照合しようとします。

移行後は、CDKアプリを正常に管理および変更できます。デプロイすると、 AWS CloudFormation は、一致する AWS CloudFormation スタック名のために、デプロイを AWS CloudFormation スタック更新として識別します。一致する論理を持つリソースIDsが更新されます。デプロイの詳細については、「」を参照してくださいCDK アプリケーションの管理とデプロイ。

AWS CloudFormation テンプレートからの移行

CDK 移行では、 JSONまたは でフォーマットされた AWS CloudFormation テンプレートからの移行がサポートされています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 コマンド。このコマンドを実行する前に、 samconfig.toml ファイルfalseで 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 ジェネレーターの最大クォータ制限までリソースを移行します。フィルターには、 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

書き込み専用プロパティ値をすべて解決したら、デプロイの準備が整います。

migrate.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アプリ内の 1 つのスタックにバンドルされ、1 つの AWS CloudFormation スタックとしてデプロイされます。

移行元に応じて、 をデプロイして新しい AWS CloudFormation スタックを作成したり、既存の AWS CloudFormation スタックを更新したりできます。