パラメータと AWS CDK - AWS Cloud Development Kit (AWS CDK) v2

これは AWS CDK v2 デベロッパーガイドです。古い CDKv1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

パラメータと AWS CDK

パラメータは、デプロイ時に提供されるカスタム値です。パラメータは の機能です AWS CloudFormation。は AWS Cloud Development Kit (AWS CDK) AWS CloudFormation テンプレートを合成するため、デプロイ時間パラメータもサポートしています。

パラメータについて

を使用して AWS CDKパラメータを定義し、作成したコンストラクトのプロパティで使用できます。パラメータを含むスタックをデプロイすることもできます。

を使用して AWS CloudFormation テンプレートをデプロイする場合は AWS CDK CLI、コマンドラインにパラメータ値を指定します。 AWS CloudFormation コンソールからテンプレートをデプロイすると、パラメータ値の入力を求められます。

一般に、 で AWS CloudFormation パラメータを使用しないことをお勧めします AWS CDK。アプリケーションに AWS CDK 値を渡す通常の方法は、コンテキスト値と環境変数です。合成時には使用できないため、パラメータ値をCDKアプリケーション内のフロー制御やその他の目的に簡単に使用することはできません。

注記

パラメータを使用してフローを制御するには、 CfnConditionコンストラクトを使用できますが、ネイティブifステートメントと比較してこれは厄介です。

パラメータを使用するには、記述するコードがデプロイ時および合成時にどのように動作するかに注意する必要があります。これにより、多くの場合、ほとんど利点がないので、 AWS CDK アプリケーションを理解し、理由を説明することが難しくなります。

一般的に、CDKアプリは必要な情報を明確に定義された方法で受け入れ、それを使用してCDKアプリ内のコンストラクトを直接宣言することをお勧めします。理想的な AWS CDK生成 AWS CloudFormation テンプレートは具体的であり、デプロイ時に指定される値は残りません。

ただし、 AWS CloudFormation パラメータが一意に適しているユースケースがあります。例えば、インフラストラクチャを定義してデプロイするチームが別々の場合は、 パラメータを使用して、生成されたテンプレートをより広く有用にすることができます。また、 は AWS CloudFormation パラメータ AWS CDK をサポートしているため、 AWS CloudFormation テンプレートを使用する AWS サービス (Service Catalog など) AWS CDK で を使用できます。これらの AWS サービスは、パラメータを使用して、デプロイされるテンプレートを設定します。

詳細

パラメータを使用してCDKアプリケーションを開発する手順については、「」を参照してください CloudFormation パラメータを使用して CloudFormation 値を取得する