これは 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 リソースをプロビジョニングまたは更新できます。

CDK Migrate のメリット

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

考慮事項

一般的な考慮事項

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

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

前提条件

cdk migrateコマンドを使用する前に、次のことを行ってください。

CDK マイグレーションを始めましょう。

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

移行後は、CDK アプリを通常どおり管理および変更できます。 AWS CloudFormation デプロイすると、 AWS CloudFormation AWS CloudFormation スタック名が一致するため、デプロイがスタックの更新であると認識されます。論理 ID が一致するリソースは更新されます。デプロイの詳細については、を参照してくださいCDK アプリを管理してデプロイします。。

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

CDK Migrate は、 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 CLIsam validate --debugコマンドを使用できます。このコマンドを実行する前に、lintfalsesamconfig.tomlファイル内でを () に設定しなければならない場合があります。

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 Generator AWS CloudFormation による読み取りや値の取得はできません。たとえば、データベースパスワードの指定に使用されるプロパティは、セキュリティ上の理由から書き込み専用になっている場合があります。

移行中にリソースをスキャンする際、IaC Generator は書き込み専用プロパティを含む可能性のあるリソースを検出し、以下のタイプのいずれかに分類します。

書き込み専用プロパティと、 AWS CloudFormation デプロイされたリソースをスキャンしてテンプレートを作成するときの IaC Generator による管理方法の詳細については、『ユーザーガイド』の「IaC ジェネレーターと書き込み専用プロパティ」を参照してください。AWS CloudFormation

移行後は、新しい CDK アプリで書き込み専用プロパティ値を指定する必要があります。 AWS CDK CLIは CDK ReadMe プロジェクトのファイルに Warnings セクションを追加して、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 CLImigrate.json AWS CDK は移行中にプロジェクト内にファイルを作成します。このファイルには、デプロイされたリソースに関する参照情報が含まれています。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