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

Interface IdentityPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IdentityPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.657Z")
@Stability(Stable)
public interface IdentityPoolProps
extends software.amazon.jsii.JsiiSerializable

Props for the Identity Pool construct.

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	Interface	Description
static final class	IdentityPoolProps.Builder	A builder for IdentityPoolProps
static final class	IdentityPoolProps.Jsii$Proxy	An implementation for IdentityPoolProps

Method Summary

Modifier and Type	Method	Description
static IdentityPoolProps.Builder	builder()
default Boolean	getAllowClassicFlow()	Enables the Basic (Classic) authentication flow.
default Boolean	getAllowUnauthenticatedIdentities()	Whether the Identity Pool supports unauthenticated logins.
default IRole	getAuthenticatedRole()	The default Role to be assumed by authenticated users.
default IdentityPoolAuthenticationProviders	getAuthenticationProviders()	Authentication Providers for using in Identity Pool.
default String	getIdentityPoolName()	The name of the Identity Pool.
default List<IdentityPoolRoleMapping>	getRoleMappings()	Rules for mapping roles to users.
default IRole	getUnauthenticatedRole()	The default Role to be assumed by unauthenticated users.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowClassicFlow

@Stability(Stable)
@Nullable
default Boolean getAllowClassicFlow()

Enables the Basic (Classic) authentication flow.

Default: - Classic Flow not allowed

getAllowUnauthenticatedIdentities

@Stability(Stable)
@Nullable
default Boolean getAllowUnauthenticatedIdentities()

Whether the Identity Pool supports unauthenticated logins.

Default: - false

getAuthenticatedRole

@Stability(Stable)
@Nullable
default IRole getAuthenticatedRole()

The default Role to be assumed by authenticated users.

Default: - A default authenticated Role will be added

getAuthenticationProviders

@Stability(Stable)
@Nullable
default IdentityPoolAuthenticationProviders getAuthenticationProviders()

Authentication Providers for using in Identity Pool.

Default: - No Authentication Providers passed directly to Identity Pool

getIdentityPoolName

@Stability(Stable)
@Nullable
default String getIdentityPoolName()

The name of the Identity Pool.

Default: - Automatically generated name by CloudFormation at deploy time

getRoleMappings

@Stability(Stable)
@Nullable
default List<IdentityPoolRoleMapping> getRoleMappings()

Rules for mapping roles to users.

Default: - no role mappings

getUnauthenticatedRole

@Stability(Stable)
@Nullable
default IRole getUnauthenticatedRole()

The default Role to be assumed by unauthenticated users.

Default: - A default unauthenticated Role will be added

builder

@Stability(Stable)
static IdentityPoolProps.Builder builder()

Returns:

a IdentityPoolProps.Builder of IdentityPoolProps