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

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

手順の目的

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

設定値の指定

設定値の指定

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

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

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

変数の設定:

DIR_CLOUDFORMATION_RESOURCE="${HOME}/environment/conf-handson-cli-cfn-sqs-QueuePolicy/resources"

2. CloudFormationテンプレート名

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

変数の設定:

CLOUDFORMATION_TEMPLATE_NAME='handson-cli-cfn-sqs-QueuePolicy'

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

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

変数の設定:

CLOUDFORMATION_TEMPLATE_DESCRIPTION='Template for handson-cli-cfn-sqs-QueuePolicy.'

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

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

変数の設定:

DIR_CLOUDFORMATION_TEMPLATE="${HOME}/environment/conf-handson-cli-cfn-sqs-QueuePolicy"

ディレクトリが存在することを確認し、存在しない場合は作成します。

コマンド:

ls -d ${DIR_CLOUDFORMATION_TEMPLATE} > /dev/null 2>&1 \
  || 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-sqs-QueuePolicy/handson-cli-cfn-sqs-QueuePolicy.template

設定値の確認

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

変数の確認:

cat << END

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

END

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

処理の実行

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

変数の確認:

cat << END

  # FILE_CLOUDFORMATION_TEMPLATE:"${HOME}/environment/conf-handson-cli-cfn-sqs-QueuePolicy/handson-cli-cfn-sqs-QueuePolicy.template"
    FILE_CLOUDFORMATION_TEMPLATE="${FILE_CLOUDFORMATION_TEMPLATE}"
  # CLOUDFORMATION_TEMPLATE_DESCRIPTION:"Template for handson-cli-cfn-sqs-QueuePolicy."
    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-sqs-QueuePolicy.

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-sqs-QueuePolicy.

Resources:
  SqsQueue0StackName:
    Type: AWS::SQS::Queue
    Properties:
      QueueName: !Ref AWS::StackName

  SqsQueuePolicy0:
    Type: "AWS::SQS::QueuePolicy"
    Properties:
      PolicyDocument:
        Statement:
          -
            Principal:
              AWS:
                - "953640472020"
            Action:
              - "SQS:SendMessage"
              - "SQS:ReceiveMessage"
            Effect: "Allow"
            Resource: "arn:aws:sqs:ap-northeast-1:XXXXXXXXXXXX:handson-cli-cfn-sqs-QueuePolicy-stack"
      Queues:
        - "https://sqs:ap-northeast-1.amazonaws.com/XXXXXXXXXXXX/handson-cli-cfn-sqs-QueuePolicy-stack"

完了確認

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

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

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

コマンド:

ls ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

${HOME}/environment/conf-handson-cli-cfn-sqs-QueuePolicy/handson-cli-cfn-sqs-QueuePolicy.template

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

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

コマンド:

yamllint ${FILE_CLOUDFORMATION_TEMPLATE}

結果(例):

(出力なし)

手順の完了