cdk import - AWS Cloud Development Kit (AWS CDK) v2
使用方法引数オプション

これは AWS CDK v2 デベロッパーガイドです。古い 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。この引数は、1 つのコマンドで複数回指定できます。

タイプ: 文字列

必須: いいえ

オプション

すべての CDK CLI コマンドで動作するグローバルオプションのリストについては、「」を参照してくださいグローバルオプション。

--change-set-name STRING

作成する CloudFormation 変更セットの名前。

--execute BOOLEAN

変更セットを実行するかどうかを指定します。

デフォルト値: true

--force, -f BOOLEAN

デフォルトでは、テンプレート差分に更新または削除が含まれている場合、CDK はプロセスをCLI終了します。この動作trueを上書きし、常にインポートを続行するには、 を指定します。

--help, -h BOOLEAN

コマンドのcdk importコマンドリファレンス情報を表示します。

--record-resource-mapping, -r STRING

このオプションを使用して、インポートされる CDK リソースへの既存の物理リソースのマッピングを生成します。マッピングは、指定したファイルパスに書き込まれます。実際のインポートオペレーションは実行されません。

--resource-mapping, -m STRING

このオプションを使用して、リソースマッピングを定義するファイルを指定します。CDK CLIはこのファイルを使用して、インタラクティブに質問するのではなく、インポートのために物理リソースをリソースにマッピングします。

このオプションはスクリプトから実行できます。

--rollback BOOLEAN

障害発生時にスタックを安定状態にロールバックします。

を指定するにはfalse、 --no-rollbackまたは を使用できます-R。

を指定するfalseと、より迅速に反復処理できます。リソース置換を含むデプロイは常に失敗します。

デフォルト値: true

--toolkit-stack-name STRING

作成する CDK Toolkit スタックの名前