メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::Cognito::UserPool

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

構文

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

JSON

Copy
{ "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, "UserPoolName" : String, "Schema" : [ SchemaAttribute ], "SmsAuthenticationMessage" : String, "SmsConfiguration" : SmsConfiguration, "SmsVerificationMessage" : String, "UserPoolTags" : { 文字列: 文字列, ... } } }

YAML

Copy
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 UserPoolName: String Schema: - SchemaAttribute SmsAuthenticationMessage: String SmsConfiguration: SmsConfiguration SmsVerificationMessage: String UserPoolTags: 文字列: 文字列

プロパティ

AdminCreateUserConfig

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

Required: No

Type: Amazon Cognito UserPool AdminCreateUserConfig

更新に伴う要件: 中断はありません。

AliasAttributes

このユーザープールのエイリアスとしてサポートされている属性です。想定される値: phone_numberemailpreferred_username

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

AutoVerifiedAttributes

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

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

DeviceConfiguration

ユーザープールのデバイス追跡の設定のタイプです。

Required: No

Type: Amazon Cognito UserPool DeviceConfiguration

更新に伴う要件: 中断はありません。

EmailConfiguration

E メール設定です。

Required: No

Type: Amazon Cognito UserPool EmailConfiguration

更新に伴う要件: 中断はありません。

EmailVerificationMessage

E メール認証のメッセージを表す文字列です。説明に {####} を含んでいる必要があります。

Required: No

Type: String

更新に伴う要件: 中断はありません。

EmailVerificationSubject

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

LambdaConfig

Amazon Cognito ユーザープールのための AWS Lambda トリガーの設定情報です。

Required: No

Type: Amazon Cognito UserPool LambdaConfig

更新に伴う要件: 中断はありません。

MfaConfiguration

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

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

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

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

Policies

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

Required: No

Type: Amazon Cognito UserPool Policies

更新に伴う要件: 中断はありません。

UserPoolName

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

Required: Yes

Type: String

更新に伴う要件: 置換

Schema

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

Required: No

: 以下のリスト SchemaAttribute

更新に伴う要件: 置換

SmsAuthenticationMessage

SMS 認証のメッセージを表す文字列です。メッセージに {####} を含んでいる必要があります。

Required: No

Type: String

更新に伴う要件: 中断はありません。

SmsConfiguration

ショートメッセージサービス (SMS) の設定です。

Required: No

Type: Amazon Cognito UserPool SmsConfiguration

更新に伴う要件: 中断はありません。

SmsVerificationMessage

SMS 認証のメッセージを表す文字列です。メッセージに {####} を含んでいる必要があります。

Required: No

Type: String

更新に伴う要件: 中断はありません。

UserPoolTags

ユーザープールのコスト配分タグです。詳細については、Amazon Cognito 開発者ガイドの「ユーザープールへのコスト配分タグの追加」を参照してください。

Required: No

タイプ: 文字列から文字列へのマッピング

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により us-east-2_zgaEXAMPLE のような生成された ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

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

ProviderName

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

ProviderURL

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

Arn

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

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

このページの内容: