DynamoDB構築自動化テンプート

本連載では、以下のイメージの構成にあるAWSリソース基盤自動化環境の構築を実践しています。

前回は、バックエンドサブネットからのアクセスを想定したRDS(RelationalDatabaseService)を構築するCloudFormationテンプレートを実装しました。続く今回は、DynamoDBを構築するテンプレートを作成します。

なお、実際のソースコードはGitHub上にコミットしています。以降のソースコードでは本質的でない記述を一部省略しているので、実行コードを作成する場合は、必要に応じて適宜GitHub上のソースコードも参照してください。

DynamoDBスタック構築テンプレート

DynamoDBは連載「AWSで作るクラウドネイティブアプリケーションの基本」の第16回で実施した要領と同等のものを構築します。と言っても、CloudFormationで構築する場合、リソースタイプが「AWS::DynamoDB::Table」となるテーブル定義を作成するだけです。プロパティとして設定可能な属性は、各リンク先の通りですが、加えて、Conditions要素を使って、DynamoDBを商用環境、ステージング環境、開発環境という3つのパターンに分けて作成するようにします。

前回のRDSでは、Conditionsを定義した上で、Resources配下にCondition要素を設定することにより、各パターンごとに切り替えて作成しましたが、今回はConditions定義と条件関数を使って、作成するリソースを切り替えるかたちで実装してみます。

テンプレートのサンプルは以下の通りです。

AWSTemplateFormatVersion: '2010-09-09'

// omit

Parameters:
  // omit
  EnvType:                                                                                                                          #(A)
    Description: Which environments to deploy your service.
    Type: String
    AllowedValues: ["Dev", "Staging", "Production"]
    Default: Dev
Conditions:                                                                                                                         #(B)
  ProductionResources: {"Fn::Equals" : [{"Ref":"EnvType"}, "Production"]}
  StagingResources: !Equals [ !Ref EnvType, "Staging"]
  DevResources: {"Fn::Equals" : [{"Ref":"EnvType"}, "Dev"]}

Resources:
  DynamoDBSampleTable:                                                                                                              #(C)
    Type: AWS::DynamoDB::Table
    Properties:
      TableName: !If ["ProductionResources", "sample-table",  !If ["StagingResources", "staging_sample-table", "dev_sample-table"]] #(D)
      BillingMode: PROVISIONED
      SSESpecification: !If ["ProductionResources", { "SSEEnabled" : true }, !Ref "AWS::NoValue"]                                   #(E)
      AttributeDefinitions:
        - AttributeName: samplePartitionKey
          AttributeType: S
        - AttributeName: sampleSortKey
          AttributeType: S
      KeySchema:
        - AttributeName: samplePartitionKey
          KeyType: HASH
        - AttributeName: sampleSortKey
          KeyType: RANGE
      ProvisionedThroughput:
        ReadCapacityUnits: 5
        WriteCapacityUnits: 5

Outputs:
  EnvironmentRegion:                                                                                                                #(F)
    Description: Dev Environment Region
    Value: !Sub ${AWS::Region}
    Export:
      Name: !Sub MynaviSampleDynamoDB-${EnvType}-Region
  DynamoDBServiceEndpoint:                                                                                                          #(G)
    Description: DynamoDB service endipoint
    Value: !Sub https://dynamodb.${AWS::Region}.amazonaws.com
    Export:
      Name: !Sub MynaviSampleDynamoDB-${EnvType}-ServiceEndpoint
  DynamoDBProduction:                                                                                                               #(H)
    Condition: "ProductionResources"                                                                                                #(I)
    Description: DynamoDB SampleTable for Production
    Value: !Ref DynamoDBSampleTable
    Export:
      Name: !Sub ${VPCName}-DynamoDBProductionSampleTable
  DynamoDBTableStaging:                                                                                                             #(J)
    Condition: "StagingResources"
    Description: DynamoDB SampleTable for Staging
    Value: !Ref DynamoDBSampleTable
    Export:
      Name: !Sub ${VPCName}-DynamoDBStagingSampleTable

 // omit

DynamoDBのテンプレートの記述の基本となるポイントは下表の通りです。

作成したテンプレートに対して、以下のようにスタック名とテンプレートパスを変更してヘルパースクリプトを実行します。

#!/usr/bin/env bash

stack_name="mynavi-sample-dynamodb"
template_path="sample-dynamodb-cfn.yml"

parameters="EnvType=Production"

aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --parameter-overrides ${parameters} --capabilities CAPABILITY_IAM

実行が正常に終了すると、DynamoDBが作成されます。

以上、今回はConditions要素や条件関数、擬似パラメータ参照を使いながら、DynamoDBを構築するCloudFormationテンプレートを実装しました。次回は、ElastiCacheを構築するテンプレートを作成します。