3.1. SSMパラメータの作成 (PostgreSQL接続情報: /handson-rds/connection/handson-rds-dbinstance/pgadmin)¶
作業の目的 [why]¶
SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"を作成します。
ここでは、デフォルトのKMSキーを使用して暗号化します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。
- 事前条件2
- 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
- 事前条件3
- SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。
作業対象 [what]¶
- SSMサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 一時ファイル用ディレクトリ
- 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp
結果(例:存在する場合):
${HOME}/tmp
ディレクトリが存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp
リソース2: 接続権限の識別子
- パラメータストアに登録する接続情報ファイルの接続権限の識別子です。
- SSMパラメータ名に利用します。
- 今回は"handson-rds-dbinstance"とします。
リソース3: 接続情報の識別子
- パラメータストアに登録する接続情報ファイルの接続情報の識別子です。
- SSMパラメータ名に利用します。
- 今回は"pgadmin"とします。
リソース4: SSMパラメータ名プレフィクス
- 作成するSSMパラメータ名のプレフィクスです。
- パラメータへのアクセス制御のために利用します。
- 今回は"handson-rds"とします。
リソース5: SSMパラメータの説明
- 作成するSSMパラメータの説明です。
- 今回は"DB Connection Information for handson-rds"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. SSMパラメータ名の指定¶
接続対象の識別子
パラメータに登録する接続対象の識別子を指定します。
変数の設定:
CONNECTION_IDENT="handson-rds-dbinstance"
接続対象の識別子
パラメータに登録する接続対象の識別子を指定します。
変数の設定:
CONNECTION_TARGET="pgadmin"
SSMパラメータ名のプレフィックス指定
パラメータ名のプレフィックスを指定します。
変数の設定:
SSM_PARAMETER_PREFIX='handson-rds'
SSMパラメータ名の指定
変数の設定:
SSM_PARAMETER_NAME="/${SSM_PARAMETER_PREFIX}/connection/${CONNECTION_IDENT}/${CONNECTION_TARGET}" \ && echo ${SSM_PARAMETER_NAME}
結果(例):
/handson-rds/connection/handson-rds-dbinstance/pgadmin
0.3. SSMパラメータの説明¶
SSMパラメータの説明を指定します。
変数の設定:
SSM_PARAMETER_DESC='DB Connection Information for handson-rds'
0.4. 接続情報ァイル名の指定¶
接続情報ファイル名を指定します。
変数の設定:
FILE_DATA="${DIR_TMP}/${CONNECTION_IDENT}-${CONNECTION_TARGET}.txt" \ && echo ${FILE_DATA}
結果(例):
${HOME}/tmp/handson-rds-dbinstance-pgadmin.txt
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-rds" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ssm-parameter-create-expand-connect-postgresql.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-rds/2019-06-10-ssm-parameter-create-expand-connect-postgresql.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_TMP:"${HOME}/tmp" DIR_TMP="${DIR_TMP}" # 0.2. SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" # 0.3. SSM_PARAMETER_DESC:"DB Connection Information for handson-rds" SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}" # 0.4. FILE_DATA:"${HOME}/tmp/handson-rds-dbinstance-pgadmin.txt" FILE_DATA="${FILE_DATA}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。
「SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \ --query 'Parameters[].Name' \ --output text
結果(例):
(出力なし)
事前条件2: 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
「一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp
事前条件3: SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。
「SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在しない。」ことを確認します。
コマンド:
ls ${FILE_DATA}
結果(例):
${HOME}/tmp/handson-rds-dbinstance-pgadmin.txt
2. 主処理¶
SSMパラメータの作成¶
変数の確認:
cat << ETX SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" SSM_PARAMETER_DESC:"DB Connection Information for handson-rds" SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}" FILE_DATA:"${HOME}/tmp/handson-rds-dbinstance-pgadmin.txt" FILE_DATA="${FILE_DATA}" ETX
コマンド:
aws ssm put-parameter \ --name ${SSM_PARAMETER_NAME} \ --description "${SSM_PARAMETER_DESC}" \ --type SecureString \ --value file:///${FILE_DATA}
結果(例):
{ "Version": 1 }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。
「SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \ --query 'Parameters[].Name' \ --output text
結果(例):
/handson-rds/connection/handson-rds-dbinstance/pgadmin