class IdentityPool (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.IdentityPool.IdentityPool
Java	software.amazon.awscdk.services.cognito.identitypool.IdentityPool
Python	aws_cdk.aws_cognito_identitypool.IdentityPool
TypeScript (source)	@aws-cdk/aws-cognito-identitypool » IdentityPool

Implements IConstruct, IConstruct, IDependable, IResource, IIdentityPool

Define a Cognito Identity Pool.

Example

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

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

Parameters

• scope Construct
• id string
• props IdentityPoolProps

Construct Props

Name	Type	Description
allowClassicFlow?🔹	boolean	Enables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentities?🔹	boolean	Wwhether the identity pool supports unauthenticated logins.
authenticatedRole?🔹	IRole	The Default Role to be assumed by Authenticated Users.
authenticationProviders?🔹	IdentityPoolAuthenticationProviders	Authentication providers for using in identity pool.
identityPoolName?🔹	string	The name of the Identity Pool.
roleMappings?🔹	IdentityPoolRoleMapping[]	Rules for mapping roles to users.
unauthenticatedRole?🔹	IRole	The Default Role to be assumed by Unauthenticated Users.

---

allowClassicFlow?🔹

Type: boolean (optional, default: Classic Flow not allowed)

Enables the Basic (Classic) authentication flow.

---

allowUnauthenticatedIdentities?🔹

Type: boolean (optional, default: false)

Wwhether the identity pool supports unauthenticated logins.

---

authenticatedRole?🔹

Type: IRole (optional, default: A Default Authenticated Role will be added)

The Default Role to be assumed by Authenticated Users.

---

authenticationProviders?🔹

Type: IdentityPoolAuthenticationProviders (optional, default: No Authentication Providers passed directly to Identity Pool)

Authentication providers for using in identity pool.

---

identityPoolName?🔹

Type: string (optional, default: automatically generated name by CloudFormation at deploy time)

The name of the Identity Pool.

---

roleMappings?🔹

Type: IdentityPoolRoleMapping[] (optional, default: no Role Mappings)

Rules for mapping roles to users.

---

unauthenticatedRole?🔹

Type: IRole (optional, default: A Default Unauthenticated Role will be added)

The Default Role to be assumed by Unauthenticated Users.

Properties

Name	Type	Description
authenticatedRole🔹	IRole	Default role for authenticated users.
env🔹	ResourceEnvironment	The environment this resource belongs to.
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.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.
unauthenticatedRole🔹	IRole	Default role for unauthenticated users.

---

authenticatedRole🔹

Type: IRole

Default role for authenticated users.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

identityPoolArn🔹

Type: string

The ARN of the Identity Pool.

---

identityPoolId🔹

Type: string

The id of the Identity Pool in the format REGION:GUID.

---

identityPoolName🔹

Type: string

The name of the Identity Pool.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

unauthenticatedRole🔹

Type: IRole

Default role for unauthenticated users.

Methods

Name	Description
addRoleMappings(...roleMappings)🔹	Adds Role Mappings to Identity Pool.
addUserPoolAuthentication(userPool)🔹	Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromIdentityPoolArn(scope, id, identityPoolArn)🔹	Import an existing Identity Pool from its Arn.
static fromIdentityPoolId(scope, id, identityPoolId)🔹	Import an existing Identity Pool from its id.

---

addRoleMappings(...roleMappings)🔹

public addRoleMappings(...roleMappings: IdentityPoolRoleMapping[]): void

Parameters

• roleMappings IdentityPoolRoleMapping

Adds Role Mappings to Identity Pool.

---

addUserPoolAuthentication(userPool)🔹

public addUserPoolAuthentication(userPool: IUserPoolAuthenticationProvider): void

Parameters

• userPool IUserPoolAuthenticationProvider

Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromIdentityPoolArn(scope, id, identityPoolArn)🔹

public static fromIdentityPoolArn(scope: Construct, id: string, identityPoolArn: string): IIdentityPool

Parameters

• scope Construct
• id string
• identityPoolArn string

Returns

• IIdentityPool

Import an existing Identity Pool from its Arn.

---

static fromIdentityPoolId(scope, id, identityPoolId)🔹

public static fromIdentityPoolId(scope: Construct, id: string, identityPoolId: string): IIdentityPool

Parameters

• scope Construct
• id string
• identityPoolId string

Returns

• IIdentityPool

Import an existing Identity Pool from its id.