. S3バケット ログ設定の削除 (handson-cli-website-XXXXXXXXXXXX)

作業の目的 [why]

S3バケット"handson-cli-website-XXXXXXXXXXXX"のログをログ用S3バケット"handson-cli-website-XXXXXXXXXXXX-log"に転送する設定を削除します。

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

完了条件 [after]

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

完了条件1
S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっていない。

事前条件 [before]

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

事前条件1
S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっている。

作業対象 [what]

  • S3サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

  • ログ設定を削除するS3バケットの名称です。
  • 今回は"handson-cli-website-XXXXXXXXXXXX"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_CONF="<設定ファイル用ディレクトリ>"

0.2. S3バケット名の指定

変数の設定:

S3_BUCKET_PREFIX='handson-cli-website'

コマンド:

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

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-s3-bucket_logging-delete-expand-prefix-awsid.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

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

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

課題

(未検証)

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっている。

「S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっている。」ことを確認します。

コマンド:

aws s3api get-bucket-logging \
  --bucket ${S3_BUCKET_NAME}

結果(例):

{
  "LoggingEnabled": {
    "TargetPrefix": "Logs/",
    "TargetBucket": "handson-cli-website-XXXXXXXXXXXX-log",
    "TargetGrants": [
        {
            "Grantee": {
                "Type": "Group",
                "URI": "http://acs.amazonaws.com/groups/global/AllUsers"
            },
            "Permission": "READ"
        }
    ]
  }
}

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

設定ファイルの作成

変数の確認:

cat << ETX

  # FILE_LOGGING_DOC:"<設定ファイル用ディレクトリ>/handson-cli-website-XXXXXXXXXXXX-s3-bucket-logging-create.json"
    FILE_LOGGING_DOC="${FILE_LOGGING_DOC}"

ETX

コマンド:

cat << EOF > ${FILE_LOGGING_DOC}
{}
EOF

cat ${FILE_LOGGING_DOC}

結果(例):

{}

コマンド:

jsonlint -q ${FILE_LOGGING_DOC}

結果(例):

(出力なし)

2. 主処理

ログ設定の削除

変数の確認

cat << ETX

  # S3_BUCKET_NAME:"handson-cli-website-XXXXXXXXXXXX"
    S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # FILE_S3_BUCKET_LOGGING_DOC:"|FILE_S3_BUCKET_LOGGING_DOC|"
    FILE_S3_BUCKET_LOGGING_DOC="${FILE_S3_BUCKET_LOGGING_DOC}"

ETX

コマンド:

aws s3api put-bucket-logging \
  --bucket ${S3_BUCKET_NAME} \
  --bucket-logging-status file://${FILE_S3_BUCKET_LOGGING_DOC}

結果(例):

(出力なし)

3. 後処理

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

sample

3.2. 完了条件の確認

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

完了条件1: S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっていない。

「S3バケット" handson-cli-website-XXXXXXXXXXXX"のバケットログ設定が有効になっていない。」ことを確認します。

コマンド:

aws s3api get-bucket-logging \
  --bucket ${S3_BUCKET_NAME}

結果(例):

(出力なし)

完了