AWS::Cognito::UserPoolGroup - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Cognito::UserPoolGroup

在指定的用户池中指定新的组。

调用该操作需要使用开发人员凭证。

语法

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

JSON

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

YAML

Type: AWS::Cognito::UserPoolGroup Properties: Description: String GroupName: String Precedence: Double RoleArn: String UserPoolId: String

属性

Description

一个包含组描述的字符串。

必需:否

类型:字符串

最高2048

Update requires: No interruption

GroupName

组的名称。必须是唯一的。

必需:否

类型:字符串

最低1

最高128

模式[\p{L}\p{M}\p{S}\p{N}\p{P}]+

Update requires: Replacement

Precedence

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

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

Precedence 的默认值为 null。

必需:否

类型:双精度

最低0

Update requires: No interruption

RoleArn

组的角色 ARN。

必需:否

类型:字符串

最低20

最高2048

模式arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Update requires: No interruption

UserPoolId

用户池的用户池 ID。

必需:是

类型:字符串

最低1

最高55

模式[\w-]+_[0-9a-zA-Z]+

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回用户池组的名称。例如:Admins

For more information about using the Ref function, see Ref.