AWS CDKでphase単位でスタックを構築する方法

AWS CDKを使ってAWSのリソース構築などを行っている際に、1つのCDKコードでPhaseに応じて複数のスタックを作成したい場合があります。

CloudFormationではParameterなどを利用していましたが、AWS CDKでのよやり方を調べた際のことをメモします。

本記事の内容

1. 前提
2. Contextの利用
3. app.pyで値を受け取る
4. リソース定義コード(cdk_project_stack.py)で値を受け取る
5. まとめ
AWSを効率的に学習する方法
- ①AWS基礎学習
- ②AWS資格取得

1. 前提

Pythonはインストール済
AWS CDKはインストール済
PythonでCDKプロジェクト作成済(例としてプロジェクト名はcdk-project)

2. Contextの利用

調べて見たところ、cdk deployコマンドを実行する際に「-c」オプションをつけることで引数として利用できる様です。
以下のような感じです。

cdk deploy -c "phase=prod"

3. app.pyで値を受け取る

コンテキストで渡された値を受け取ります。
まずは、app.py内でスタックを構築しているので以下のようにして受け取って利用します。

「app.node.try_get_context」で値を取得できます。
今回はデフォルトを[dev]とし、スタックの先頭にphaseをつけるようにしました。

from aws_cdk import core
from aws_cdk_getamzndata.aws_cdk_getamzndata_stack import AwsCdkGetamzndataStack
app = core.App()

phase = "dev"  # default value
if app.node.try_get_context("phase"):
    phase = str(app.node.try_get_context("phase"))

CdkProjectStack(app, phase+"-cdk-project",)

4. リソース定義コード(cdk_project_stack.py)で値を受け取る

あとは、実際にリソースを構築している「cdk_project_stack.py」で値を使ってphaseごとのリソースを作成します。

先ほどと同様にコンテキストから値を受け取って、各リソースの先頭にphaseを付けています。
例としてDynamoDBを作成しています。

class CdkProjectStack(cdk.Stack):

    def __init__(self, scope: cdk.Construct, construct_id: str, **kwargs) -> None:
        super().__init__(scope, construct_id, **kwargs)

        phase = "dev"  # default value
        if self.node.try_get_context("phase"):
            phase = str(self.node.try_get_context("phase"))

        # dynamodb
        dynamo_table = ddb.Table(
            self, phase+'-cdk-project-table',
            partition_key={'name': 'user_id',
                           'type': ddb.AttributeType.STRING},
            sort_key={'name': 'sample_id',
                      'type': ddb.AttributeType.STRING},
        )