これは AWS CDK v2 開発者ガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

パラメータと AWS CDK

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

パラメータについて

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

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

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

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

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

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

詳細はこちら

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