8. S3バケットのバージョニング有効化 (handson-cli-s3-XXXXXXXXXXXX)

作業の目的 [why]

S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョンニングを有効にします。

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

完了条件 [after]

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

完了条件1

S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効である。

事前条件 [before]

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

事前条件1

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

事前条件2

S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効ではない。

作業対象 [what]

  • S3バケット

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

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

  • バージョニングを有効にするS3バケットの名称です。

  • 今回は"handson-cli-s3-XXXXXXXXXXXX"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. S3バケット名の指定

変数の設定:

S3_BUCKET_PREFIX='handson-cli-s3'

コマンド:

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-s3-XXXXXXXXXXXX

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-s3/2019-09-23-s3-bucket_versioning-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. S3_BUCKET_NAME:"handson-cli-s3-XXXXXXXXXXXX"
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

処理対象の状態確認

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

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

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

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

コマンド:

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

結果(例):

handson-cli-s3-XXXXXXXXXXXX

事前条件2: S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効ではない。

「S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効ではない。」ことを確認します。

コマンド:

aws s3api get-bucket-versioning \
  --bucket ${S3_BUCKET_NAME} \
  --query 'Status' \
  --output text

結果(例):

None

2. 主処理

S3バケットのバージョン有効化

変数の確認:

cat << ETX

  S3_BUCKET_NAME:"handson-cli-s3-XXXXXXXXXXXX"
  S3_BUCKET_NAME="${S3_BUCKET_NAME}"

ETX

コマンド:

aws s3api put-bucket-versioning \
  --bucket ${S3_BUCKET_NAME} \
  --versioning-configuration Status=Enabled

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効である。

「S3バケット"handson-cli-s3-XXXXXXXXXXXX"のバージョニングが有効である。」ことを確認します。

コマンド:

aws s3api get-bucket-versioning \
  --bucket ${S3_BUCKET_NAME} \
  --query 'Status' \
  --output text

結果(例):

Enabled

完了