ICognitoIdentityProviderCreateGroupRequest
Interface in AWS.CognitoIdentityProvider
Interface for CreateGroup requests.
Ancestors
Properties
Description
property Description: string
Specify a description for the group.
GroupName
property GroupName: string
Specify a name for the group.
Precedence
property Precedence: TOptional<Integer>
Specify a non-negative value for 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. The default Precedence value is null. Groups with lower Precedence values takes precedence over groups with higher or null precedence 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 the cognito:roles and cognito:preferred_role claim. Two groups can have the same Precedence value.If this happens, neither group takes precedence over the other. If both groups have the same role ARN, that is used in the cognito:preferred_role claim in tokens for users in each group. If the groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
RoleArn
property RoleArn: TARN
Specify the Amazon Resource Name (ARN) of a role for the group.
UserPoolId
property UserPoolId: string
Specify the ID of the user pool.