AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::Cognito::UserPoolUser

AWS::Cognito::UserPoolUser 资源创建 Amazon Cognito 用户池用户。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

Type: "AWS::Cognito::UserPoolUser" Properties: DesiredDeliveryMediums: - 字符串 ForceAliasCreation: Boolean UserAttributes: - AttributeType MessageAction: String Username: String UserPoolId: String ValidationData: - AttributeType

属性

DesiredDeliveryMediums

指定欢迎消息的发送方式。对于电子邮件,请指定 EMAIL。要使用电话号码,请指定 SMS。您可以指定多个值。默认值为 SMS

Required: No

Type: List of String values

更新要求替换

ForceAliasCreation

仅当 phone_number_verified 属性或 email_verified 属性设置为 True 时才使用该参数。否则将忽略它。默认值为 False

如果该参数设置为 True,并且在 UserAttributes 参数中指定的电话号码或电子邮件地址已作为其他用户的别名存在,则 API 调用会将该别名从以前的用户迁移到新创建的用户。以前的用户无法再使用该别名登录。

如果该参数设置为 False,并且别名已存在,则 API 将引发 AliasExistsException 错误。

Required: No

Type: Boolean

更新要求替换

UserAttributes

包含要为正在创建的用户设置的用户属性和属性值的名称/值对列表。您可以在只指定 Username 的情况下创建用户。但是,您指定为必需 (在控制台的 CreateUserPoolAttributes 选项卡中) 的属性必须由您 (在对 AdminCreateUser 的调用中) 或由用户 (在注册时回复您的欢迎消息) 提供。

Required: No

Type: Amazon Cognito UserPoolUser AttributeType 列表

更新要求替换

MessageAction

指定要对消息执行的操作。有效值为 RESENDSUPPRESS

要向已存在的用户重新发送邀请消息,并重置用户账户的过期限制,请将该参数设置为 RESEND。要关闭消息发送,请将其设置为 SUPPRESS。您只能指定一个值。

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

Type: Amazon Cognito UserPoolUser AttributeType 列表

更新要求替换

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回用户的名称。例如:admin

有关使用 Ref 功能的更多信息,请参阅参考

本页内容: