■ はじめに

AWS CloudFormationで、
環境 (dev/stage/prod) によって値を切り替えたい。

https://dk521123.hatenablog.com/entry/2022/07/02/214543

で、条件分岐を行ったが、それ以外の方法で、
Mappings が使えそうなので、調べてみた

【１】Mappings
【２】利点
　１）可読性・拡張性の良さ
　２）AWSコスト削減
　３）セキュリティ強化
【３】定義
【４】値の参照
　１）組み込み関数 !FindInMap / Fn::FindInMap
【５】サンプル
　例１：環境によってインスタンスタイプを変更する
　例２：環境によってKMSキーポリシーのPrincipalを切り替える

【１】Mappings

* キー・バリュー型の定数を定義できる
* 値は String または List 
* 指定した値は、「Resources」で使用できる

https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html

【２】利点

Mappings を使った値を切り替えることは、
個人的には以下の恩恵を受けられると思う

１）可読性・拡張性の良さ

* 以下の関連記事で扱った Conditions セクション / 条件関数 !IF を
　使った切り替えより、圧倒的に可読性・拡張性の高いコードになる

CloudFormation ～条件分岐～
https://dk521123.hatenablog.com/entry/2022/07/02/214543

２）AWSコスト削減

* 「【５】サンプル」の「例１」のように、
　InstanceTypeを切り替えることにより
　コストを節約することが可能

３）セキュリティ強化

* 「【５】サンプル」の「例２」のように、
　IAM Policy でAllowする際に、必要な部分のみ許可するので
　セキュリティ強化につながる

【３】定義

  Mappings:
    # Mappings「MapperForEnv」を定義
    MapperForEnv:
      # キー
      dev:
        # バリュー（devだったら、この値になる）
        ConfFilePath: "conf/dev.yaml"
      stage: 
        ConfFilePath: "conf/stage.yaml"
      prod: 
        ConfFilePath: "conf/prod.yaml"

複数定義する場合

Mappings:
  EnvMapper:
    dev:
      AwsAccountId: 11111111111111
      VpcCidr: 10.0.3.0/24
      InstanceType: t2.micro
      # List も使える
      S3BucketArns:
        - arn:aws:s3::::your-s3-bucket-dev-1
        - arn:aws:s3::::your-s3-bucket-dev-1/*
        - arn:aws:s3::::your-s3-bucket-dev-2
        - arn:aws:s3::::your-s3-bucket-dev-2/*
    stage:
      AwsAccountId: 222222222222222
      VpcCidr: 10.0.2.0/24
      InstanceType: t2.small
      S3BucketArns:
        - arn:aws:s3::::your-s3-bucket-stage-1
        - arn:aws:s3::::your-s3-bucket-stage-1/*
        - arn:aws:s3::::your-s3-bucket-stage-2
        - arn:aws:s3::::your-s3-bucket-stage-2/*
    prod:
      AwsAccountId: 33333333333333
      VpcCidr: 10.0.1.0/24
      InstanceType: t2.medium
      S3BucketArns:
        - arn:aws:s3::::your-s3-bucket-prod-1
        - arn:aws:s3::::your-s3-bucket-prod-1/*
        - arn:aws:s3::::your-s3-bucket-prod-2
        - arn:aws:s3::::your-s3-bucket-prod-2/*

【４】値の参照

* 組み込み関数 !FindInMap / Fn::FindInMap を使って参照する
* なお、組み込み関数に関する詳細は、以下の関連記事を参照

CloudFormation ～組み込み関数～
https://dk521123.hatenablog.com/entry/2021/12/04/202519

例：「【３】定義」のサンプルを参照する場合

Value: !FindInMap [MapperForEnv, !Ref EnvironmentType, ConfFilePath]

１）組み込み関数 !FindInMap / Fn::FindInMap

* Mappings セクションで宣言されたマップのキーに対応する値を返却

https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html

# 完全名関数の構文
Fn::FindInMap: [ MapName, TopLevelKey, SecondLevelKey ]

# 短縮形の構文
!FindInMap [ MapName, TopLevelKey, SecondLevelKey ]

第1引数：MapName

* Mappings セクションで宣言された、キーと値を含むマッピングの論理名

第2引数：TopLevelKey

* 最上位のキー名。この値は、キーと値のペアのリスト

SecondLevelKey

* 2 番目のレベルのキー名で、
　TopLevelKey に割り当てられたリストのキーの 1 つに設定。

【５】サンプル

例１：環境によってインスタンスタイプを変更する

AWSTemplateFormatVersion: "2010-09-09"
Description: This is a sample

Parameters:
  Env:
    Description: Environment.
    Type: String
    AllowedValues:
      - dev
      - stage
      - prod
    Default: dev

Mappings:
  InstanceTypeMapper:
    dev:
      InstanceType : t2.micro
    stage:
      InstanceType : t2.small
    prod:
      InstanceType: t2.medium

Resources:
  DemoEC2Instance:
    Type: "AWS::EC2::Instance"
    Properties:
      InstanceType : !FindInMap [InstanceTypeMapper, !Ref Env, InstanceType]

# [別の書き方]
#      InstanceType: !FindInMap
#        - InstanceTypeMapper
#        - !Ref Env
#        - InstanceType

例２：環境によってKMSキーポリシーのPrincipalを切り替える

AWSTemplateFormatVersion: "2010-09-09"
Description: "This is a demo for KMS"

Parameters:
  Env:
    Description: Environment
    Type: String
    Default: dev
    AllowedValues:
      - dev
      - stage
      - prod

Mappings:
  EnvMapper:
    dev:
      RoleForKms: arn:aws:iam::11111111111:role/dev-role
    stage:
      RoleForKms: arn:aws:iam::22222222222:role/stg-role
    prod:
      RoleForKms: arn:aws:iam::33333333333:role/prd-role

Resources:
  # -------
  # KMS Key
  # -------
  DemoKmsKey:
    Type: "AWS::KMS::Key"
    Properties:
      Description: This is a demo key for KMKS
      EnableKeyRotation: true
      KeyPolicy:
        Version: 2012-10-17
        Id: key-demo-1
        Statement:
          - Sid: Enable IAM User Permissions
            Effect: Allow
            Principal:
              AWS: !FindInMap [EnvMapper, !Ref Env, RoleForKms]
            Action: kms:*
            Resource: "*"
      Tags:
        - Key: Name
          Value: !Sub demo-key-${Env}-cmk
  # -------
  # KMS Alias
  # -------
  DemoKmsKeyAlias:
    Type: "AWS::KMS::Alias"
    Properties:
      AliasName: !Sub alias/demo-key-${Env}-cmk
      TargetKeyId: !Ref DemoKmsKey
Outputs:
  DemoKmsKey:
    Value: !GetAtt DemoKmsKey.Arn
    Description: "This output is a demo KMS key"
    Export:
      Name: !Sub demo-key-${Env}-cmk

プログラムの超個人的なメモ

Memo for Programming.

【AWS】CloudFormation ～ Mappings ～

■ はじめに

目次

【１】Mappings

【２】利点

１）可読性・拡張性の良さ

２）AWSコスト削減

３）セキュリティ強化

【３】定義

【４】値の参照

１）組み込み関数 !FindInMap / Fn::FindInMap

【５】サンプル

例１：環境によってインスタンスタイプを変更する

例２：環境によってKMSキーポリシーのPrincipalを切り替える

関連記事