L2 Construct

IdentityPool

Define a Cognito Identity Pool.

Import

import { IdentityPool } from 'aws-cdk-lib/aws-cognito-identitypool';

Or use the module namespace:

import * as cognito_identitypool from 'aws-cdk-lib/aws-cognito-identitypool';
// cognito_identitypool.IdentityPool

Configuration passed to the constructor as IdentityPoolProps.

allowClassicFlowOptional

boolean

Enables the Basic (Classic) authentication flow.

Default: - Classic Flow not allowed

allowUnauthenticatedIdentitiesOptional

boolean

Whether the Identity Pool supports unauthenticated logins.

Default: - false

authenticatedRoleOptional

IRole

The default Role to be assumed by authenticated users.

Default: - A default authenticated Role will be added

authenticationProvidersOptional

IdentityPoolAuthenticationProviders

Authentication Providers for using in Identity Pool.

Default: - No Authentication Providers passed directly to Identity Pool

identityPoolNameOptional

string

The name of the Identity Pool.

Default: - Automatically generated name by CloudFormation at deploy time

roleMappingsOptional

IdentityPoolRoleMapping[]

Rules for mapping roles to users.

Default: - no role mappings

unauthenticatedRoleOptional

IRole

The default Role to be assumed by unauthenticated users.

Default: - A default unauthenticated Role will be added

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

LevelL2 (Higher-level)

Moduleaws-cognito-identitypool

Properties7