AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Cognito::IdentityPool

CfnIdentityPool

The `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito identity pool. To avoid deleting the resource accidentally from CloudFormation , use [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and the [UpdateReplacePolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) to retain the resource on deletion or replacement.

Import

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

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.CfnIdentityPool

Properties

Configuration passed to the constructor as CfnIdentityPoolProps.

allowUnauthenticatedIdentitiesRequired
boolean | IResolvable

Specifies whether the identity pool supports unauthenticated logins.

allowClassicFlowOptional
boolean | IResolvable

Enables the Basic (Classic) authentication flow.

cognitoEventsOptional
any

The events to configure.

cognitoIdentityProvidersOptional
IResolvable | IResolvable | CognitoIdentityProviderProperty[]

The Amazon Cognito user pools and their client IDs.

cognitoStreamsOptional
IResolvable | CognitoStreamsProperty

Configuration options for configuring Amazon Cognito streams.

developerProviderNameOptional
string

The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the `DeveloperProviderName` , you can use letters and periods (.), underscores (_), and dashes (-). *Minimum length* : 1 *Maximum length* : 100

identityPoolNameOptional
string

The name of your Amazon Cognito identity pool. *Minimum length* : 1 *Maximum length* : 128 *Pattern* : `[\w\s+=,.@-]+`

identityPoolTagsOptional
CfnTag[]

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderArnsOptional
string | IOIDCProviderRef[]

The Amazon Resource Names (ARNs) of the OpenID connect providers.

pushSyncOptional
IResolvable | PushSyncProperty

The configuration options to be applied to the identity pool.

samlProviderArnsOptional
string[]

The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

supportedLoginProvidersOptional
any

Key-value pairs that map provider names to provider app IDs.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Cognito::IdentityPoolView in CloudFormation Explorer

Get the Amazon Cognito Cheat Sheet

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cognito
CFN TypeAWS::Cognito::IdentityPool
Properties12

Related Constructs

Explore This Service

External Links