AWS ドキュメント » AWS CloudFormation » ユーザーガイド » テンプレートリファレンス » AWS リソースおよびプロパティタイプのリファレンス » Amazon Cognito リソースタイプのリファレンス » AWS::Cognito::UserPoolUserToGroupAttachment

Filter View: All JSON YAML

AWS::Cognito::UserPoolUserToGroupAttachment

AWS::Cognito::UserPoolUserToGroupAttachment リソースは、ユーザーを Amazon Cognito ユーザープールユーザーグループにアタッチします。

構文

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

グループの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

Username

ユーザーのユーザー名。

Required: Yes

Type: String

更新に伴う要件: 置換

UserPoolId

ユーザープールの ID。

Required: Yes

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により UserToGroupAttachment-YejJvzrEXAMPLE のような生成された ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。