# UserPoolClient

Define a UserPool App Client.

Extends: Construct › Resource › UserPoolClient
Implements: IResource, IUserPoolClient, IEnvironmentAware, IUserPoolClientRef, IConstruct, IDependable

- CloudFormation: [`AWS::Cognito::UserPoolClient`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cognito-userpoolclient.html)
- L1 type: [`CfnUserPoolClient`](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolClient.html)
- Source: [`aws-cognito/lib/user-pool-client.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-client.ts#L442)
- Type last changed: v2.235.0 · 15 Jan 2026

## Example

```ts
const pool = new cognito.UserPool(this, 'Pool');
const provider = new cognito.UserPoolIdentityProviderAmazon(this, 'Amazon', {
  userPool: pool,
  clientId: 'amzn-client-id',
  clientSecret: 'amzn-client-secret',
});

const client = pool.addClient('app-client', {
  // ...
  supportedIdentityProviders: [
    cognito.UserPoolClientIdentityProvider.AMAZON,
  ],
});

client.node.addDependency(provider);
```

## Initializer

```ts
new UserPoolClient(scope: Construct, id: string, props: UserPoolClientProps)
```

## Construct Props

- `accessTokenValidity`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.minutes(60) — Validity of the access token.

  Values between 5 minutes and 1 day are valid. The duration cannot be longer than the refresh token validity.

- `analytics`: [AnalyticsConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.AnalyticsConfiguration.html) — The analytics configuration for this client.

  **Default:** no analytics configuration

- `authFlows`: [AuthFlow](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.AuthFlow.html) — The set of OAuth authentication flows to enable on the client.

  **Default:** If you don't specify a value, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

- `authSessionValidity`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.minutes(3) — Cognito creates a session token for each API request in an authentication flow.

  AuthSessionValidity is the duration, in minutes, of that session token.
  see defaults in `AuthSessionValidity`. Valid duration is from 3 to 15 minutes.

- `disableOAuth`: boolean = false — Turns off all OAuth interactions for this client.

- `enablePropagateAdditionalUserContextData`: boolean — Enable the propagation of additional user context data.

  **Default:** false for new user pool clients

  You can only activate enablePropagateAdditionalUserContextData in an app client that has a client secret.

- `enableTokenRevocation`: boolean — Enable token revocation for this client.

  **Default:** true for new user pool clients

- `generateSecret`: boolean = false — Whether to generate a client secret.

- `idTokenValidity`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.minutes(60) — Validity of the ID token.

  Values between 5 minutes and 1 day are valid. The duration cannot be longer than the refresh token validity.

- `oAuth`: [OAuthSettings](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.OAuthSettings.html) — OAuth settings for this client to interact with the app.

  **Default:** see defaults in `OAuthSettings`. meaningless if `disableOAuth` is set.

  An error is thrown when this is specified and `disableOAuth` is set.

- `preventUserExistenceErrors`: boolean = false — Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence.

- `readAttributes`: [ClientAttributes](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.ClientAttributes.html) — The set of attributes this client will be able to read.

  **Default:** all standard and custom attributes

- `refreshTokenRotationGracePeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — Enables refresh token rotation when set.

  **Default:** undefined (refresh token rotation is disabled)

  Defines the grace period for the original refresh token (0-60 seconds).

- `refreshTokenValidity`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.days(30) — Validity of the refresh token.

  Values between 60 minutes and 10 years are valid.

- `supportedIdentityProviders`: [UserPoolClientIdentityProvider](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider.html)[] — The list of identity providers that users should be able to use to sign in using this client.

  **Default:** supports all identity providers that are registered with the user pool. If the user pool and/or identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the `UserPool.registerIdentityProvider()` API.

- `userPool`: [IUserPoolRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.IUserPoolRef.html) (required) — The UserPool resource this client will have access to.

- `userPoolClientName`: string — Name of the application client.

  **Default:** cloudformation generated name

- `writeAttributes`: [ClientAttributes](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.ClientAttributes.html) — The set of attributes this client will be able to write.

  **Default:** all standard and custom attributes

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

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

- `oAuthFlows`: [OAuthFlows](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.OAuthFlows.html) — The OAuth flows enabled for this client.

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

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

- `userPoolClientId`: string — Name of the application client.

- `userPoolClientName`: string — The client name that was specified via the `userPoolClientName` property during initialization, throws an error otherwise.

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

- `userPoolClientSecret`: [SecretValue](/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) — The generated client secret.

  Only available if the "generateSecret" props is set to true

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

- `fromUserPoolClientId(scope: Construct, id: string, userPoolClientId: string): IUserPoolClient` (static) — Import a user pool client given its id.

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