4.1. IAMポリシドキュメントの作成 (handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public)¶
作業の目的 [why]¶
IAMポリシ"handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public"のポリシドキュメントを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-ssm-parameter_store"が存在する。
- 事前条件2
- IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在しない。
- 事前条件3
- SSMパラメータ名プレフィクス"handson-cli-ssm-parameter_store/key/ssh/public"が存在する。
作業対象 [what]¶
- IAMサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース0: リージョン名
- 作成するIAMポリシードキュメントの対象となるSSMパラメータが存在するリージョン名です。
- 今回は"ap-northeast-1"とします。
リソース1: 設定ファイル用ディレクトリ
- 今回は"${HOME}/tmp/conf-handson-cli-ssm-parameter_store"をポリシドキュメント用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp/conf-handson-cli-ssm-parameter_store
結果(例:存在する場合):
${HOME}/tmp/conf-handson-cli-ssm-parameter_store
存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp/conf-handson-cli-ssm-parameter_store
リソース2: AWS ID
- 作成するIAMポリシードキュメントの対象となるSSMパラメータが属するAWSアカウントのアカウントIDです。
- 今回は"XXXXXXXXXXXX"とします。
リソース3: SSMパラメータ名プレフィクス
- 作成するSSMパラメータのプレフィクスです。
- 今回は"handson-cli-ssm-parameter_store/key/ssh/public"とします。
リソース4: IAMポリシードキュメント名
- 作成するIAMポリシードキュメントの名称です。
- 今回は"handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. AWS IDの指定¶
AWS IDを指定します。
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
0.3. SSMパラメータ名プレフィクスの指定¶
変数の設定:
SSM_PARAMETER_PREFIX='handson-cli-ssm-parameter_store/key/ssh/public'
0.4. IAMポリシドキュメントファイル名の指定¶
IAMポリシドキュメント名を指定します。
変数の設定:
IAM_POLICY_DOC_NAME='handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public'
IAMポリシドキュメントファイル名を指定します。
変数の設定:
FILE_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}/${IAM_POLICY_DOC_NAME}.json" \ && echo ${FILE_IAM_POLICY_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-ssm-parameter_store" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-iam-policy_document-create-expand-SSMParameterRead.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-ssm-parameter_store/2019-05-27-iam-policy_document-create-expand-SSMParameterRead.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli-ssm-parameter_store" DIR_IAM_POLICY_DOC="${DIR_IAM_POLICY_DOC}" # 0.2. AWS_ID:"XXXXXXXXXXXX" AWS_ID="${AWS_ID}" # 0.3. SSM_PARAMETER_PREFIX:"handson-cli-ssm-parameter_store/key/ssh/public" SSM_PARAMETER_PREFIX="${SSM_PARAMETER_PREFIX}" # 0.4. FILE_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json" FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-ssm-parameter_store"が存在する。
「ポリシドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-ssm-parameter_store"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_IAM_POLICY_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-ssm-parameter_store
事前条件2: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在しない。
「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_IAM_POLICY_DOC}
結果(例):
ls: ${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json No such file or directory
事前条件3: SSMパラメータ名プレフィクス"handson-cli-ssm-parameter_store/key/ssh/public"が存在する。
「SSMパラメータ名プレフィクス"handson-cli-ssm-parameter_store/key/ssh/public"が存在する。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_PREFIX}" \ --query 'Parameters[].Name' \ --output text
結果(例):
/handson-cli-ssm-parameter_store/key/ssh/public/handson-cli-ssm-parameter_store
2. 主処理¶
IAMポリシドキュメントの作成¶
変数の確認:
cat << EOF # FILE_IAM_POLICY_DOC:"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json" FILE_IAM_POLICY_DOC="${FILE_IAM_POLICY_DOC}" # AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # AWS_ID:"XXXXXXXXXXXX" AWS_ID="${AWS_ID}" # SSM_PARAMETER_PREFIX:"handson-cli-ssm-parameter_store/key/ssh/public" 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:ap-northeast-1:XXXXXXXXXXXX:parameter/handson-cli-ssm-parameter_store/key/ssh/public/*" } ] }
JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。
エラーが出力されなければOKです。
コマンド:
jsonlint -q ${FILE_IAM_POLICY_DOC}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在する。
「IAMポリシドキュメント"${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_IAM_POLICY_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-ssm-parameter_store/handson-cli-ssm-parameter_store-SSMParameterRead-key-ssh-public.json