ユーザープール設定の更新 - Amazon Cognito
Amazon Cognito API または AWS CLI を使用してユーザープールを更新する

ユーザープール設定の更新

AWS Management Console で Amazon Cognito ユーザープールの設定を変更するには、ユーザプール設定の機能ベースのタブを移動して、このガイドの他のセクションの説明に従ってフィールドを更新します。ユーザープールを作成した後に、この設定を変更することはできません。以下の設定を変更する場合は、新しいユーザープールまたはアプリクライアントを作成する必要があります。

ユーザープール名

ユーザープールに割り当てた分かりやすい名前。ユーザープール名を変更するには、新しいユーザープールを作成します。

Amazon Cognito ユーザープールサインインオプション

ユーザーがサインインするときにユーザー名として渡すことができる属性。ユーザープールを作成するときに、ユーザー名、E メールアドレス、電話番号、または優先ユーザー名を使用してサインインを許可するかどうかを選択できます。ユーザープールサインインオプションを変更するには、新しいユーザープールを作成します。

ユーザー名の大文字と小文字を区別する

大文字と小文字以外の別のユーザー名と一致するユーザー名を作成した場合、Amazon Cognito では同じユーザーまたは一意のユーザーとして扱うことができます。詳細については、「ユーザープールの大文字と小文字の区別」を参照してください。大文字と小文字の区別を変更するには、新しいユーザープールを作成します。

必須属性

ユーザーのサインアップ時または作成時に値を提供する必要がある属性。詳細については、「ユーザープール属性」を参照してください。必要な属性を変更するには、新しいユーザープールを作成します。

クライアントシークレット

アプリクライアントを作成するときに、信頼されたソースだけがユーザープールにリクエストを送信できるように、クライアントシークレットを生成できます。詳細については、「ユーザープールのアプリケーションクライアントの設定」を参照してください。クライアントシークレットを変更するには、同じユーザープール内に新しいアプリクライアントを作成します。

カスタム属性

カスタム名を持つ属性です。ユーザーのカスタム属性の値を変更することはできますが、ユーザープールからカスタム属性を削除することはできません。詳細については、「ユーザープール属性」を参照してください。カスタム属性の最大数に達してリストを変更する場合は、新しいユーザープールを作成します。

Amazon Cognito API または AWS CLI を使用してユーザープールを更新する

Amazon Cognito API または AWS Command Line Interface (AWS CLI) などの自動化ツールを使用して、Amazon Cognito ユーザープールの設定を変更できます。次の手順で、UpdateUserPool API オペレーションを使用して設定を更新します。入力フィールドが異なる同じアプローチが、UpdateUserPoolClient に適用されます。

重要

既存のパラメータの値を提供しない場合、Amazon Cognito はそれらをデフォルト値に設定します。例えば、既存の LambdaConfig がある場合に、空の LambdaConfig で UpdateUserPool を送信すると、すべての Lambda 関数のユーザープールトリガーへの割り当てが削除されます。ユーザープール設定の変更を自動化する場合は、適宜計画を立ててください。

  1. DescribeUserPool を使用して、ユーザープールの既存の状態をキャプチャします。

  2. DescribeUserPool の出力を UpdateUserPool のリクエストパラメータと一致するようにフォーマットします。出力される JSON から次のトップレベルフィールドとその子オブジェクトを削除します。

    • Arn

    • CreationDate

    • CustomDomain

      • このフィールドを UpdateUserPoolDomain API オペレーションを使用して更新します。

    • Domain

      • このフィールドを UpdateUserPoolDomain API オペレーションを使用して更新します。

    • EmailConfigurationFailure

    • EstimatedNumberOfUsers

    • Id

    • LastModifiedDate

    • Name

    • SchemaAttributes

    • SmsConfigurationFailure

    • Status

  3. 生成された JSON が UpdateUserPool のリクエストパラメータと一致することを確認します。

  4. 生成された JSON で変更するパラメータを変更します。

  5. 変更した JSON をリクエスト入力として使用する UpdateUserPool API リクエストを送信します。

また、AWS CLI の update-user-pool の --cli-input-json パラメータで、この修正した DescribeUserPool の出力を使用することもできます。

または、次の AWS CLI コマンドを実行して、update-user-pool の受け入れた入力フィールドの値が空白の JSON を生成します。その後、これらのフィールドにユーザープールの既存の値を入力できます。

aws cognito-idp update-user-pool --generate-cli-skeleton --output json

次のコマンドを実行して、アプリクライアント用に同じ JSON オブジェクトを生成します。

aws cognito-idp update-user-pool-client --generate-cli-skeleton --output json