3.2. SSMパラメータの取得 (/handson-rds/connection/handson-rds-dbinstance/pgadmin)

作業の目的 [why]

暗号化されたSSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"を取得して、ファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"に保存します。

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

完了条件 [after]

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

完了条件1
データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在する。

事前条件 [before]

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

事前条件1
SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。
事前条件2
一時ファイルディレクトリ"${HOME}/tmp"が存在する。
事前条件3
データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在しない。

作業対象 [what]

  • SSMサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: SSMパラメータ名

  • 取得するSSMパラメータの名称です。
  • 今回は"/handson-rds/connection/handson-rds-dbinstance/pgadmin"とします。

リソース2: 一時ファイル用ディレクトリ

  • 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp

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

${HOME}/tmp

ディレクトリが存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp

リソース3: データファイル名

  • 作成するデータフェイルの名称です。
  • 今回は"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. SSMパラメータ名の指定

SSMパラメータ名を指定します。

変数の設定:

SSM_PARAMETER_NAME='/handson-rds/connection/handson-rds-dbinstance/pgadmin'

0.2. 一時ファイルディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

0.3. データファイル名の指定

データファイル名を指定します。

変数の設定:

FILE_DATA="${DIR_TMP}/handson-rds-dbinstance-pgadmin.tmp" \
  && echo ${FILE_DATA}

結果(例):

${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-rds"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ssm-parameter-read-expand-secure_string.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-rds/2019-06-10-ssm-parameter-read-expand-secure_string.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin"
         SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  # 0.2. DIR_TMP:"${HOME}/tmp"
         DIR_TMP="${DIR_TMP}"
  # 0.3. FILE_DATA:"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"
         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

結果(例):

/handson-rds/connection/handson-rds-dbinstance/pgadmin

事前条件2: 一時ファイルディレクトリ"${HOME}/tmp"が存在する。

「一時ファイルディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件3: データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在しない。

「データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_DATA}

結果(例):

ls: ${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp No such file or directory

2. 主処理

SSMパラメータの取得

変数の確認:

cat << ETX

  SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin"
  SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  FILE_DATA:"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"
  FILE_DATA="${FILE_DATA}"

ETX

コマンド:

aws ssm get-parameter \
  --name ${SSM_PARAMETER_NAME} \
  --with-decryption \
  --query 'Parameter.Value' \
  --output text \
    > ${FILE_DATA}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在する。

「データファイル"${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp"が存在する。」ことを確認します。

コマンド:

ls ${FILE_DATA}

結果(例):

${HOME}/tmp/handson-rds-dbinstance-pgadmin.tmp

完了