AWS::Cognito::UserPoolGroup

AWS::Cognito::UserPoolGroup リソースは、Amazon Cognito ユーザープール内のユーザーグループを作成します。

トピック

構文
プロパティ
戻り値

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON


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

YAML


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 の値を持つグループは、高いまたは null Precedence 値を持つグループよりも優先されます。ユーザーが 2 つ以上のグループに属している場合は、優先順位値が最も低いグループのロール ARN が、ユーザーのトークンの cognito:roles および cognito:preferred_role クレームで使用されます。

2 つのグループは、同じ Precedence の値を持つことができます。その場合は、どちらのグループも他方に対して優先されません。同じ Precedence の値を持つ 2 つのグループのロール ARN が同じである場合、そのロールは各グループのユーザーのトークンの cognito:preferred_role クレームで使用されます。2 つのグループのロール ARN が異なる場合、cognito:preferred_role クレームは、ユーザーのトークンで設定されません。

デフォルト Precedence 値は null です。

Required: No

Type: Number

更新に伴う要件: 中断はありません。

RoleArn