2.2. CloudFrontディストリビューションの更新 (handson-cli-website-https-distribution)¶
作業の目的 [why]¶
CloudFrontディストリビューション"handson-cli-website-https-distribution"を更新し、無効化します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"false"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"が存在する。
- 事前条件2
- CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"true"である。
- 事前条件3
- CloudFrontディストリビューション設定ファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json"が存在する。
作業対象 [what]¶
- CloudFrontディストリビューション
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CloudFrontディストリビューションタグ名
- 設定ファイルの抽出元となるCloudFrontディストリビューションの名称です。
- 今回は"handson-cli-website-https-distribution"とします。
リソース2: CloudFrontディストリビューション設定ファイル
- 今回は"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json"をCloudFrontディストリビューション設定ファイルとします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. CloudFrontディストリビューションタグ名の指定¶
変数の設定:
CLOUDFRONT_DISTRIBUTION_TAG_NAME="handson-cli-website-https-distribution"
0.2. CloudFrontディストリビューション設定ファイル名の指定¶
変数の設定:
DIR_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC="${HOME}/conf/handson-cli-website-https-conf"
変数の設定:
CLOUDFRONT_CONFIG_ACTION='disable'
変数の設定:
FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC="${DIR_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC}/${CLOUDFRONT_DISTRIBUTION_TAG_NAME}-${CLOUDFRONT_CONFIG_ACTION}-update.json" \ && echo ${FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC}
結果(例):
${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-website-https" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudfront-distribution-update.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-website-https/2019-07-14-cloudfront-distribution-update.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_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC:"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json" FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC="${FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC}" 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
結果(例):
handson-cli-website-https-distribution
課題
list-distributionsコマンドがタグ表示できないため、全てのディストリビューションに対してlist-tags-for-resourceコマンドでタグの有無をチェックするしか方法がない。(サポートには未確認)
ディストリビューション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コマンドでタグの有無をチェックするしか方法がない。(サポートには未確認)
事前条件2: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"true"である。
「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"true"である。」ことを確認します。
コマンド:
aws cloudfront get-distribution \ --id ${CLOUDFRONT_DISTRIBUTION_ID} \ --query 'Distribution.DistributionConfig.Enabled'
結果(例):
true
事前条件3: CloudFrontディストリビューション設定ファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json"が存在する。
「CloudFrontディストリビューション設定ファイル"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC}
結果(例):
${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json
1.2. 主処理に必要な情報の取得¶
ETAGの取得
コマンド:
CLOUDFRONT_ETAG=$( aws cloudfront get-distribution \ --id ${CLOUDFRONT_DISTRIBUTION_ID} \ --query 'ETag' \ --output text \ ) \ && echo ${CLOUDFRONT_ETAG}
結果(例):
Exxxxxxxxxxx
2. 主処理¶
CloudFrontディストリビューションの更新¶
変数の確認:
cat << ETX # FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC:"${HOME}/conf/handson-cli-website-https-conf/handson-cli-website-https-distribution-disable-update.json" FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC="${FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC}" # CLOUDFRONT_DISTRIBUTION_ID:"Exxxxxxxxxxxxx" CLOUDFRONT_DISTRIBUTION_ID="${CLOUDFRONT_DISTRIBUTION_ID}" # CLOUDFRONT_ETAG:"Exxxxxxxxxxxxx" CLOUDFRONT_ETAG="${CLOUDFRONT_ETAG}" ETX
コマンド:
aws cloudfront update-distribution \ --id ${CLOUDFRONT_DISTRIBUTION_ID} \ --distribution-config file://${FILE_CLOUDFRONT_DISTRIBUTION_CONFIG_DOC} \ --if-match ${CLOUDFRONT_ETAG}
結果(例):
(略)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"false"である。
「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のEnable状態が"false"である。」ことを確認します。
コマンド:
aws cloudfront get-distribution \ --id ${CLOUDFRONT_DISTRIBUTION_ID} \ --query 'Distribution.DistributionConfig.Enabled'
結果(例):
false
完了条件2: CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のステータスが"Deployed"である。
「CloudFrontディストリビューションタグ名"handson-cli-website-https-distribution"のステータスが"Deployed"である。」ことを確認します。
ディストリビューションのステータスを確認します。
コマンド:
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分程度かかります。