AWS::Cognito::UserPool - AWS CloudFormation

AWS::Cognito::UserPool

AWS::Cognito::UserPool リソースによって、Amazon Cognito ユーザープールが作成されます。Amazon Cognito ユーザープールの使用方法の詳細については、「Amazon Cognito ユーザープール」および「CreateUserPool」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

プロパティ

AccountRecoverySetting

この設定を使用して、ユーザーが ForgotPassword を呼び出したときにパスワードを回復するために使用できる、検証済みの利用可能なメソッドを定義します。ユーザーが複数のメソッドを使用できる場合、優先メソッドを定義できます。この設定では、ユーザーが SMS MFA を有効にしている場合、SMS は有効なパスワード回復メカニズムの対象にはなりません。この設定がない場合、Cognito は従来の動作を使用して、SMS が E メールよりも優先される回復方法を決定します。

必須: いいえ

タイプ: AccountRecoverySetting

Update requires: No interruption

AdminCreateUserConfig

新しいユーザープロファイルを作成するための設定。

必須: いいえ

タイプ: AdminCreateUserConfig

Update requires: No interruption

AliasAttributes

このユーザープールのエイリアスとしてサポートされている属性です。指定できる値: phone_numberemail、または preferred_username

注記

このユーザープールプロパティは更新できません。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

AutoVerifiedAttributes

自動的に検証される属性です。指定できる値: emailphone_number

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

DeviceConfiguration

デバイス設定です。

必須: いいえ

タイプ: DeviceConfiguration

Update requires: No interruption

EmailConfiguration

E メール設定です。

必須: いいえ

タイプ: EmailConfiguration

Update requires: No interruption

EmailVerificationMessage

E メール認証のメッセージを表す文字列です。

必須: いいえ

タイプ: 文字列

最小: 6

最大: 20000

パターン: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*

Update requires: No interruption

EmailVerificationSubject

E メール認証の件名を表す文字列です。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 140

パターン: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

Update requires: No interruption

EnabledMfas

指定されたユーザープールで MFA を有効にします。有効化後にすべての MFA を無効にするには、MfaConfiguration を「OFF」に設定し、EnabledMfas を削除します。MfaConfiguration が OFF の場合のみ、MFA をすべて無効にできます。SMS_MFA を有効にすると、SMS_MFA は MfaConfiguration を「OFF」に設定することによってのみ無効にできます。次のいずれかの値を指定できます。

  • SMS_MFA - ユーザープールの SMS MFA を有効にします。SMS_MFA は、SMS 設定が提供されている場合にのみ有効にできます。

  • SOFTWARE_TOKEN_MFA - ユーザープールのソフトウェアトークン MFA を有効にします。

使用できる値: SMS_MFA | SOFTWARE_TOKEN_MFA

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

LambdaConfig

新しいユーザープールのための Lambda トリガーの設定情報です。

注記

プッシュモデルでは、イベントソース (Amazon S3、カスタムアプリケーションなど) に関数を呼び出すアクセス権限が必要です。したがって、追加の呼び出しを実行し、これらのイベントソースのアクセス権限を追加して、Lambda 関数を呼び出す必要があります。

Lambda API を使用してアクセス許可を追加する方法については、「AddPermission」を参照してください。

AWS CLI を使用するアクセス許可の追加方法については、「add-permission」を参照してください。

必須: いいえ

タイプ: LambdaConfig

Update requires: No interruption

MfaConfiguration

多要素 (MFA) 設定。有効な値を次に示します。

  • OFF MFA は、どのユーザーにも使用されません。

  • ON MFA は、すべてのユーザーがサインインするために必要です。

  • OPTIONAL MFA は、MFA 要素が有効になっている個々のユーザーにのみ必要です。

必須: いいえ

タイプ: 文字列

許可された値: OFF | ON | OPTIONAL

Update requires: No interruption

Policies

ユーザープールに関連付けられたポリシー。

必須: いいえ

タイプ: Policies

Update requires: No interruption

Schema

新しいユーザープールのスキーマ属性。これらの属性は、標準属性またはカスタム属性です。

注記

ユーザープールの更新中に、新しいスキーマ属性を追加できますが、既存のスキーマ属性を変更または削除することはできません。

必須: いいえ

タイプ: SchemaAttribute のリスト

最大: 50

Update requires: No interruption

SmsAuthenticationMessage

SMS 認証のメッセージを表す文字列です。

必須: いいえ

タイプ: 文字列

最小: 6

最大: 140

パターン: .*\{####\}.*

Update requires: No interruption

SmsConfiguration

SMS 設定です。

必須: いいえ

タイプ: SmsConfiguration

Update requires: No interruption

SmsVerificationMessage

SMS 認証のメッセージを表す文字列です。

必須: いいえ

タイプ: 文字列

最小: 6

最大: 140

パターン: .*\{####\}.*

Update requires: No interruption

UsernameAttributes

ユーザーがサインアップするときに E メールアドレスまたは電話番号をユーザー名として指定できるかどうかを決定します。指定できる値は phone_number または email です。

このユーザープールプロパティは更新できません。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

UsernameConfiguration

選択したサインインオプションのユーザ名入力で、大文字と小文字を区別するよう選択できます。たとえば、このオプションを False に設定にすると、ユーザーは「username」と「Username」のどちらを使用してもサインインできます。この設定は、一度設定すると変更できません。

必須: いいえ

タイプ: UsernameConfiguration

Update requires: No interruption

UserPoolAddOns

高度なセキュリティリスク検出を有効にするために使用されます。キー AdvancedSecurityMode を値 「AUDIT」に設定します。

必須: いいえ

タイプ: UserPoolAddOns

Update requires: No interruption

UserPoolName

ユーザープール名に使用される文字列です。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 128

パターン: [\w\s+=,.@-]+

Update requires: No interruption

UserPoolTags

ユーザープールに割り当てるタグのキーと値です。タグとは、目的、所有者、環境、その他の条件など、さまざまな方法で、ユーザープールを分類および管理するために使用できるラベルです。

必須: いいえ

タイプ: Json

Update requires: No interruption

VerificationMessageTemplate

アプリがユーザーの情報へのアクセス許可をリクエストしたときにユーザーに表示される確認メッセージのテンプレート。

必須: いいえ

タイプ: VerificationMessageTemplate

Update requires: No interruption

戻り値

参照番号

us-east-2_zgaEXAMPLE などの生成された ID このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: 。

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 組み込み関数は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

Arn

arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 など、ユーザープールの Amazon リソースネーム (ARN) です。

ProviderName

String として指定される Amazon Cognito ユーザープールのプロバイダー名です。

ProviderURL

String として指定される Amazon Cognito ユーザープールのプロバイダーの URL です。