1. SSMパラメータの削除 (EC2キーペア: /handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1)¶
作業の目的 [why]¶
SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"を削除します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在しない。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在する。
作業対象 [what]¶
- SSMパラメータ
標準時間(合計)¶
8分
パラメータ設定¶
パラメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: キーペア名
- パラメータストアから削除するSSH秘密鍵のキーペア名です。SSMパラメータ名に利用しています。
- 今回は"handson-cli-keypair"とします。
リソース2: SSMパラメータ名
- 削除するSSMパラメータの名称です。
- 今回は"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. SSMパラメータ名の指定¶
パラメータ名を指定します。
SSMパラメータのプレフィクス指定
変数の設定:
SSM_PARAMETER_PREFIX='handson-cli'
AWS IDの指定
変数の設定:
AWS_ID='XXXXXXXXXXXX'
注釈
キーペアとパラメータストアが同じAWSアカウントの場合は、以下のコマンドで取得できます。
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
SSMパラメータ名の指定
変数の設定:
SSM_PARAMETER_NAME="/${SSM_PARAMETER_PREFIX}/keypair/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}" \ && echo ${SSM_PARAMETER_NAME}
結果(例):
/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ssm-parameter_keypair-delete.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ssm-parameter_keypair-delete.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" # 0.2. SSM_PARAMETER_NAME:"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
タスク標準時間: | 6分 |
---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在する。
「SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在する。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \ --query 'Parameters[].Name' \ --output text
結果(例):
/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1
2. 主処理¶
SSMパラメータの削除¶
変数の確認:
cat << ETX # SSM_PARAMETER_NAME:"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" ETX
コマンド:
aws ssm delete-parameter \ --name ${SSM_PARAMETER_NAME}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在しない。
「SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1"が存在しない。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \ --query 'Parameters[].Name' \ --output text
結果(例):
(出力なし)