GroupType
The group type.
Contents
- CreationDate
-
The date and time, in ISO 8601
format, when the item was created. Type: Timestamp
Required: No
- Description
-
A string containing the description of the group.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
- GroupName
-
The name of the group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
- LastModifiedDate
-
The date and time, in ISO 8601
format, when the item was modified. Type: Timestamp
Required: No
- Precedence
-
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower
Precedence
values take precedence over groups with higher ornullPrecedence
values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn't set in users' tokens.The default
Precedence
value is null.Type: Integer
Valid Range: Minimum value of 0.
Required: No
- RoleArn
-
The role Amazon Resource Name (ARN) for the group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Required: No
- UserPoolId
-
The user pool ID for the user pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: