7.3. CloudFrontディストリビューションの作成 (インプットJSON: handson-cli-website-https-distribution)

作業の目的 [why]

CloudFrontディストリビューション"handson-cli-website-https-distribution"をインプットJSONを利用して作成します。

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

完了条件 [after]

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

完了条件1
CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在する。
完了条件2
CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のステータスが"Deployed"である。

事前条件 [before]

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

事前条件1
CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在しない。
事前条件2
インプットJSONファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"が存在する。

作業対象 [what]

  • CloudFrontサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: CloudFrontディストリビューションタグ名

  • 今回は"handson-cli-website-https-distribution"をCloudFrontディストリビューションタグ名とします。

リソース2: インプットJSONファイル

  • 今回は"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"をインプットJSONファイルとします。

リソース3: 一時ファイル用ディレクトリ

  • 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp

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

${HOME}/tmp

ディレクトリが存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp

パラメータの指定

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

0.1. CloudFrontディストリビューションタグ名の指定

変数の設定:

CLOUDFRONT_DISTRIBUTION_TAG_NAME="handson-cli-website-https-distribution"

0.2. インプットJSONファイルの指定

変数の設定:

DIR_INPUT="${HOME}/conf/handson-cli-website-https-conf"

変数の設定:

FILE_INPUT="${DIR_INPUT}/${CLOUDFRONT_DISTRIBUTION_TAG_NAME}.json" \
  && echo ${FILE_INPUT}

結果(例):

${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json

0.3. 一時ファイル用ディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-website-https/2019-07-14-cloudfront-distribution-create-input_json.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. CLOUDFRONT_DISTRIBUTION_TAG_NAME:"handson-cli-website-https-distribution"
         CLOUDFRONT_DISTRIBUTION_TAG_NAME="${CLOUDFRONT_DISTRIBUTION_TAG_NAME}"
  # 0.2. FILE_INPUT:"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"
         FILE_INPUT="${FILE_INPUT}"
  # 0.3. DIR_TMP:"${HOME}/tmp"
         DIR_TMP="${DIR_TMP}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在しない。

「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在しない。」ことを確認します。

コマンド:

for i in $( 
  aws cloudfront list-distributions \
    --query "DistributionList.Items[].ARN" \
    --output text \
); do
  j=$( \
    aws cloudfront list-tags-for-resource \
      --resource ${i} \
      --query "Tags.Items[?Key == \`Name\` && Value == \`${CLOUDFRONT_DISTRIBUTION_TAG_NAME}\`].Value" \
      --output text \
  )
  if [ "${j}x" != 'x' ]; then echo "${j}"; fi
done

注釈

'None'もしくは'An error occurred (MalformedXML)'で始まるエラーが表示されればOKです。

課題

list-distributionsコマンドがタグ表示できないため、全てのディストリビューションに対してlist-tags-for-resourceコマンドでタグの有無をチェックするしか方法がない。(サポートには未確認)

事前条件2: インプットJSONファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"が存在する。

「インプットJSONファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_INPUT}

結果(例):

${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json

1.2. 主処理に必要な情報の取得

一時出力ファイル名の指定

変数の設定:

FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-cloudfront-distribution-${CLOUDFRONT_DISTRIBUTION_TAG_NAME}.json" \
  && echo ${FILE_OUTPUT}

結果(例):

${HOME}/tmp/2019-07-14-cloudfront-distribut-handson-cli-website-https-distribution.json

2. 主処理

CloudFrontディストリビューションの作成

変数の確認:

cat << ETX

  # FILE_INPUT:"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution.json"
    FILE_INPUT="${FILE_INPUT}"
  # FILE_OUTPUT:"${HOME}/tmp/2019-07-14-cloudfront-distribution-handson-cli-website-https-distribution.json"
    FILE_OUTPUT="${FILE_OUTPUT}"

ETX

コマンド(cli-input-json):

aws cloudfront create-distribution \
  --cli-input-json file://${FILE_INPUT} \
  > ${FILE_OUTPUT}

結果(例):

(出力なし)

3. 後処理

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

ディストリビューションARNの取得

コマンド:

CLOUDFRONT_DISTRIBUTION_ARN=$( \
  cat ${FILE_OUTPUT} \
    | jp.py "Distribution.ARN" \
    | sed 's/\"//g' \
) \
  && echo ${CLOUDFRONT_DISTRIBUTION_ARN}

結果(例):

arn:aws:cloudfront::XXXXXXXXXXXX:distribution/Exxxxxxxxxxxxx

タグ情報の設定

変数の設定:

CLOUDFRONT_TAG_KEY='Name'

変数の設定:

CLOUDFRONT_TAG_VALUE=${CLOUDFRONT_DISTRIBUTION_TAG_NAME} \
  && echo ${CLOUDFRONT_TAG_VALUE}

結果(例):

handson-cli-website-https-distribution

タグ設定文字列の生成

変数の設定:

STRING_CLOUDFRONT_TAGS="Items=[{Key=${CLOUDFRONT_TAG_KEY},Value=${CLOUDFRONT_TAG_VALUE}}]" \
  && echo ${STRING_CLOUDFRONT_TAGS}

結果(例):

Items=[{Key=Name,Value=handson-cli-website-https-distribution}]

タグ設定対象リソースの指定

変数の設定:

CLOUDFRONT_TAG_RESOURCE="${CLOUDFRONT_DISTRIBUTION_ARN}" \
  && echo ${CLOUDFRONT_TAG_RESOURCE}

結果(例):

arn:aws:cloudfront::XXXXXXXXXXXX:distribution/Exxxxxxxxxxxxx

タグの作成

コマンド:

aws cloudfront tag-resource \
  --resource ${CLOUDFRONT_TAG_RESOURCE} \
  --tags "${STRING_CLOUDFRONT_TAGS}"

結果(例):

(出力なし)

一時ファイルの削除

コマンド:

rm ${FILE_OUTPUT}

結果:

(出力なし)

3.2. 完了条件の確認

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

完了条件1: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在する。

「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在する。」ことを確認します。

コマンド:

for i in $( 
  aws cloudfront list-distributions \
    --query "DistributionList.Items[].ARN" \
    --output text \
); do
  j=$( \
    aws cloudfront list-tags-for-resource \
      --resource ${i} \
      --query "Tags.Items[?Key == \`Name\` && Value == \`${CLOUDFRONT_DISTRIBUTION_TAG_NAME}\`].Value" \
      --output text \
  )
  if [ "${j}x" != 'x' ]; then echo "${j}"; fi
done

結果(例):

handson-cli-website-https-distribution

課題

list-distributionsコマンドがタグ表示できないため、全てのディストリビューションに対してlist-tags-for-resourceコマンドでタグの有無をチェックするしか方法がない。(サポートには未確認)

完了条件2: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のステータスが"Deployed"である。

「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のステータスが"Deployed"である。」ことを確認します。

ディストリビューションIDを取得します。

コマンド:

for i in $(
  aws cloudfront list-distributions \
    --query "DistributionList.Items[].ARN" \
    --output text \
); do
  j=$( \
    aws cloudfront list-tags-for-resource \
      --resource ${i} \
      --query "Tags.Items[?Key == \`Name\` && Value == \`${CLOUDFRONT_DISTRIBUTION_TAG_NAME}\`].Value" \
      --output text \
  )
  if [ "${j}" == "${CLOUDFRONT_DISTRIBUTION_TAG_NAME}" ]; then \
    CLOUDFRONT_DISTRIBUTION_ID=$( \
      aws cloudfront list-distributions \
        --query "DistributionList.Items[?ARN == \`${i}\`].Id" \
        --output text \
    ) \
      && echo ${CLOUDFRONT_DISTRIBUTION_ID}
  fi
done

結果(例):

Exxxxxxxxxxxxx

課題

list-distributionsコマンドがタグ表示できないため、全てのディストリビューションに対してlist-tags-for-resourceコマンドでタグの有無をチェックするしか方法がない。(サポートには未確認)

ディストリビューションのステータスを確認します。

コマンド:

CLOUDFRONT_DISTRIBUTION_STATUS=$(
  aws cloudfront get-distribution \
    --id ${CLOUDFRONT_DISTRIBUTION_ID} \
    --query 'Distribution.Status' \
    --output text \
) \
  && echo ${CLOUDFRONT_DISTRIBUTION_STATUS}

結果(例):

Deployed

注釈

"InProgress"から"Deployed"まで、20〜30分程度かかります。

完了