# UserPoolGroup

Define a user pool group.

Extends: Construct › Resource › UserPoolGroup
Implements: IResource, IUserPoolGroup, IEnvironmentAware, IUserPoolGroupRef, IConstruct, IDependable

- CloudFormation: [`AWS::Cognito::UserPoolGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cognito-userpoolgroup.html)
- L1 type: [`CfnUserPoolGroup`](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolGroup.html)
- Source: [`aws-cognito/lib/user-pool-group.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-group.ts#L79)
- 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'
});
```

## Initializer

```ts
new UserPoolGroup(scope: Construct, id: string, props: UserPoolGroupProps)
```

## Construct Props

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

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `groupName`: string (required) — The user group name.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

- `userPoolGroupRef`: [UserPoolGroupReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.UserPoolGroupReference.html) (required) — A reference to a UserPoolGroup resource.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromGroupName(scope: Construct, id: string, groupName: string): IUserPoolGroup` (static) — Import a UserPoolGroup given its group name.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.