2.1. IAMポリシドキュメントの作成 (handson-cli-s3-S3BucketWritePolicy)

作業の目的 [why]

IAMポリシ"handson-cli-s3-S3BucketWritePolicy"のポリシドキュメントを作成します。

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

完了条件 [after]

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

完了条件1

IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在する。

事前条件 [before]

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

事前条件1

ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。

事前条件2

IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在しない。

事前条件3

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

作業対象 [what]

  • IAMサービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: 設定ファイル用ディレクトリ

  • 今回は"${HOME}/tmp/conf-handson-cli-s3"をポリシドキュメント用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp/conf-handson-cli-s3

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

${HOME}/tmp/conf-handson-cli-s3

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

コマンド:

mkdir -p ${HOME}/tmp/conf-handson-cli-s3

リソース2: IAMポリシードキュメント名

  • 作成するIAMポリシードキュメントの名称です。

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

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

  • 作成するIAMポリシードキュメントの対象となるS3バケットの名称です。

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

パラメータの指定

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

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

変数の設定:

DIR_IAM_POLICY_DOC="${HOME}/tmp/conf-handson-cli-s3"

0.2. IAMポリシドキュメント名の指定

IAMポリシドキュメント名を指定します。

変数の設定:

IAM_POLICY_DOC_NAME='handson-cli-s3-S3BucketWritePolicy'

0.3. 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)-iam-policy_document-create-expand-S3BucketWrite.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-s3/2019-09-23-iam-policy_document-create-expand-S3BucketWrite.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. DIR_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli-s3"
         DIR_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}"
  # 0.2. IAM_POLICY_DOC_NAME:"handson-cli-s3-S3BucketWritePolicy"
         IAM_POLICY_DOC_NAME="${IAM_POLICY_DOC_NAME}"
  # 0.3. S3_BUCKET_NAME:"handson-cli-s3-XXXXXXXXXXXX"
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"

EOF
cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

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

IAMポリシドキュメントファイル名の指定

変数の設定:

FILE_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}/${IAM_POLICY_DOC_NAME}.json" \
  && echo ${FILE_IAM_POLICY_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json

1.2. 処理対象の状態確認

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

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

事前条件1: ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。

「ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_IAM_POLICY_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli-s3

事前条件2: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在しない。

「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_IAM_POLICY_DOC}

結果(例):

ls: ${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json No such file or directory

事前条件3: 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. 主処理

IAMポリシドキュメントの作成

変数の確認:

cat << EOF

  # FILE_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"
    FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}"
  # S3_BUCKET_NAME:"handson-cli-s3-XXXXXXXXXXXX"
    S3_BUCKET_NAME="${S3_BUCKET_NAME}"

EOF

ポリシードキュメントを作成します。

コマンド:

cat << EOF > ${FILE_IAM_POLICY_DOC}
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "ListObjectsInBucket",
      "Effect": "Allow",
      "Action": ["s3:ListBucket"],
      "Resource": ["arn:aws:s3:::${S3_BUCKET_NAME}"]
    },
    {
      "Sid": "AllObjectActions",
      "Effect": "Allow",
      "Action": "s3:*Object",
      "Resource": ["arn:aws:s3:::${S3_BUCKET_NAME}/*"]
    }
  ]
}
EOF

cat ${FILE_IAM_POLICY_DOC}

結果(例):

{
    "Version": "2012-10-17",
    "Statement": [
      {
        "Sid": "ListObjectsInBucket",
        "Effect": "Allow",
        "Action": ["s3:ListBucket"],
        "Resource": ["arn:aws:s3:::handson-cli-s3-XXXXXXXXXXXX"]
      },
      {
        "Sid": "AllObjectActions",
        "Effect": "Allow",
        "Action": "s3:*Object",
        "Resource": ["arn:aws:s3:::handson-cli-s3-XXXXXXXXXXXX/*"]
      }
    ]
}

JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。

エラーが出力されなければOKです。

コマンド:

jsonlint -q ${FILE_IAM_POLICY_DOC}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在する。

「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_IAM_POLICY_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-S3BucketWritePolicy.json

完了