UserPoolGroup
Define a user pool group.
Import
import { UserPoolGroup } from 'aws-cdk-lib/aws-cognito';Or use the module namespace:
import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolGroupProperties
Configuration passed to the constructor as UserPoolGroupProps.
userPoolRequiredIUserPoolRefThe user pool to which this group is associated.
4 properties inherited from UserPoolGroupOptions
descriptionOptionalinherited from UserPoolGroupOptionsstringA string containing the description of the group.
Default: - no description
groupNameOptionalinherited from UserPoolGroupOptionsstringThe name of the group. Must be unique.
Default: - auto generate a name
precedenceOptionalinherited from UserPoolGroupOptionsnumberA 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 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 claims. 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 isn't set in users' tokens.
Default: - null
roleOptionalinherited from UserPoolGroupOptionsIRoleRefThe role for the group.
Default: - no description
Get the Amazon Cognito Cheat Sheet
Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-cognito