software.amazon.awscdk.services.cognito.identitypool

Class IdentityPool

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

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

All Implemented Interfaces:

IConstruct, IDependable, IResource, IIdentityPool

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.814Z")
public class IdentityPool
extends Resource
implements IIdentityPool

(experimental) 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 and Description
static class	IdentityPool.Builder (experimental) A fluent builder for IdentityPool.

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

IIdentityPool.Jsii$Default, IIdentityPool.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRoleMappings(IdentityPoolRoleMapping... roleMappings) (experimental) Adds Role Mappings to Identity Pool.
void	addUserPoolAuthentication(IUserPoolAuthenticationProvider userPool) (experimental) Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.
static IIdentityPool	fromIdentityPoolArn(software.constructs.Construct scope, java.lang.String id, java.lang.String identityPoolArn) (experimental) Import an existing Identity Pool from its Arn.
static IIdentityPool	fromIdentityPoolId(software.constructs.Construct scope, java.lang.String id, java.lang.String identityPoolId) (experimental) Import an existing Identity Pool from its id.
IRole	getAuthenticatedRole() (experimental) Default role for authenticated users.
java.lang.String	getIdentityPoolArn() (experimental) The ARN of the Identity Pool.
java.lang.String	getIdentityPoolId() (experimental) The id of the Identity Pool in the format REGION:GUID.
java.lang.String	getIdentityPoolName() (experimental) The name of the Identity Pool.
IRole	getUnauthenticatedRole() (experimental) Default role for unauthenticated users.

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

IdentityPool

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

IdentityPool

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

IdentityPool

public IdentityPool(software.constructs.Construct scope,
                    java.lang.String id,
                    IdentityPoolProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

IdentityPool

public IdentityPool(software.constructs.Construct scope,
                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromIdentityPoolArn

public static IIdentityPool fromIdentityPoolArn(software.constructs.Construct scope,
                                                java.lang.String id,
                                                java.lang.String identityPoolArn)

(experimental) 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

public static IIdentityPool fromIdentityPoolId(software.constructs.Construct scope,
                                               java.lang.String id,
                                               java.lang.String identityPoolId)

(experimental) Import an existing Identity Pool from its id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

identityPoolId - This parameter is required.

addRoleMappings

public void addRoleMappings(IdentityPoolRoleMapping... roleMappings)

(experimental) Adds Role Mappings to Identity Pool.

Parameters:

roleMappings - This parameter is required.

addUserPoolAuthentication

public void addUserPoolAuthentication(IUserPoolAuthenticationProvider userPool)

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

Parameters:

userPool - This parameter is required.

getAuthenticatedRole

public IRole getAuthenticatedRole()

(experimental) Default role for authenticated users.

getIdentityPoolArn

public java.lang.String getIdentityPoolArn()

(experimental) The ARN of the Identity Pool.

Specified by:

getIdentityPoolArn in interface IIdentityPool

getIdentityPoolId

public java.lang.String getIdentityPoolId()

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

Specified by:

getIdentityPoolId in interface IIdentityPool

getIdentityPoolName

public java.lang.String getIdentityPoolName()

(experimental) The name of the Identity Pool.

Specified by:

getIdentityPoolName in interface IIdentityPool

getUnauthenticatedRole

public IRole getUnauthenticatedRole()

(experimental) Default role for unauthenticated users.