3.1. S3バケット CORS設定ドキュメントの作成

作業の目的 [why]

S3バケット"handson-cli-cognito-identity-data-XXXXXXXXXXXX"のCORS設定ドキュメントを作成します。

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

完了条件 [after]

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

完了条件1

S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在する。

事前条件 [before]

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

事前条件1

S3バケットCORS設定ドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-cognito-identity"が存在する。

事前条件2

S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在しない。

事前条件3

S3バケット"handson-cli-cognito-identity-data-XXXXXXXXXXXX"が存在する。

事前条件4

オリジンサイト"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"が存在する。

作業対象 [what]

  • S3サービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

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

  • CORS設定をするS3バケットの名称です。

  • 今回は"handson-cli-cognito-identity-data-XXXXXXXXXXXX"とします。

リソース2: S3バケットCORS設定ドキュメント用ディレクトリ

  • 今回は"${HOME}/environment/conf-handson-cli-cognito-identity"をS3バケットCORS設定ドキュメント用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/environment/conf-handson-cli-cognito-identity

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

${HOME}/environment/conf-handson-cli-cognito-identity

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

コマンド:

mkdir -p ${HOME}/environment/conf-handson-cli-cognito-identity

リソース3: S3バケットCORS設定ドキュメント名

  • 作成するS3バケットCORS設定ドキュメントのファイル名です。

  • 今回は"handson-cli-cognito-identity-data-XXXXXXXXXXXX"とします。

リソース4: オリジンURL

  • CORS設定の対象となるオリジンサイトのURLです。

  • 今回は"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"とします。

パラメータの指定

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

0.1. S3バケット名の指定

変数の設定:

S3_BUCKET_PREFIX='handson-cli-cognito-identity-data'

コマンド:

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-cognito-identity-data-XXXXXXXXXXXX

0.2. 設定ファイルディレクトリの指定

変数の設定:

DIR_S3_BUCKET_CORS_DOC="${HOME}/environment/conf-handson-cli-cognito-identity"

0.3. S3バケットCORS設定ドキュメントファイル名の指定

変数の設定:

FILE_S3_BUCKET_CORS_DOC="${DIR_S3_BUCKET_CORS_DOC}/${S3_BUCKET_NAME}-s3-bucket-cors.json" \
  && echo ${FILE_S3_BUCKET_CORS_DOC}

結果(例):

${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json

0.4. オリジンURL

オリジンサイトのURLを指定します。

変数の設定:

S3_BUCKET_PREFIX_ORIGIN='handson-cli-cognito-identity-contents'

コマンド:

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

結果(例):

XXXXXXXXXXXX

変数の設定:

S3_BUCKET_NAME_ORIGIN="${S3_BUCKET_PREFIX_ORIGIN}-${AWS_ID}" \
  && echo ${S3_BUCKET_NAME_ORIGIN}

結果(例):

handson-cli-cognito-identity-contents-XXXXXXXXXXXX

変数の設定:

S3_BUCKET_LOCATION_ORIGIN=$( \
  aws s3api get-bucket-location \
    --bucket ${S3_BUCKET_NAME_ORIGIN} \
    --output text \
) \
  && echo ${S3_BUCKET_LOCATION_ORIGIN}

結果(例):

ap-northeast-1

変数の設定:

S3_BUCKET_ENDPOINT_ORIGIN="http://${S3_BUCKET_NAME_ORIGIN}.s3-website-${S3_BUCKET_LOCATION_ORIGIN}.amazonaws.com" \
  && echo ${S3_BUCKET_ENDPOINT_ORIGIN}

結果(例):

http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com

変数の設定:

URL_ORIGIN="${S3_BUCKET_ENDPOINT_ORIGIN}" \
  && echo ${URL_ORIGIN}

結果(例):

http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-cognito-identity/2019-11-19-s3-bucket_cors_document-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. S3_BUCKET_NAME:"handson-cli-cognito-identity-data-XXXXXXXXXXXX"
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # 0.2. DIR_S3_BUCKET_CORS_DOC:"${HOME}/environment/conf-handson-cli-cognito-identity"
         DIR_S3_BUCKET_CORS_DOC="${DIR_S3_BUCKET_CORS_DOC}"
  # 0.3. FILE_S3_BUCKET_CORS_DOC:"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"
         FILE_S3_BUCKET_CORS_DOC="${FILE_S3_BUCKET_CORS_DOC}"
  # 0.4. URL_ORIGIN:"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"
         URL_ORIGIN="${URL_ORIGIN}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: S3バケットCORS設定ドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-cognito-identity"が存在する。

「S3バケットCORS設定ドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-cognito-identity"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_S3_BUCKET_CORS_DOC}

結果(例):

${HOME}/environment/conf-handson-cli-cognito-identity

事前条件2: S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在しない。

「S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_S3_BUCKET_CORS_DOC}

結果(例):

ls: ${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json No such file or directory

事前条件3: S3バケット"handson-cli-cognito-identity-data-XXXXXXXXXXXX"が存在する。

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

コマンド:

aws s3api list-buckets \
  --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name" \
  --output text

結果(例):

handson-cli-cognito-identity-data-XXXXXXXXXXXX

事前条件4: オリジンサイト"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"が存在する。

「オリジンサイト"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"が存在する。」ことを確認します。

変数の設定:

CURL_TARGET_URL="${URL_ORIGIN}" \
  && echo ${CURL_TARGET_URL}

結果(例):

http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com

コマンド:

curl -LI -Ss \
  -o /dev/null \
  -w '%{http_code}\n' \
  ${CURL_TARGET_URL}

結果(例):

404

2. 主処理

CORS設定ドキュメントの作成

変数の確認:

cat << EOF

  # FILE_S3_BUCKET_CORS_DOC:"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"
    FILE_S3_BUCKET_CORS_DOC="${FILE_S3_BUCKET_CORS_DOC}"
  # URL_ORIGIN:"http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"
    URL_ORIGIN="${URL_ORIGIN}"

EOF

コマンド:

cat << EOF > ${FILE_S3_BUCKET_CORS_DOC}
{
  "CORSRules": [
    {
      "AllowedHeaders": [
        "*"
      ],
      "MaxAgeSeconds": 3000,
      "AllowedMethods": [
        "PUT"
      ],
      "AllowedOrigins": [
        "${URL_ORIGIN}"
      ]
    }
  ]
}
EOF

cat ${FILE_S3_BUCKET_CORS_DOC}

結果(例):

{
  "CORSRules": [
    {
      "AllowedHeaders": [
        "*"
      ],
      "MaxAgeSeconds": 3000,
      "AllowedMethods": [
        "PUT"
      ],
      "AllowedOrigins": [
        "http://handson-cli-cognito-identity-contents-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"
      ]
    }
  ]
}

コマンド:

jsonlint -q ${FILE_S3_BUCKET_CORS_DOC}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在する。

「S3バケットCORS設定ドキュメント"${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_S3_BUCKET_CORS_DOC}

結果(例):

${HOME}/environment/conf-handson-cli-cognito-identity/handson-cli-cognito-identity-data-XXXXXXXXXXXX-s3-bucket-cors.json

完了