6.2. CloudFormationスタックの作成 (handson-cli-bastion-vpc-cfn)

作業の目的 [why]

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

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在しない。
事前条件2
CloudFormationテンプレート用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。
事前条件3
CloudFormationテンプレート用ファイル"${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template"が存在する。

作業対象 [what]

  • CloudFormationサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: CloudFormationスタック名

  • 作成するCloudFormationスタックの名称です。
  • 今回は"handson-cli-bastion-vpc-cfn"とします。

リソース2: CloudFormationテンプレート用ディレクトリ

CloudFormationテンプレートを配置したディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"です。

リソース3: CloudFormationテンプレート名

  • 作成するCloudFormationスタックが利用するテンプレートの名称です。
  • 今回は"handson-cli-bastion-vpc-cfn"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CloudFormationスタック名の指定

CloudFormationスタック名を指定します。

変数の設定:

CFN_STACK_NAME='handson-cli-bastion-vpc-cfn'

0.2. CloudFormationテンプレート用ディレクトリの指定

変数の設定:

DIR_CFN_TEMPLATE="${HOME}/tmp/handson-cli-bastion-vpc-cfn"

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

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

変数の設定:

CFN_TEMPLATE_NAME='handson-cli-bastion-vpc-cfn'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudformation-stack-create.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-cloudformation-stack-create.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. CFN_STACK_NAME:"handson-cli-bastion-vpc-cfn"
         CFN_STACK_NAME="${CFN_STACK_NAME}"
  # 0.2. DIR_CFN_TEMPLATE:"${HOME}/tmp/handson-cli-bastion-vpc-cfn"
         DIR_CFN_TEMPLATE="${DIR_CFN_TEMPLATE}"
  # 0.3. CFN_TEMPLATE_NAME:"handson-cli-bastion-vpc-cfn"
         CFN_TEMPLATE_NAME="${CFN_TEMPLATE_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

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

変数の設定:

FILE_CFN_TEMPLATE="${DIR_CFN_TEMPLATE}/${CFN_TEMPLATE_NAME}.template" \
  && echo ${FILE_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template

1.2. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在しない。

「CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在しない。」ことを確認します。

コマンド:

aws cloudformation list-stacks \
  --query "StackSummaries[? \
    StackName == \`${CFN_STACK_NAME}\` \
      && StackStatus != \`DELETE_COMPLETE\` \
    ].StackName" \
  --output text

結果(例):

(出力なし)

事前条件2: CloudFormationテンプレート用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。

「CloudFormationテンプレート用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn

事前条件3: CloudFormationテンプレート用ファイル"${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template"が存在する。

「CloudFormationテンプレート用ファイル"${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template

2. 主処理

CloudFormationスタックの作成

変数の確認:

cat << ETX

  # CFN_STACK_NAME:"handson-cli-bastion-vpc-cfn"
    CFN_STACK_NAME="${CFN_STACK_NAME}"
  # FILE_CFN_TEMPLATE:"${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template"
    FILE_CFN_TEMPLATE="${FILE_CFN_TEMPLATE}"

ETX

コマンド:

aws cloudformation create-stack \
  --stack-name "${CFN_STACK_NAME}" \
  --template-body file://${FILE_CFN_TEMPLATE}

結果(例):

{
  "StackId": "arn:aws:cloudformation:ap-northeast-1:XXXXXXXXXXXX:stack/handson-cli-bastion-vpc-cfn/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在する。

「CloudFormationスタック"handson-cli-bastion-vpc-cfn"が存在する。」ことを確認します。

コマンド:

aws cloudformation list-stacks \
  --query "StackSummaries[? \
    StackName == \`${CFN_STACK_NAME}\` \
      && StackStatus != \`DELETE_COMPLETE\` \
    ].StackName" \
  --output text

結果(例):

handson-cli-bastion-vpc-cfn

完了条件2: CloudFormationスタック"handson-cli-bastion-vpc-cfn"のステータスが"CREATE_COMPLETE"になっている。

「CloudFormationスタック"handson-cli-bastion-vpc-cfn"のステータスが"CREATE_COMPLETE"になっている。」ことを確認します。

コマンド:

CFN_STACK_STATUS=$(\
  aws cloudformation list-stacks \
    --query "StackSummaries[? \
      StackName == \`${CFN_STACK_NAME}\` \
        && StackStatus != \`DELETE_COMPLETE\` \
      ].StackStatus" \
    --output text \
) \
  && echo ${CFN_STACK_STATUS}

結果(例):

CREATE_COMPLETE

ステータスがROLLBUCKになった場合は、イベントを確認して原因を特定します。

コマンド:

aws cloudformation describe-stack-events \
  --stack-name ${CFN_STACK_NAME}

結果(例):

(省略)

完了