You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentityProvider::Types::GroupType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::GroupType
- Defined in:
- (unknown)
Overview
The group type.
Returned by:
Instance Attribute Summary collapse
-
#creation_date ⇒ Time
The date the group was created.
-
#description ⇒ String
A string containing the description of the group.
-
#group_name ⇒ String
The name of the group.
-
#last_modified_date ⇒ Time
The date the group was last modified.
-
#precedence ⇒ Integer
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
-
#role_arn ⇒ String
The role ARN for the group.
-
#user_pool_id ⇒ String
The user pool ID for the user pool.
Instance Attribute Details
#creation_date ⇒ Time
The date the group was created.
#description ⇒ String
A string containing the description of the group.
#group_name ⇒ String
The name of the group.
#last_modified_date ⇒ Time
The date the group was last modified.
#precedence ⇒ Integer
A nonnegative integer value that specifies the precedence of this group
relative to the other groups that a user can belong to in the user pool.
If a user belongs to two or more groups, it is the group with the
highest precedence whose role ARN will be used in the cognito:roles
and cognito:preferred_role
claims in the user\'s tokens. Groups with
higher Precedence
values take precedence over groups with lower
Precedence
values or with null Precedence
values.
Two groups can have the same Precedence
value. If this happens,
neither group takes precedence over the other. If two groups with the
same Precedence
have the same role ARN, that role is used in the
cognito:preferred_role
claim in tokens for users in each group. If the
two groups have different role ARNs, the cognito:preferred_role
claim
is not set in users\' tokens.
The default Precedence
value is null.
#role_arn ⇒ String
The role ARN for the group.
#user_pool_id ⇒ String
The user pool ID for the user pool.