後始末2.1. IAMユーザSSH公開鍵の削除 (handson-cli-conf-user)

作業の目的 [why]

IAMユーザ"handson-cli-conf-user"のSSH公開鍵を削除します。

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

完了条件 [after]

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

完了条件1
IAMユーザ"handson-cli-conf-user"にSSH公開鍵が登録されていない。

事前条件 [before]

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

事前条件1
IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。

作業対象 [what]

  • IAMサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: IAMユーザ名

  • SSH公開鍵を削除するIAMユーザの名称です。
  • 今回は"handson-cli-conf-user"とします。

パラメータの指定

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

0.1. IAMユーザ名の指定

IAMユーザ名を指定します。

変数の設定:

IAM_USER_NAME='handson-cli-conf-user'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-iam-ssh_public_key-delete.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-iam-ssh_public_key-delete.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. IAM_USER_NAME:"handson-cli-conf-user"
         IAM_USER_NAME="${IAM_USER_NAME}"

EOF
cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。

「IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。」ことを確認します。

コマンド:

aws iam list-ssh-public-keys \
  --user-name ${IAM_USER_NAME} \
  --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
  --output text

結果(例):

APKAxxxxxxxxxxxxxxxx

1.2. 主処理に必要な情報の取得

SSH公開鍵IDの取得

コマンド:

IAM_SSH_PUBLIC_KEY_ID=$( \
  aws iam list-ssh-public-keys \
    --user-name ${IAM_USER_NAME} \
    --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
    --output text \
) \
  && echo ${IAM_SSH_PUBLIC_KEY_ID}

結果(例):

APKAxxxxxxxxxxxxxxxx

2. 主処理

公開鍵の削除

変数の確認:

cat << ETX

  # IAM_USER_NAME:"handson-cli-conf-user"
    IAM_USER_NAME="${IAM_USER_NAME}"
  # IAM_SSH_PUBLIC_KEY_ID:"APKAxxxxxxxxxxxxxxxx"
    IAM_SSH_PUBLIC_KEY_ID="${IAM_SSH_PUBLIC_KEY_ID}"

ETX

コマンド:

aws iam delete-ssh-public-key \
  --user-name ${IAM_USER_NAME} \
  --ssh-public-key-id ${IAM_SSH_PUBLIC_KEY_ID}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: IAMユーザ"handson-cli-conf-user"にSSH公開鍵が登録されていない。

「IAMユーザ"handson-cli-conf-user"にSSH公開鍵が登録されていない。」ことを確認します。

コマンド:

aws iam list-ssh-public-keys \
  --user-name ${IAM_USER_NAME} \
  --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
  --output text

結果(例):

(出力なし)

完了