CloudFormation パラメータを使用して CloudFormation 値を取得する

AWS Cloud Development Kit (AWS CDK) アプリケーション内の AWS CloudFormation パラメータを使用して、デプロイ時に合成された CloudFormation テンプレートにカスタム値を入力します。

概要については、「パラメータと AWS CDK」を参照してください。

CDK アプリでパラメータを定義する

CfnParameter クラスを使用してパラメータを定義します。ほとんどのパラメータに少なくとも 1 つの型と説明を指定する必要がありますが、どちらも技術的には任意です。説明は、ユーザーが AWS CloudFormation コンソールにパラメータの値を入力するように求められたときに表示されます。使用できる型の詳細については、「型」を参照してください。

const uploadBucketName = new CfnParameter(this, "uploadBucketName", {
  type: "String",
  description: "The name of the Amazon S3 bucket where uploaded files will be stored."});

パラメータの使用

CfnParameter インスタンスは、トークンを介してその値を CDK アプリケーションに公開します。他のトークンと同様、パラメータのトークンは合成時に解決されます。ただし、具体的な値ではなく、 AWS CloudFormation テンプレートで定義されたパラメータ (デプロイ時に解決されます) への参照が解決されます。

トークンは、Token クラスのインスタンスとして、または文字列、文字列リスト、または数値エンコーディングで取得できます。選択は、パラメータを使用するクラスまたはメソッドに必要な値の種類によって異なります。

たとえば、Bucket の定義にパラメータを使用するには、以下のように行います。

const bucket = new Bucket(this, "amzn-s3-demo-bucket", 
  { bucketName: uploadBucketName.valueAsString});

パラメータを含む CDK アプリケーションのデプロイ

AWS CloudFormation コンソールを使用して生成された AWS CloudFormation テンプレートをデプロイすると、各パラメータの値を指定するように求められます。

また、CDK CLI cdk deploy コマンドを使用するか、CDK プロジェクトのスタックファイルにパラメータ値を指定することでも、パラメータ値を指定できます。

cdk deployでパラメータ値を指定する

CDK CLI cdk deploy コマンドを使用してデプロイする場合、--parameters オプションを使用すると、デプロイ時にパラメータ値を指定できます。

以下は、cdk deploy コマンドの構造の例です。

$ cdk deploy stack-logical-id --parameters stack-name:parameter-name=parameter-value

CDK アプリケーションに 1 つのスタックが含まれている場合、--parameters オプションにスタックの論理 ID 引数または stack-name の値を指定する必要はありません。CDK CLI がこれらの値を自動的に検出して指定します。以下は、CDK アプリケーションの 1 つのスタックの uploadBucketName パラメータに uploadbucket の値を指定する場合の例です。

$ cdk deploy --parameters uploadBucketName=uploadbucket

マルチスタックアプリケーションの CDK デプロイでパラメータ値を指定する

以下は、2 つの CDK スタックを含む TypeScript の CDK アプリケーションの例です。各スタックには、Amazon S3 バケットインスタンスとAmazon S3バケット名を設定するパラメータが含まれています。

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';

// Define the CDK app
const app = new cdk.App();

// First stack
export class MyFirstStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Set a default parameter name
    const bucketNameParam = new cdk.CfnParameter(this, 'bucketNameParam', {
      type: 'String',
      default: 'myfirststackdefaultbucketname'
    });

    // Define an S3 bucket
    new s3.Bucket(this, 'MyFirstBucket', {
      bucketName: bucketNameParam.valueAsString
    });
  }
}

// Second stack 
export class MySecondStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Set a default parameter name
    const bucketNameParam = new cdk.CfnParameter(this, 'bucketNameParam', {
      type: 'String',
      default: 'mysecondstackdefaultbucketname'
    });

    // Define an S3 bucket
    new s3.Bucket(this, 'MySecondBucket', {
      bucketName: bucketNameParam.valueAsString
    });
  }
}

// Instantiate the stacks
new MyFirstStack(app, 'MyFirstStack', {
  stackName: 'MyFirstDeployedStack',
});

new MySecondStack(app, 'MySecondStack', {
  stackName: 'MySecondDeployedStack',
});

複数のスタックを含む CDK アプリケーションでは、以下を実行できます。

ネストされたスタックを持つアプリケーションに cdk deploy でパラメータ値を指定する

ネストされたスタックを含むアプリケーションで作業する際の CDK CLI の動作は、マルチスタックアプリケーションに似ています。主な違いは、ネストされたすべてのスタックをデプロイする場合は、'**' のワイルドカードを使用することです。'*' のワイルドカードはすべてのスタックをデプロイしますが、ネストされたスタックはデプロイしません。'**' のワイルドカードは、ネストされたスタックを含むすべてのスタックをデプロイします。

以下は、ネストされたスタックのパラメータ値を指定しながら、ネストされたスタックをデプロイする場合の例です。

$ cdk deploy '**' --parameters MultiStackCdkApp/SecondStack:bucketNameParam='mysecondstackbucketname'

cdk deploy コマンドオプションの詳細については、「cdk deploy」を参照してください。