1.1. CloudFormationテンプレートのダウンロード・置換

作業の目的 [why]

CloudFormationテンプレートをダウンロードし、特定の文字列を置換して保存します。

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

完了条件 [after]

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

完了条件1
CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在する。

事前条件 [before]

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

事前条件1
CloudFormationテンプレート用ディレクトリ"${HOME}/tmp/conf-handson-rds"が存在する。
事前条件2
CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在しない。

作業対象 [what]

  • CloudFormationサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

  • 今回は"${HOME}/tmp/conf-handson-rds"をCloudFormationテンプレート用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp/conf-handson-rds

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

${HOME}/tmp/conf-handson-rds

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

コマンド:

mkdir -p ${HOME}/tmp/conf-handson-rds

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

  • CloudFormationテンプレートの保存ファイル名です。
  • 今回は"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"とします。

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

  • ダウンロードするCloudFormationテンプレートのURLです。
  • 今回は"http://prototype-handson-cli2.s3-website-us-east-1.amazonaws.com/_downloads/handson-cli-vpc-cfn.template"とします。

リソース4: 置換対象文字列

  • ダウンロードするCloudFormationテンプレート中の置換対象となる文字列です。
  • 今回は"handson-cli"とします。

リソース5: 置換後文字列

  • 置換対象文字列の置換後の文字列です。
  • 今回は"handson-rds"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_CFN_TEMPLATE="${HOME}/tmp/conf-handson-rds"

0.2. 保存ファイル名の指定

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

変数の設定:

CFN_TEMPLATE_NAME='handson-rds-vpc-cfn'

変数の設定:

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

結果(例):

${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template

0.3. CloudFormationテンプレートURLの指定

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

変数の設定:

CFN_TEMPLATE_URL='http://prototype-handson-cli2.s3-website-us-east-1.amazonaws.com/_downloads/handson-cli-vpc-cfn.template'

0.4. 置換対象文字列の指定

置換対象文字列を指定します。

変数の設定:

STRING_BEFORE='handson-cli'

0.5. 置換後文字列の指定

置換後文字列を指定します。

変数の設定:

STRING_AFTER='handson-rds'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-rds"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudformation-template_download-read-expand-replace.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-rds/2019-06-10-cloudformation-template_download-read-expand-replace.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_CFN_TEMPLATE:"${HOME}/tmp/conf-handson-rds"
         DIR_CFN_TEMPLATE="${DIR_CFN_TEMPLATE}"
  # 0.2. FILE_CFN_TEMPLATE:"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"
         FILE_CFN_TEMPLATE="${FILE_CFN_TEMPLATE}"
  # 0.3. CFN_TEMPLATE_URL:"http://prototype-handson-cli2.s3-website-us-east-1.amazonaws.com/_downloads/handson-cli-vpc-cfn.template"
         CFN_TEMPLATE_URL="${CFN_TEMPLATE_URL}"
  # 0.4. STRING_BEFORE:"handson-cli"
         STRING_BEFORE="${STRING_BEFORE}"
  # 0.5. STRING_AFTER:"handson-rds"
         STRING_AFTER="${STRING_AFTER}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/conf-handson-rds

事前条件2: CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在しない。

「CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_CFN_TEMPLATE}

結果(例):

ls: ${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template No such file or directory

2. 主処理

CloudFormationテンプレートのダウンロード

変数の確認:

cat << EOF

  # FILE_CFN_TEMPLATE:"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"
    FILE_CFN_TEMPLATE="${FILE_CFN_TEMPLATE}"
  # CFN_TEMPLATE_URL:"http://prototype-handson-cli2.s3-website-us-east-1.amazonaws.com/_downloads/handson-cli-vpc-cfn.template"
    CFN_TEMPLATE_URL="${CFN_TEMPLATE_URL}"
  # STRING_BEFORE:"handson-cli"
    STRING_BEFORE="${STRING_BEFORE}"
  # STRING_AFTER:"handson-rds"
    STRING_AFTER="${STRING_AFTER}"

EOF

コマンド:

curl ${CFN_TEMPLATE_URL} \
  | sed "s/${STRING_BEFORE}/${STRING_AFTER}/g" \
  > ${FILE_CFN_TEMPLATE}

3. 後処理

完了条件の確認

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

完了条件1: CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在する。

「CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template

完了条件2: CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が有効な形式である。

「CloudFormationテンプレート"${HOME}/tmp/conf-handson-rds/handson-rds-vpc-cfn.template"が有効な形式である。」ことを確認します。

コマンド:

aws cloudformation validate-template \
  --template-body file://${FILE_CFN_TEMPLATE}

結果(例):

{
  "Description": "<CloudFormationテンプレートの説明>",
  "Parameters": []
}

完了