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
戻り値
参照番号
UserToGroupAttachment-YejJvzrEXAMPLE
などの生成された ID このリソースの論理 ID を組み込みの Ref
関数に渡すと、Ref
は次を返します: 。
For more information about using the Ref
function, see Ref.