ElastiCache構築自動化テンプレート

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

前回は、DynamoDBを構築するテンプレートを実装しました。続く今回は、ElastiCacheを構築するテンプレートを作成します。

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

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

ElastiCacheは、連載「AWSで作るクラウドネイティブアプリケーションの基本」の第22回で実施した要領と同等のものを構築します。

ElastiCache(Redis)をCloudFormationで構築する場合、リソースタイプが「AWS::ElastiCache::ReplicationGroup」であるElastiCache定義^※1、および「AWS::ElastiCache::SubnetGroup」となるサブネットグループ定義、「AWS::ElastiCache::ParameterGroup」となるパラメータグループ定義が必要です。

プロパティとして設定可能な属性は、各リンク先の通りですが、ElastiCacheを商用環境／ステージング環境／開発環境^※2の3つのパターンに分けて作成するようにします。 テンプレートのサンプルは以下の通りです。

AWSTemplateFormatVersion: '2010-09-09'

// omit

Parameters:
  // omit
  EnvType:                                                                                                #(A)
    Description: Which environments to deploy your service.
    Type: String
    AllowedValues: ["Dev", "Staging", "Production"]
    Default: Dev
  SecurityGroupDev:                                                                                       #(B)
    Description: The local machine permitted SecurityGroup is needed as paramater for Dev.
    Type: String
    Default: ""
Conditions:                                                                                               #(C)
  DevResources: {"Fn::Equals" : [{"Ref":"EnvType"}, "Dev"]}

Mappings:
  CacheDefinitionMap:                                                                                     #(D)
    Production:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "yes"
      "AutomaticFailoverEnabled": true
      "ReplicasPerNodeGroup": 2
    Staging:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "no"
      "AutomaticFailoverEnabled": false
      "ReplicasPerNodeGroup": 1
    Dev:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "no"
      "AutomaticFailoverEnabled": false
      "ReplicasPerNodeGroup": 1

Resources:
  ElastiCacheSubnetGroup:                                                                                 #(E)
    Type: AWS::ElastiCache::SubnetGroup
    Properties:
      CacheSubnetGroupName: !Sub ElastiCacheSubnetGroup-${EnvType}
      Description: SampleCloudFormation ElastiCacheSubnetGroup
      SubnetIds:
        - Fn::ImportValue: !Sub ${VPCName}-PublicSubnet1
        - Fn::ImportValue: !Sub ${VPCName}-PublicSubnet2

  ElastiCacheParameterGroup:                                                                              #(F)
    Type: AWS::ElastiCache::ParameterGroup
    Properties:
      CacheParameterGroupFamily: !FindInMap [CacheDefinitionMap, !Ref EnvType, CacheParameterGroupFamily] #(G)
      Description: SampleCloudFormation ElastiCacheParameterGroup
      Properties:
        cluster-enabled: !FindInMap [CacheDefinitionMap, !Ref EnvType, ClusterEnabled]

  ElastiCacheRedis:                                                                                       #(H)
    Type: AWS::ElastiCache::ReplicationGroup
    Properties:
      ReplicationGroupId: !Sub elasticache-${EnvType}
      Engine: redis
      ReplicationGroupDescription: SampleCloudFormation RedisCluster
      EngineVersion: !FindInMap [CacheDefinitionMap, !Ref EnvType, EngineVersion]
      Port: !FindInMap [CacheDefinitionMap, !Ref EnvType, Port]
      CacheParameterGroupName: !Ref ElastiCacheParameterGroup
      CacheNodeType: !FindInMap [CacheDefinitionMap, !Ref EnvType, CacheInstanceType]
      ReplicasPerNodeGroup: !FindInMap [CacheDefinitionMap, !Ref EnvType, ReplicasPerNodeGroup]
      AutomaticFailoverEnabled: !FindInMap [CacheDefinitionMap, !Ref EnvType, AutomaticFailoverEnabled]
      CacheSubnetGroupName: !Ref ElastiCacheSubnetGroup
      SecurityGroupIds:
        - Fn::ImportValue: !Sub ${VPCName}-SecurityGroupElastiCacheRedis
        - !If ["DevResources", !Ref SecurityGroupDev, !Ref "AWS::NoValue"]                                 #(I)

Outputs:
 // omit
  ElastiCacheRedisEndPoint:                                                                                #(J)
    Description: ElastiCache Redis EndPoint
    Value: !GetAtt ElastiCacheRedis.PrimaryEndPoint.Address
    Export:
      Name: !Sub ${VPCName}-ElastiCacheRedisEndPoint

  ElastiCacheRedisPort:                                                                                    #(K)
    Description: ElastiCache Redis Port
    Value:  !FindInMap [CacheDefinitionMap, !Ref EnvType, Port]
    Export:
      Name: !Sub ${VPCName}-ElastiCacheRedisPort-${EnvType}

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

作成したテンプレートに対して、以下のようにスタック名とテンプレートパスを変更して、ヘルパースクリプトを実行します。今回はステージング環境を想定してパラメータを指定して実行します。

#!/usr/bin/env bash

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

parameters="EnvType=Staging"

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

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

以上、今回はElastiCacheを構築するCloudFormationテンプレートを実装しました。次回は、AmazonS3やAmazonSQSを構築するテンプレートを作成します。

※1　ElastiCacheには「AWS::ElastiCache::CacheCluster」というリソースタイプもありますが、Redisを使用する場合はノード数を2つ以上にするとエラーとなります。エンジンがRedisの場合は、AWS::ElastiCache::ReplicationGroupを使用しましょう。

※2　連載「AWSで作るクラウドネイティブアプリケーションの基本」の第19回では、開発環境はローカル環境にRedisServerを立てるかたちで解説しました。ElastiCacheはRDSやDynamoDBとは異なり、2020年2月時点でもパブリックアクセスが許可されていません(パブリックサブネットに配置してVPC外からエンドポイントを指定してもアクセスできません)。そのため、VPCの外にあるローカル開発環境でRedisへのアクセスを行いたい場合はローカルにRedisServerを立てる必要があります。開発環境でElastiCacheを使用したい場合はAmazon WorkspacesなどでVPC内に仮想マシン環境を用意する方法が簡易です。今回はVPC内に開発環境があることを想定して、開発環境用のElastiCacheをCloudFormationテンプレートで構築してみます。