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

AWS::Cognito::UserPoolUserToGroupAttachment

向指定的组添加指定的用户。

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

语法

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

JSON

{ "Type" : "AWS::Cognito::UserPoolUserToGroupAttachment", "Properties" : { "GroupName" : String, "Username" : String, "UserPoolId" : String } }

YAML

Type: AWS::Cognito::UserPoolUserToGroupAttachment Properties: GroupName: String Username: String UserPoolId: String

属性

GroupName

组名称。

必需:是

类型:字符串

最低1

最高128

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

Update requires: Replacement

Username

用户的用户名。

必需:是

类型:字符串

最低1

最高128

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

Update requires: Replacement

UserPoolId

用户池的用户池 ID。

必需:是

类型:字符串

最低1

最高55

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

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回生成的 ID,例如 UserToGroupAttachment-YejJvzrEXAMPLE

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