ハンズオン(簡易版): CFnテンプレート入門(SNS::Subscription)

2.1. CloudFormationテンプレートの作成 (handson-cli-cfn-sns-Subscription)

手順の目的 [why]

CloudFormationスタック"handson-cli-cfn-sns-Subscription"を作成します。

設定値の指定

設定値の指定

手順に必要な設定値を変数に格納をします。

1. リソースファイルディレクトリ

リソースファイルディレクトリを指定します。

変数の設定:

DIR_CLOUDFORMATION_RESOURCE="${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/resources"

2. CloudFormationテンプレート名

CloudFormationテンプレート名を指定します。

変数の設定:

CLOUDFORMATION_TEMPLATE_NAME='handson-cli-cfn-sns-Subscription'

3. CloudFormationテンプレートの説明

CloudFormationテンプレートの説明を指定します。

変数の設定:

CLOUDFORMATION_TEMPLATE_DESCRIPTION='Template for handson-cli-cfn-sns-Subscription.'

4. テンプレートファイルディレクトリ

テンプレートファイルディレクトリを指定します。

変数の設定:

DIR_CLOUDFORMATION_TEMPLATE="${HOME}/environment/conf-handson-cli-cfn-sns-Subscription"

ディレクトリが存在することを確認します。

コマンド:

ls -d ${DIR_CLOUDFORMATION_TEMPLATE}

結果(例:存在する場合):

${HOME}/environment/conf-handson-cli-cfn-sns-Subscription

存在しない場合は作成します。

コマンド:

mkdir -p ${DIR_CLOUDFORMATION_TEMPLATE}

5. テンプレートファイル名の指定

テンプレートファイル名の指定します。

変数の設定:

FILE_CLOUDFORMATION_TEMPLATE="${DIR_CLOUDFORMATION_TEMPLATE}/${CLOUDFORMATION_TEMPLATE_NAME}.template" \
  && echo ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/handson-cli-cfn-sns-Subscription.template

設定値の確認

各変数に正しい設定値が格納されていることを確認しながら保存します。

変数の確認:

cat << END

  # 1. DIR_CLOUDFORMATION_RESOURCE:"${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/resources"
       DIR_CLOUDFORMATION_RESOURCE="${DIR_CLOUDFORMATION_RESOURCE}"
  # 2. CLOUDFORMATION_TEMPLATE_NAME:"handson-cli-cfn-sns-Subscription"
       CLOUDFORMATION_TEMPLATE_NAME="${CLOUDFORMATION_TEMPLATE_NAME}"
  # 3. CLOUDFORMATION_TEMPLATE_DESCRIPTION:"Template for handson-cli-cfn-sns-Subscription."
       CLOUDFORMATION_TEMPLATE_DESCRIPTION="${CLOUDFORMATION_TEMPLATE_DESCRIPTION}"
  # 4. DIR_CLOUDFORMATION_TEMPLATE:"${HOME}/environment/conf-handson-cli-cfn-sns-Subscription"
       DIR_CLOUDFORMATION_TEMPLATE="${DIR_CLOUDFORMATION_TEMPLATE}"
  # 5. FILE_CLOUDFORMATION_TEMPLATE:"${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/handson-cli-cfn-sns-Subscription.template"
       FILE_CLOUDFORMATION_TEMPLATE="${FILE_CLOUDFORMATION_TEMPLATE}"

END

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

処理の実行

CloudFormationテンプレート共通部分を作成します。

変数の確認:

cat << END

  # FILE_CLOUDFORMATION_TEMPLATE:"${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/handson-cli-cfn-sns-Subscription.template"
    FILE_CLOUDFORMATION_TEMPLATE="${FILE_CLOUDFORMATION_TEMPLATE}"
  # CLOUDFORMATION_TEMPLATE_DESCRIPTION:"Template for handson-cli-cfn-sns-Subscription."
    CLOUDFORMATION_TEMPLATE_DESCRIPTION="${CLOUDFORMATION_TEMPLATE_DESCRIPTION}"

END

コマンド:

cat << EOF > ${FILE_CLOUDFORMATION_TEMPLATE}
AWSTemplateFormatVersion: 2010-09-09
Description:
  ${CLOUDFORMATION_TEMPLATE_DESCRIPTION}

EOF

cat ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

AWSTemplateFormatVersion: 2010-09-09
Description:
  Template for handson-cli-cfn-sns-Subscription.

CloudFormationテンプレートにリソース部分を追加します。

コマンド:

echo 'Resources:' >> ${FILE_CLOUDFORMATION_TEMPLATE}

for i in $( ls ${DIR_CLOUDFORMATION_RESOURCE}/*.txt ); do \
  cat $i | sed '/^$/d' >> ${FILE_CLOUDFORMATION_TEMPLATE}; \
  echo '' >> ${FILE_CLOUDFORMATION_TEMPLATE} \
; done

cat ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

AWSTemplateFormatVersion: 2010-09-09
Description:
  Template for handson-cli-cfn-ec2-vpc.

Resources:
  SnsSubscription0:
    Type: AWS::SNS::Subscription
    Properties:
      TopicArn: !Ref SnsTopic0
      Protocol: email
      Endpoint: <通知先メールアドレス>

  SnsTopic0:
    Type: AWS::SNS::Topic
    Properties:
      TopicName: !Ref AWS::StackName

完了確認

本手順の主処理は、以下の完了条件を満たしたときに成功したものとします。

完了条件1: CloudFormationテンプレート"handson-cli-cfn-sns-Subscription"が存在する。

「CloudFormationテンプレート"handson-cli-cfn-sns-Subscription"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

${HOME}/environment/conf-handson-cli-cfn-sns-Subscription/handson-cli-cfn-sns-Subscription.template

完了条件2: CloudFormationテンプレート"handson-cli-cfn-sns-Subscription"がYAMLフォーマットとして正常である。

「CloudFormationテンプレート"handson-cli-cfn-sns-Subscription"がYAMLフォーマットとして正常である。」ことを確認します。

コマンド:

yamllint ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

(出力なし)

手順の完了