参考. IAMポリシドキュメントの作成 (handson-cli-conf-CodeCommitRepositoryRead)

作業の目的 [why]

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

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

完了条件 [after]

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

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

事前条件 [before]

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

事前条件1
ポリシドキュメント用ディレクトリ"${HOME}/tmp/handson-cli-conf-codecommit"が存在する。
事前条件2
IAMポリシドキュメント"${HOME}/tmp/handson-cli-conf-codecommit/handson-cli-conf-CodeCommitRepositoryRead.json"が存在しない。
事前条件3
CodeCommitリポジトリ"handson-cli-conf"が存在する。

作業対象 [what]

  • IAMサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース0: リージョン名

  • 作成するIAMポリシードキュメントの対象となるSSMパラメータが存在するリージョン名です。
  • 今回は"ap-northeast-1"とします。

リソース1: CodeCommitリポジトリ名

  • 作成するIAMポリシードキュメントの対象となるCodeCommitリポジトリの名称です。
  • 今回は"handson-cli-conf"とします。

リソース2: ポリシドキュメントファイル用ディレクトリ

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

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

コマンド:

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

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

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

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

コマンド:

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

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

  • 作成するIAMポリシードキュメントの名称です。
  • 今回は"handson-cli-conf-CodeCommitRepositoryRead"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CodeCommitリポジトリ名の指定

CodeCommitリポジトリ名を指定します。

変数の設定:

CODEC_REPOSITORY_NAME='handson-cli-conf'

0.2. ポリシドキュメントファイルディレクトリの指定

変数の設定:

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

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

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

変数の設定:

IAM_POLICY_DOC_NAME='handson-cli-conf-CodeCommitRepositoryRead'

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

変数の設定:

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

結果(例):

${HOME}/tmp/handson-cli-conf-codecommit/handson-cli-conf-CodeCommitRepositoryRead.json

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-iam-policy_document-create-expand-CodeCommitRepositoryRead.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-iam-policy_document-create-expand-CodeCommitRepositoryRead.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. CODEC_REPOSITORY_NAME:"handson-cli-conf"
         CODEC_REPOSITORY_NAME="${CODEC_REPOSITORY_NAME}"
  # 0.2. DIR_IAM_POLICY_DOC:"${HOME}/tmp/handson-cli-conf-codecommit"
         DIR_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}"
  # 0.3. FILE_IAM_POLICY_DOC:"${HOME}/tmp/handson-cli-conf-codecommit/handson-cli-conf-CodeCommitRepositoryRead.json"
         FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}"

EOF
cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_IAM_POLICY_DOC}

結果(例):

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

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

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

コマンド:

! ls ${FILE_IAM_POLICY_DOC}

結果(例):

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

事前条件3: CodeCommitリポジトリ"handson-cli-conf"が存在する。

「CodeCommitリポジトリ"handson-cli-conf"が存在する。」ことを確認します。

コマンド:

aws codecommit list-repositories \
  --query "repositories[?repositoryName == \`${CODEC_REPOSITORY_NAME}\`].repositoryName" \
  --output text

結果(例):

handson-cli-conf

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

CodeCommitリポジトリのARN取得

コマンド:

CODEC_REPOSITORY_ARN=$( \
  aws codecommit get-repository \
  --repository-name ${CODEC_REPOSITORY_NAME} \
  --query 'repositoryMetadata.Arn' \
  --output text \
) \
  && echo ${CODEC_REPOSITORY_ARN}

結果(例):

arn:aws:codecommit:ap-northeast-1:XXXXXXXXXXXX:handson-cli-conf

2. 主処理

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

変数の確認:

cat << EOF

  # FILE_IAM_POLICY_DOC:"${HOME}/tmp/handson-cli-conf-codecommit/handson-cli-conf-CodeCommitRepositoryRead.json"
    FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}"
  # CODEC_REPOSITORY_ARN:"arn:aws:codecommit:ap-northeast-1:XXXXXXXXXXXX:handson-cli-conf"
    CODEC_REPOSITORY_ARN="${CODEC_REPOSITORY_ARN}"

EOF

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

コマンド:

cat << EOF > ${FILE_IAM_POLICY_DOC}
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codecommit:BatchGet*",
        "codecommit:Get*",
        "codecommit:List*",
        "codecommit:Describe*",
        "codecommit:GitPull"
      ],
      "Resource": "${CODEC_REPOSITORY_ARN}"
    }
  ]
}
EOF

cat ${FILE_IAM_POLICY_DOC}

結果(例):

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codecommit:BatchGet*",
        "codecommit:Get*",
        "codecommit:List*",
        "codecommit:Describe*",
        "codecommit:GitPull"
      ],
      "Resource": "arn:aws:codecommit:ap-northeast-1:XXXXXXXXXXXX:handson-cli-conf"
    }
  ]
}

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

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

コマンド:

jsonlint -q ${FILE_IAM_POLICY_DOC}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

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

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

コマンド:

ls ${FILE_IAM_POLICY_DOC}

結果(例):

${HOME}/tmp/handson-cli-conf-codecommit/handson-cli-conf-CodeCommitRepositoryRead.json

完了