# UserPoolGroupProps

Props for UserPoolGroup construct.

Extends: UserPoolGroupProps
Extends: UserPoolGroupOptions
Used as props by: UserPoolGroup

- Source: [`aws-cognito/lib/user-pool-group.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-group.ts#L69)
- Type last changed: v2.235.0 · 15 Jan 2026

## Example

```ts
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

- `description`: string — A string containing the description of the group.

  **Default:** no description

- `groupName`: string — The name of the group.

  **Default:** auto generate a name

  Must be unique.

- `precedence`: number = 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`: [IRoleRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.IRoleRef.html) — The role for the group.

  **Default:** no description

- `userPool`: [IUserPoolRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.IUserPoolRef.html) (required) — The user pool to which this group is associated.