3.2. Cognitoユーザプールの作成 (handson-cli-cognito-idp-userpool)

作業の目的 [why]

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"を作成します。

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

完了条件 [after]

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

完了条件1

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

事前条件 [before]

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

事前条件1

Cognitoユーザプールスキーマドキュメントファイル"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"が存在する。

事前条件2

Cognitoユーザプール名"handson-cli-cognito-idp-userpool"が存在しない。

作業対象 [what]

  • Cognito Identityサービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

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

  • 作成するCognitoユーザプールの名称です。

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

リソース2: Cognitoユーザプールスキーマドキュメントファイル

  • 今回は"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"をCognitoユーザプールスキーマドキュメントファイルとします。

パラメータの指定

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

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ユーザプールスキーマドキュメントファイルの指定

変数の設定:

DIR_COGNITO_IDP_USER_POOL_SCHEMA="${HOME}/environment/conf-handson-cli-cognito-idp"

変数の設定:

FILE_COGNITO_IDP_USER_POOL_SCHEMA="${DIR_COGNITO_IDP_USER_POOL_SCHEMA}/${COGNITO_IDP_USER_POOL_NAME}.json" \
  && echo ${FILE_COGNITO_IDP_USER_POOL_SCHEMA}

結果(例):

${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-cognito-idp/2019-12-11-cognito_idp-user_pool-create.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. FILE_COGNITO_IDP_USER_POOL_SCHEMA:"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"
         FILE_COGNITO_IDP_USER_POOL_SCHEMA="${FILE_COGNITO_IDP_USER_POOL_SCHEMA}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: Cognitoユーザプールスキーマドキュメントファイル"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"が存在する。

「Cognitoユーザプールスキーマドキュメントファイル"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_COGNITO_IDP_USER_POOL_SCHEMA}

結果(例):

${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json

事前条件2: 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

結果(例):

(出力なし)

2. 主処理

Cognitoユーザプールの作成

変数の確認:

cat << ETX

  # COGNITO_IDP_USER_POOL_NAME:"handson-cli-cognito-idp-userpool"
    COGNITO_IDP_USER_POOL_NAME:"${COGNITO_IDP_USER_POOL_NAME}"
  # FILE_COGNITO_IDP_USER_POOL_SCHEMA:"${HOME}/environment/conf-handson-cli-cognito-idp/handson-cli-cognito-idp-userpool.json"
    FILE_COGNITO_IDP_USER_POOL_SCHEMA:"${FILE_COGNITO_IDP_USER_POOL_SCHEMA}"

ETX

コマンド:

aws cognito-idp create-user-pool \
  --pool-name ${COGNITO_IDP_USER_POOL_NAME} \
  --schema file://${FILE_COGNITO_IDP_USER_POOL_SCHEMA}

結果(例):

{
  "UserPool": {
    "Id": "ap-northeast-1_xxxxxxxxx",
    "Name": "handson-cli-cognito-idp-userpool",
    "Policies": {
        "PasswordPolicy": {
            "MinimumLength": 8,
            "RequireUppercase": true,
            "RequireLowercase": true,
            "RequireNumbers": true,
            "RequireSymbols": true,
            "TemporaryPasswordValidityDays": 7
        }
    },
    "LambdaConfig": {},
    "LastModifiedDate": 1234567890.000,
    "CreationDate": 1234567890.000,
    "SchemaAttributes": [
        (略)
    ],
    "VerificationMessageTemplate": {
        "DefaultEmailOption": "CONFIRM_WITH_CODE"
    },
    "MfaConfiguration": "OFF",
    "EstimatedNumberOfUsers": 0,
    "EmailConfiguration": {
        "EmailSendingAccount": "COGNITO_DEFAULT"
    },
    "AdminCreateUserConfig": {
        "AllowAdminCreateUserOnly": false,
        "UnusedAccountValidityDays": 7
    },
    "Arn": "arn:aws:cognito-idp:ap-northeast-1:XXXXXXXXXXXX:userpool/ap-northeast-1_xxxxxxxxx"
  }
}

3. 後処理

完了条件の確認

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

完了条件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

完了