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
の値を持つグループは、高いまたは nullPrecedence
値を持つグループよりも優先されます。ユーザーが複数のグループに属している場合、これは ARN ロールがユーザーの ID トークンでcognito:roles
およびcognito:preferred_role
クレームに使用される、最も優先順位の値が低いグループです。2 つのグループは、同じ
Precedence
の値を持つことができます。その場合は、どちらのグループも他方に対して優先されません。同じPrecedence
を持つ 2 つのグループのロール ARN が同じである場合、そのロールは各グループのユーザーのトークンのcognito:preferred_role
クレームで使用されます。2 つのグループのロール 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
戻り値
参照番号
ユーザープールグループの名前 このリソースの論理 ID を組み込みの Ref
関数に渡すと、Ref
は次を返します: 。例: Admins
。
For more information about using the Ref
function, see Ref.