Package software.amazon.awscdk.services.cognito.identitypool

Class IdentityPool

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.identitypool.IdentityPool

All Implemented Interfaces:

IEnvironmentAware, IResource, IIdentityPool, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.637Z")
@Stability(Stable)
public class IdentityPool
extends Resource
implements IIdentityPool

Define a Cognito Identity Pool.

Example:

 OpenIdConnectProvider openIdConnectProvider;
 IdentityPool.Builder.create(this, "myidentitypool")
         .identityPoolName("myidentitypool")
         .authenticationProviders(IdentityPoolAuthenticationProviders.builder()
                 .google(IdentityPoolGoogleLoginProvider.builder()
                         .clientId("12345678012.apps.googleusercontent.com")
                         .build())
                 .openIdConnectProviders(List.of(openIdConnectProvider))
                 .customProvider("my-custom-provider.example.com")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IdentityPool.Builder	A fluent builder for IdentityPool.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.identitypool.IIdentityPool

IIdentityPool.Jsii$Default, IIdentityPool.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdentityPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IdentityPool(software.amazon.jsii.JsiiObjectRef objRef)
	IdentityPool(software.constructs.Construct scope, String id)
	IdentityPool(software.constructs.Construct scope, String id, IdentityPoolProps props)

Method Summary

Modifier and Type	Method	Description
void	addUserPoolAuthentication(IUserPoolAuthenticationProvider userPool)	Add a User Pool to the Identity Pool and configure the User Pool client to handle identities.
static IIdentityPool	fromIdentityPoolArn(software.constructs.Construct scope, String id, String identityPoolArn)	Import an existing Identity Pool from its ARN.
static IIdentityPool	fromIdentityPoolId(software.constructs.Construct scope, String id, String identityPoolId)	Import an existing Identity Pool from its ID.
IRole	getAuthenticatedRole()	Default Role for authenticated users.
String	getIdentityPoolArn()	The ARN of the Identity Pool.
String	getIdentityPoolId()	The ID of the Identity Pool in the format REGION:GUID.
String	getIdentityPoolName()	The name of the Identity Pool.
CfnIdentityPoolRoleAttachment	getRoleAttachment()	Role Provider for the default Role for authenticated users.
IRole	getUnauthenticatedRole()	Default Role for unauthenticated users.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

IdentityPool

protected IdentityPool(software.amazon.jsii.JsiiObjectRef objRef)

IdentityPool

protected IdentityPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

IdentityPool

@Stability(Stable)
public IdentityPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 IdentityPoolProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

IdentityPool

@Stability(Stable)
public IdentityPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromIdentityPoolArn

@Stability(Stable)
@NotNull
public static IIdentityPool fromIdentityPoolArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String identityPoolArn)

Import an existing Identity Pool from its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

identityPoolArn - This parameter is required.

fromIdentityPoolId

@Stability(Stable)
@NotNull
public static IIdentityPool fromIdentityPoolId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String identityPoolId)

Import an existing Identity Pool from its ID.

Parameters:

scope - This parameter is required.

id - This parameter is required.

identityPoolId - This parameter is required.

addUserPoolAuthentication

@Stability(Stable)
public void addUserPoolAuthentication(@NotNull
 IUserPoolAuthenticationProvider userPool)

Add a User Pool to the Identity Pool and configure the User Pool client to handle identities.

Parameters:

userPool - This parameter is required.

getAuthenticatedRole

@Stability(Stable)
@NotNull
public IRole getAuthenticatedRole()

Default Role for authenticated users.

getIdentityPoolArn

@Stability(Stable)
@NotNull
public String getIdentityPoolArn()

The ARN of the Identity Pool.

Specified by:

getIdentityPoolArn in interface IIdentityPool

getIdentityPoolId

@Stability(Stable)
@NotNull
public String getIdentityPoolId()

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

Specified by:

getIdentityPoolId in interface IIdentityPool

getIdentityPoolName

@Stability(Stable)
@NotNull
public String getIdentityPoolName()

The name of the Identity Pool.

Specified by:

getIdentityPoolName in interface IIdentityPool

getRoleAttachment

@Stability(Stable)
@NotNull
public CfnIdentityPoolRoleAttachment getRoleAttachment()

Role Provider for the default Role for authenticated users.

getUnauthenticatedRole

@Stability(Stable)
@NotNull
public IRole getUnauthenticatedRole()

Default Role for unauthenticated users.