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

AWS::Cognito::UserPoolUser

AWS::Cognito::UserPoolUser リソースは、Amazon Cognito ユーザープールユーザーを作成します。

構文

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

JSON

Copy
{ "Type" : "AWS::Cognito::UserPoolUser", "Properties" : { "DesiredDeliveryMediums" : [ String, ... ], "ForceAliasCreation" : Boolean, "UserAttributes" : [ AttributeType, ... ], "MessageAction" : String, "Username" : String, "UserPoolId" : String, "ValidationData" : [ AttributeType, ...] } }

YAML

Copy
Type: "AWS::Cognito::UserPoolUser" Properties: DesiredDeliveryMediums: - 文字列 ForceAliasCreation: Boolean UserAttributes: - AttributeType MessageAction: String Username: String UserPoolId: String ValidationData: - AttributeType

プロパティ

DesiredDeliveryMediums

ウェルカムメッセージが送信される方法を指定します。E メールの場合、EMAIL を指定します。電話番号を使用する場合、SMS を指定します。複数の値を指定できます。デフォルト値は SMS です。

Required: No

Type: List of String values

更新に伴う要件: 置換

ForceAliasCreation

phone_number_verified 属性または email_verified 属性が True と設定されている場合にのみ、このパラメータを使用します。それ以外の場合は無視されます。デフォルト値は False です。

このパラメータが True に設定されており、UserAttributes パラメータで指定された E メールアドレスまたは電話番号がすでに別のユーザーのエイリアスとして存在する場合、API コールは前のユーザーのエイリアスを新しく作成されたユーザーに移行します。以前のユーザーはそのエイリアスを使用してログインできなくなります。

このパラメータが False に設定されており、エイリアスがすでに存在している場合、API は AliasExistsException エラーをスローします。

Required: No

Type: Boolean

更新に伴う要件: 置換

UserAttributes

作成しているユーザーに設定するためのユーザー属性と属性値が含まれている名前と値のペアのリスト。Username 以外の属性を指定せずにユーザーを作成できます。ただし、(CreateUserPool か、またはコンソールの [属性] タブで) 自分で必須と指定した属性は、(AdminCreateUser の呼び出し時に) 自分で、または (ウェルカムメッセージに応答してサインアップする時に) ユーザーが指定する必要があります。

Required: No

Amazon Cognito UserPoolUser AttributeTypeType: リスト

更新に伴う要件: 置換

MessageAction

メッセージで実行するアクションを指定します。有効な値は、RESEND および SUPPRESS です。

既存のユーザーに招待メッセージを再送信してそのユーザーアカウントの有効期限をリセットするには、このパラメータを RESEND に設定します。メッセージの送信を抑止するには、SUPPRESS に設定します。設定できる値は 1 つだけです。

Required: No

Type: String

更新に伴う要件: 置換

Username

ユーザーのユーザー名。Username はユーザープール内で一意である必要があります。1~128 文字の UTF-8 文字列である必要があります。ユーザー名を変更することはできません。

Required: No

Type: String

更新に伴う要件: 置換

UserPoolId

ユーザーが作成されるユーザープールの ID。

Required: Yes

Type: String

更新に伴う要件: 置換

ValidationData

ユーザーの検証データ。登録できるユーザーアカウントのタイプを制限するなどのカスタム検証に使用する、ユーザー属性と属性値が格納されている名前と値のペアのリスト。たとえば、ユーザードメインに基づき、ユーザーのサインアップを許可または拒否することができます。

カスタム検証を設定するには、ユーザープールにプレサインアップ Lambda トリガーを作成する必要があります。Lambda トリガーは検証データを受け取り、検証プロセスで使用します。詳細については、Amazon Cognito 開発者ガイドの「AWS Lambda トリガーを使用したユーザープールのワークフローのカスタマイズ」を参照してください。

Required: No

Amazon Cognito UserPoolUser AttributeTypeType: リスト

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref はユーザー名を返します。たとえば、admin と指定します。

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

このページの内容: