1. IAMポリシドキュメントの作成 (SSMParameterRead-handson-cli-connection-pgadmin)¶
作業の目的 [why]¶
IAMポリシ"SSMParameterRead-handson-cli-connection-pgadmin"のポリシドキュメントを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
- 事前条件2
- IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在しない。
- 事前条件3
- SSMパラメータプレフィクス"handson-cli/connection/pgadmin"が存在する。
作業対象 [what]¶
- 作業用ローカル環境
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
リソース1: ポリシドキュメント用ディレクトリ
- 今回は"${HOME}/tmp/conf-handson-cli"をポリシドキュメント用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp/conf-handson-cli
結果(例:存在する場合):
${HOME}/tmp/conf-handson-cli
存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp/conf-handson-cli
リソース2: IAMポリシドキュメント名
- 作成するIAMポリシドキュメントの名称です。
- 今回は"SSMParameterRead-handson-cli-connection-pgadmin"とします。
リソース3: SSMパラメータのプレフィクス
- 対象とするSSMパラメータのプレフィクスです。
- 今回は"handson-cli/connection/pgadmin"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. IAMポリシドキュメント名の指定¶
IAMポリシドキュメント名を指定します。
変数の設定:
IAM_POLICY_DOC_NAME='SSMParameterRead-handson-cli-connection-pgadmin'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-iam-policy_document-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-iam-policy_document-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"<リージョン名>" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli" DIR_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}" # 0.2. IAM_POLICY_DOC_NAME:"SSMParameterRead-handson-cli-connection-pgadmin" IAM_POLICY_DOC_NAME="${IAM_POLICY_DOC_NAME}" # 0.3. SSM_PARAMETER_PREFIX:"handson-cli/connection/pgadmin" SSM_PARAMETER_PREFIX="${SSM_PARAMETER_PREFIX}" 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/SSMParameterRead-handson-cli-connection-pgadmin.json
1.2. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
「ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_IAM_POLICY_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli
事前条件2: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在しない。
「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_IAM_POLICY_DOC}
結果(例):
ls: ${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json No such file or directory
事前条件3: SSMパラメータプレフィクス"handson-cli/connection/pgadmin"が存在する。
「SSMパラメータプレフィクス"handson-cli/connection/pgadmin"が存在する。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_PREFIX}" \ --query 'Parameters[].Name' \ --output text
結果(例):
handson-cli/connection/pgadmin/xxxxxxxxxx
1.3. 主処理に必要な情報の取得¶
AWS IDの取得
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
2. 主処理¶
IAMポリシドキュメントの作成¶
変数の確認:
cat << EOF # FILE_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json" FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}" # AWS_DEFAULT_REGION:"<リージョン名>" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # AWS_ID:"XXXXXXXXXXXX" AWS_ID="${AWS_ID}" # SSM_PARAMETER_PREFIX:"handson-cli/connection/pgadmin" SSM_PARAMETER_PREFIX="${SSM_PARAMETER_PREFIX}" EOF
ポリシードキュメントを作成します。
コマンド:
cat << EOF > ${FILE_IAM_POLICY_DOC} { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:DescribeParameters" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "ssm:GetParameter" ], "Resource": "arn:aws:ssm:${AWS_DEFAULT_REGION}:${AWS_ID}:parameter/${SSM_PARAMETER_PREFIX}/*" } ] } EOF cat ${FILE_IAM_POLICY_DOC}
結果(例):
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:DescribeParameters" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "ssm:GetParameters" ], "Resource": "arn:aws:ssm:<リージョン名>:XXXXXXXXXXXX:parameter/handson-cli/connection/pgadmin/*" } ] }
JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。
エラーが出力されなければOKです。
コマンド:
jsonlint -q ${FILE_IAM_POLICY_DOC}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在する。
「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_IAM_POLICY_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli/SSMParameterRead-handson-cli-connection-pgadmin.json