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

AWS::Cognito::UserPoolGroup

AWS::Cognito::UserPoolGroup 资源在 Amazon Cognito 用户池中创建用户组。

语法

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

JSON

Copy
{ "Type" : "AWS::Cognito::UserPoolGroup", "Properties" : { "Description" : String, "GroupName" : String, "Precedence" : Number, "RoleArn" : String, "UserPoolId" : String } }

YAML

Copy
Type: "AWS::Cognito::UserPoolGroup" Properties: Description: String GroupName: String Precedence: Number RoleArn: String UserPoolId: String

属性

Description

用户组的描述。

Required: No

Type: String

更新要求无需中断

MaxLength: 2048

GroupName

用户组的名称。GroupName 必须是唯一的。

Required: Yes

Type: String

更新要求替换

Precedence

一个非负整数值,指定该组相对于用户所属的用户池中其他组的优先级。零为最高的 Precedence 值。具有较低 Precedence 值的组优先于具有较高或空 Precedence 值的组。如果某用户属于两个或更多的组,则在该用户令牌的 cognito:rolescognito:preferred_role 声明中,将使用具有最低优先级值的组的角色 ARN。

两个组可以具有相同的 Precedence 值。如果发生这种情况,则两个组之间不存在优先情况。如果具有相同 Precedence 值的两个组还具有相同的角色 ARN,则该角色将用于各个组中用户的令牌的 cognito:preferred_role 声明中。如果两个组具有不同的角色 ARN,则不会在用户的令牌中设置 cognito:preferred_role 声明。

Precedence 的默认值为 null。

Required: No

Type: Number

更新要求无需中断

RoleArn

组的角色 ARN。

Required: No

Type: String

更新要求无需中断

UserPoolId

用户池 ID。

Required: Yes

Type: String

更新要求替换

返回值

Ref

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

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

本页内容: