UserPoolGroupProps Struct
Props for UserPoolGroup construct.
Example
declare const userPool: cognito.UserPool;
declare const role: iam.Role;
new cognito.UserPoolGroup(this, 'UserPoolGroup', {
userPool,
groupName: 'my-group-name',
precedence: 1,
role, // assign IAM Role
});
// You can also add a group by using addGroup method.
userPool.addGroup('AnotherUserPoolGroup', {
groupName: 'another-group-name'
});
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: no description
groupNameoptionalstringgroup_nameoptionalstrgroupNameoptionalStringGroupNameoptionalstringGroupNameoptional*string#Default: auto generate a name
Must be unique.
precedenceoptionalnumberprecedenceoptionalint | floatprecedenceoptionalNumberPrecedenceoptionaldoublePrecedenceoptional*float64= null#notes
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.
roleoptionalIRoleRefroleoptionalIRoleRefroleoptionalIRoleRefRoleoptionalIRoleRefRoleoptionalIRoleRef#Default: no description
userPoolIUserPoolRefuser_poolIUserPoolRefuserPoolIUserPoolRefUserPoolIUserPoolRefUserPoolIUserPoolRefrequired#