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

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

YAML

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_numberemail 和/或 preferred_username

Required: No

Type: List of String values

更新要求无需中断

AutoVerifiedAttributes

要自动验证的属性。可能的值:email 和/或 phone_number

Required: No

Type: List of String values

更新要求无需中断

DeviceConfiguration

用于用户池设备跟踪的配置的类型。

Required: No

Type: Amazon Cognito UserPool DeviceConfiguration

更新要求无需中断

EmailConfiguration

电子邮件配置。

Required: No

Type: Amazon Cognito UserPool EmailConfiguration

更新要求无需中断

EmailVerificationMessage

表示电子邮件验证消息的字符串。必须在描述中包含 {####}

Required: No

Type: String

更新要求无需中断

EmailVerificationSubject

表示电子邮件验证主题的字符串。

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 策略

更新要求无需中断

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

类型:字符串到字符串映射

更新要求无需中断

返回值

Ref

如果向 Ref 内部函数提供此资源的逻辑 ID,Ref 会返回生成的 ID,例如 us-east-2_zgaEXAMPLE

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

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

ProviderName

Amazon Cognito 用户池的提供商名称,指定为 String

ProviderURL

Amazon Cognito 用户池提供商的 URL,指定为 String

Arn

用户池的 Amazon 资源名称 (ARN),例如 arn:aws-cn:cognito-idp:us-east-2:123412341234:userpool/us-east-1 _123412341

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

本页内容: