AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::Cognito::UserPool

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

構文

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

JSON

{ "Type" : "AWS::Cognito::UserPool", "Properties" : { "AdminCreateUserConfig" : AdminCreateUserConfig, "AliasAttributes" : [ String, ... ], "AutoVerifiedAttributes" : [ String, ... ], "DeviceConfiguration" : DeviceConfiguration, "EmailConfiguration" : EmailConfiguration, "EmailVerificationMessage" : String, "EmailVerificationSubject" : String, "LambdaConfig" : LambdaConfig, "MfaConfiguration" : String, "Policies" : Policies, "Schema" : [ SchemaAttribute, ... ], "SmsAuthenticationMessage" : String, "SmsConfiguration" : SmsConfiguration, "SmsVerificationMessage" : String, "UserPoolName" : String, "UserPoolTags" : Json, "UsernameAttributes" : [ String, ... ] } }

プロパティ

AdminCreateUserConfig

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

必須: いいえ

タイプ: AdminCreateUserConfig

Update requires: No interruption

AliasAttributes

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

必須: いいえ

タイプ: 文字列のリスト

Update requires: Replacement

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

LambdaConfig

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

注記

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

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

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

必須: いいえ

タイプ: LambdaConfig

Update requires: No interruption

MfaConfiguration

Multi-Factor Authentication (MFA) の設定の詳細を指定します。次のいずれかの値を指定できます。

OFF - MFA トークンは必要なく、ユーザー登録時に指定することはできません。

ON - すべてのユーザー登録で MFA トークンが必要です。ユーザープールを最初に作成するときにのみ必要事項を指定できます。

OPTIONAL - MFA トークンの作成のための登録時に、ユーザーが選択できます。

必須: いいえ

タイプ: 文字列

Update requires: No interruption

Policies

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

必須: いいえ

タイプ: Policies

Update requires: No interruption

Schema

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

必須: いいえ

タイプ: SchemaAttribute のリスト

最大: 50

Update requires: Replacement

SmsAuthenticationMessage

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

必須: いいえ

タイプ: 文字列

最小: 6

最大: 140

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

Update requires: No interruption

SmsConfiguration

SMS 設定です。

必須: いいえ

タイプ: SmsConfiguration

Update requires: No interruption

SmsVerificationMessage

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

必須: いいえ

タイプ: 文字列

最小: 6

最大: 140

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

Update requires: No interruption

UserPoolName

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

必須: いいえ

タイプ: 文字列

最小: 1

最大: 128

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

Update requires: Replacement

UserPoolTags

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

必須: いいえ

タイプ: Json

Update requires: No interruption

UsernameAttributes

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

必須: いいえ

タイプ: 文字列のリスト

Update requires: Replacement

戻り値

参照番号

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 です。

このページの内容: