2.169.0

interface UserPoolGroupOptions

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolGroupOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolGroupOptions
Javasoftware.amazon.awscdk.services.cognito.UserPoolGroupOptions
Pythonaws_cdk.aws_cognito.UserPoolGroupOptions
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolGroupOptions

Options to create a UserPoolGroup.

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

NameTypeDescription
description?stringA string containing the description of the group.
groupName?stringThe name of the group.
precedence?numberA 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.
role?IRoleThe role for the group.

description?

Type: string (optional, default: no description)

A string containing the description of the group.

groupName?

Type: string (optional, default: auto generate a name)

The name of the group.

Must be unique.

precedence?

Type: number (optional, default: null)

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 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.

role?

Type: IRole (optional, default: no description)

The role for the group.

← PreviousNext →