3.3. Cognito IDPユーザプールの更新 (handson-cli-cognito-idp-userpool)

作業の目的 [why]

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"の"AutoVerifiedAttributes" の値を"email"に更新します。

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

完了条件 [after]

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

完了条件1

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"である。

事前条件 [before]

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

事前条件1

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"が存在する。

事前条件2

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"ではない。

作業対象 [what]

  • Cognitoユーザプール

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: Cognitoユーザプール名

  • 更新するCognitoユーザプールの名称です。

  • 今回は"handson-cli-cognito-idp-userpool"とします。

リソース2: Cognitoユーザプール名

  • 更新するCognitoユーザプールのAutoVerifiedAttributes属性の値です。

  • 今回は"email"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. Cognitoユーザプール名の指定

Cognitoユーザプール名を指定します。

変数の設定:

COGNITO_IDP_USER_POOL_NAME='handson-cli-cognito-idp-userpool'

0.2. CognitoユーザプールのAutoVerifiedAttributes属性の指定

CognitoユーザプールのAutoVerifiedAttributes属性を指定します。

変数の設定:

COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE='email'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-cognito-idp"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cognito_idp-user_pool-update-expand-auto_verified_attributes.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-cognito-idp/2019-12-11-cognito_idp-user_pool-update-expand-auto_verified_attributes.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. COGNITO_IDP_USER_POOL_NAME:"handson-cli-cognito-idp-userpool"
         COGNITO_IDP_USER_POOL_NAME="${COGNITO_IDP_USER_POOL_NAME}"
  # 0.2. COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE:"email"
         COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE="${COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: Cognitoユーザプール名"handson-cli-cognito-idp-userpool"が存在する。

「Cognitoユーザプール名"handson-cli-cognito-idp-userpool"が存在する。」ことを確認します。

コマンド:

aws cognito-idp list-user-pools \
  --max-results 60 \
  --query "UserPools[?Name == \`${COGNITO_IDP_USER_POOL_NAME}\`].Name" \
  --output text

結果(例):

handson-cli-cognito-idp-userpool

コマンド:

COGNITO_IDP_USER_POOL_ID=$( \
  aws cognito-idp list-user-pools \
    --max-results 60 \
    --query "UserPools[?Name == \`${COGNITO_IDP_USER_POOL_NAME}\`].Id" \
    --output text \
) \
  && echo ${COGNITO_IDP_USER_POOL_ID}

結果(例):

ap-northeast-1_xxxxxxxxx

事前条件2: Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"ではない。

「Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"ではない。」ことを確認します。

コマンド:

aws cognito-idp describe-user-pool \
  --user-pool-id ${COGNITO_IDP_USER_POOL_ID} \
  --query 'UserPool.AutoVerifiedAttributes' \
  --output text

結果(例):

None

2. 主処理

Cognitoユーザプールの更新

変数の確認:

cat << ETX

  # COGNITO_IDP_USER_POOL_ID:"ap-northeast-1_xxxxxxxxx"
    COGNITO_IDP_USER_POOL_ID:"${COGNITO_IDP_USER_POOL_ID}"
  # COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE:"email"
    COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE:"${COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE}"

ETX

コマンド:

aws cognito-idp update-user-pool \
  --user-pool-id ${COGNITO_IDP_USER_POOL_ID} \
  --auto-verified-attributes "${COGNITO_IDP_USER_POOL_AUTO_VERIFIED_ATTRIBUTE}"

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"である。

「Cognitoユーザプール名"handson-cli-cognito-idp-userpool"のAutoVerifiedAttributesが"email"である。」ことを確認します。

コマンド:

aws cognito-idp describe-user-pool \
  --user-pool-id ${COGNITO_IDP_USER_POOL_ID} \
  --query 'UserPool.AutoVerifiedAttributes' \
  --output text

結果(例):

email

完了