11.2. CloudFrontキャッシュの無効化の作成 (オリジン: handson-cli-website-https-XXXXXXXXXXXX)

作業の目的 [why]

CloudFrontディストリビューション"handson-cli-website-https-distribution"のキャッシュ無効化を作成します。

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

完了条件 [after]

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

完了条件1
CloudFrontキャッシュ無効化エントリのステータスが"Completed"である。

事前条件 [before]

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

事前条件1
S3バケット"handson-cli-website-https-XXXXXXXXXXXX"が存在する。
事前条件2
S3バケット"handson-cli-website-https-XXXXXXXXXXXX"をオリジンとするCloudFrontディストリビューションが1つだけ存在する。
事前条件3
実施中のCloudFrontキャッシュ無効化エントリが存在しない。

作業対象 [what]

  • CloudFrontサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: S3バケット名

  • キャッシュを無効にするCloudFrontディストリビューションのオリジンとなっているS3バケット名です。
  • 今回は"handson-cli-website-https-XXXXXXXXXXXX"とします。

リソース2: 無効化の対象パス

  • キャッシュを無効化するパスです。
  • 今回は"/index.html"を無効化します。

パラメータの指定

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

0.a. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.b. プロファイルの指定

変数の設定:

export AWS_DEFAULT_PROFILE='handson-cli-website-https-webMaintUser'

0.1. オリジンS3バケットの指定

CloudFrontディストリビューションのオリジンとなっているS3バケットを指定します。

変数の設定:

S3_BUCKET_PREFIX='handson-cli-website-https'

コマンド:

AWS_ID=$( \
  aws sts get-caller-identity \
    --query 'Account' \
    --output text \
) \
  && echo ${AWS_ID}

結果(例):

XXXXXXXXXXXX

変数の設定:

S3_BUCKET_NAME="${S3_BUCKET_PREFIX}-${AWS_ID}" \
  && echo ${S3_BUCKET_NAME}

結果(例):

handson-cli-website-https-XXXXXXXXXXXX

0.2. キャッシュ無効化対象の指定

キャッシュ無効化の対象を指定します。

変数の設定:

CLOUDFRONT_PATHS='/index.html'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-website-https"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudfront-invalidation-create-expand-profile-case-prefix-awsid.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-website-https/2019-07-14-cloudfront-invalidation-create-expand-profile-case-prefix-awsid.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.a. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"
  # 0.b. AWS_DEFAULT_PROFILE:"handson-cli-website-https-webMaintUser"
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"

  # 0.1. S3_BUCKET_NAME:"handson-cli-website-https-XXXXXXXXXXXX"
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # 0.2. CLOUDFRONT_PATHS:"/index.html"
         CLOUDFRONT_PATHS="${CLOUDFRONT_PATHS}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: S3バケット"handson-cli-website-https-XXXXXXXXXXXX"が存在する。

「S3バケット"handson-cli-website-https-XXXXXXXXXXXX"が存在する。」ことを確認します。

コマンド:

aws s3 ls s3://${S3_BUCKET_NAME} > /dev/null 2>&1

コマンド:

echo $?

結果(例):

0

事前条件2: S3バケット"handson-cli-website-https-XXXXXXXXXXXX"をオリジンとするCloudFrontディストリビューションが1つだけ存在する。

「S3バケット"handson-cli-website-https-XXXXXXXXXXXX"をオリジンとするCloudFrontディストリビューションが1つだけ存在する。」ことを確認します。

CloudFrontオリジンIDを指定します。

変数の設定:

CLOUDFRONT_ORIGIN_ID="S3-Website-${S3_BUCKET_NAME}.s3-website-${AWS_DEFAULT_REGION}.amazonaws.com" \
  && echo ${CLOUDFRONT_ORIGIN_ID}

結果(例):

S3-Website-handson-cli-website-https-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com

コマンド:

aws cloudfront list-distributions \
  --query "DistributionList.Items[?DefaultCacheBehavior.TargetOriginId == \`${CLOUDFRONT_ORIGIN_ID}\`].Id" \
  --output text \
  | wc -l

結果:

1

事前条件3: 実施中のCloudFrontキャッシュ無効化エントリが存在しない。

「実施中のCloudFrontキャッシュ無効化エントリが存在しない。」ことを確認します。

コマンド:

CLOUDFRONT_DISTRIBUTION_ID=$( \
  aws cloudfront list-distributions \
    --query "DistributionList.Items[?DefaultCacheBehavior.TargetOriginId == \`${CLOUDFRONT_ORIGIN_ID}\`].Id" \
    --output text \
  ) \
  && echo ${CLOUDFRONT_DISTRIBUTION_ID}

結果(例):

Exxxxxxxxxxxxx

コマンド:

aws cloudfront list-invalidations \
  --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} \
  --query 'InvalidationList.Items[?Status != `Completed`].Id' \
  --output text

結果(例):

None

2. 主処理

キャッシュ無効化の作成

変数の確認:

cat << ETX

  # CLOUDFRONT_DISTRIBUTION_ID:"Exxxxxxxxxxxxx"
    CLOUDFRONT_DISTRIBUTION_ID="${CLOUDFRONT_DISTRIBUTION_ID}"
  # CLOUDFRONT_PATHS:"/index.html"
    CLOUDFRONT_PATHS="${CLOUDFRONT_PATHS}"

ETX

コマンド:

aws cloudfront create-invalidation \
  --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} \
  --paths ${CLOUDFRONT_PATHS}

結果(例):

{
  "Invalidation": {
    "Status": "InProgress",
    "InvalidationBatch": {
        "Paths": {
            "Items": [
                "/index.html"
            ],
            "Quantity": 1
        },
        "CallerReference": "cli-xxxxxxxxxx-xxxxxx"
    },
    "Id": "Ixxxxxxxxxxxxx",
    "CreateTime": "2019-07-14T01:23:45.678Z"
  },
  "Location": "https://cloudfront.amazonaws.com/2017-03-25/distribution/Exxxxxxxxxxxxx/invalidation/Ixxxxxxxxxxxxx"
}

無効化IDを取得します。

コマンド:

CLOUDFRONT_INVALIDATION_ID=$( \
  aws cloudfront list-invalidations \
    --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} \
    --query 'InvalidationList.Items[?Status ==`InProgress`].Id' \
    --output text \
) \
  && echo ${CLOUDFRONT_INVALIDATION_ID}

結果(例):

Exxxxxxxxxxxxx

無効化のステータスを取得します。

コマンド:

CLOUDFRONT_INVALIDATION_STATUS=$( \
  aws cloudfront list-invalidations \
    --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} \
    --query "InvalidationList.Items[?Id ==\`${CLOUDFRONT_INVALIDATION_ID}\`].Status" \
    --output text \
) \
  && echo ${CLOUDFRONT_INVALIDATION_STATUS}

結果(例):

InProgress

3. 後処理

完了条件の確認

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

完了条件1: CloudFrontキャッシュ無効化エントリのステータスが"Completed"である。

「CloudFrontキャッシュ無効化エントリのステータスが"Completed"である。」ことを確認します。

コマンド:

CLOUDFRONT_INVALIDATION_STATUS=$( \
  aws cloudfront list-invalidations \
    --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} \
    --query "InvalidationList.Items[?Id ==\`${CLOUDFRONT_INVALIDATION_ID}\`].Status" \
    --output text \
) \
  && echo ${CLOUDFRONT_INVALIDATION_STATUS}

結果(例):

Completed

完了