# IUserPool

Represents a Cognito UserPool.

Extends: IUserPool
Extends: IResource, IUserPoolRef
Implemented by: UserPool

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

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — 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.

- `identityProviders`: [IUserPoolIdentityProvider](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPoolIdentityProvider.html)[] — Get all identity providers registered with this user pool.

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

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

- `userPoolArn`: string — The ARN of this user pool resource.

- `userPoolId`: string — The physical ID of this user pool resource.

- `userPoolProviderName`: string — The provider name of this user pool resource.

- `userPoolRef`: [UserPoolReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.UserPoolReference.html) — A reference to a UserPool resource.

## Methods

- `addClient(id: string, options?: UserPoolClientOptions): UserPoolClient` — Add a new app client to this user pool.

- `addDomain(id: string, options: UserPoolDomainOptions): UserPoolDomain` — Associate a domain to this user pool.

- `addGroup(id: string, options: UserPoolGroupOptions): UserPoolGroup` — Add a new group to this user pool.

- `addResourceServer(id: string, options: UserPoolResourceServerOptions): UserPoolResourceServer` — Add a new resource server to this user pool.

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

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Adds an IAM policy statement associated with this user pool to an IAM principal's policy.

- `registerIdentityProvider(provider: IUserPoolIdentityProviderRef): void` — Register an identity provider with this user pool.

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

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining