# IdentityPool

Define a Cognito Identity Pool.

Extends: Construct › Resource › IdentityPool
Implements: IResource, IIdentityPool, IEnvironmentAware, IIdentityPoolRef, IConstruct, IDependable

- CloudFormation: [`AWS::Cognito::IdentityPool`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cognito-identitypool.html)
- L1 type: [`CfnIdentityPool`](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnIdentityPool.html)
- Source: [`aws-cognito-identitypool/lib/identitypool.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito-identitypool/lib/identitypool.ts#L372)
- Type last changed: v2.236.0 · 23 Jan 2026

## Example

```ts
declare const openIdConnectProvider: iam.OpenIdConnectProvider;
new IdentityPool(this, 'myidentitypool', {
  identityPoolName: 'myidentitypool',
  authenticationProviders: {
    google: {
      clientId: '12345678012.apps.googleusercontent.com',
    },
    openIdConnectProviders: [openIdConnectProvider],
    customProvider: 'my-custom-provider.example.com',
  },
});
```

## Initializer

```ts
new IdentityPool(scope: Construct, id: string, props?: IdentityPoolProps)
```

## Construct Props

- `allowClassicFlow`: boolean — Enables the Basic (Classic) authentication flow.

  **Default:** Classic Flow not allowed

- `allowUnauthenticatedIdentities`: boolean = false — Whether the Identity Pool supports unauthenticated logins.

- `authenticatedRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The default Role to be assumed by authenticated users.

  **Default:** A default authenticated Role will be added

- `authenticationProviders`: [IdentityPoolAuthenticationProviders](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito_identitypool.IdentityPoolAuthenticationProviders.html) — Authentication Providers for using in Identity Pool.

  **Default:** No Authentication Providers passed directly to Identity Pool

- `identityPoolName`: string — The name of the Identity Pool.

  **Default:** Automatically generated name by CloudFormation at deploy time

- `roleMappings`: [IdentityPoolRoleMapping](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito_identitypool.IdentityPoolRoleMapping.html)[] — Rules for mapping roles to users.

  **Default:** no role mappings

- `unauthenticatedRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The default Role to be assumed by unauthenticated users.

  **Default:** A default unauthenticated Role will be added

## Properties

- `authenticatedRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — Default Role for authenticated users.

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

- `identityPoolArn`: string — The ARN of the Identity Pool.

- `identityPoolId`: string — The ID of the Identity Pool in the format REGION:GUID.

- `identityPoolName`: string — The name of the Identity Pool.

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

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

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

- `roleAttachment`: [CfnIdentityPoolRoleAttachment](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnIdentityPoolRoleAttachment.html) — Role Provider for the default Role for authenticated users.

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

- `unauthenticatedRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — Default Role for unauthenticated users.

## Methods

- `addUserPoolAuthentication(userPool: IUserPoolAuthenticationProvider): void` — Add a User Pool to the Identity Pool and configure the User Pool client to handle identities.

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

- `fromIdentityPoolArn(scope: Construct, id: string, identityPoolArn: string): IIdentityPool` (static) — Import an existing Identity Pool from its ARN.

- `fromIdentityPoolId(scope: Construct, id: string, identityPoolId: string): IIdentityPool` (static) — Import an existing Identity Pool from 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.