interface CfnIdentityPoolProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnIdentityPoolProps`
Java	`software.amazon.awscdk.services.cognito.CfnIdentityPoolProps`
Python	`aws_cdk.aws_cognito.CfnIdentityPoolProps`
TypeScript	`@aws-cdk/aws-cognito` » `CfnIdentityPoolProps`

Properties for defining a CfnIdentityPool.

Example

import * as cognito from '@aws-cdk/aws-cognito';

declare const myProvider: iam.OpenIdConnectProvider;
new cognito.CfnIdentityPool(this, 'IdentityPool', {
  openIdConnectProviderArns: [myProvider.openIdConnectProviderArn],
  // And the other properties for your identity pool
  allowUnauthenticatedIdentities: false,
});

Properties

Name	Type	Description
allowUnauthenticatedIdentities	`boolean \|` `IResolvable`	Specifies whether the identity pool supports unauthenticated logins.
allowClassicFlow?	`boolean \|` `IResolvable`	Enables the Basic (Classic) authentication flow.
cognitoEvents?	`any`	The events to configure.
cognitoIdentityProviders?	`IResolvable` `\|` `IResolvable` `\|` `CognitoIdentityProviderProperty[]`	The Amazon Cognito user pools and their client IDs.
cognitoStreams?	`IResolvable` `\|` `CognitoStreamsProperty`	Configuration options for configuring Amazon Cognito streams.
developerProviderName?	`string`	The "domain" Amazon Cognito uses when referencing your users.
identityPoolName?	`string`	The name of your Amazon Cognito identity pool.
openIdConnectProviderArns?	`string[]`	The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSync?	`IResolvable` `\|` `PushSyncProperty`	The configuration options to be applied to the identity pool.
samlProviderArns?	`string[]`	The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supportedLoginProviders?	`any`	Key-value pairs that map provider names to provider app IDs.

allowUnauthenticatedIdentities

Type: boolean | IResolvable

Specifies whether the identity pool supports unauthenticated logins.

allowClassicFlow?

Type: boolean | IResolvable (optional)

Enables the Basic (Classic) authentication flow.

cognitoEvents?

Type: any (optional)

The events to configure.

cognitoIdentityProviders?

Type: IResolvable | IResolvable | CognitoIdentityProviderProperty[] (optional)

The Amazon Cognito user pools and their client IDs.

cognitoStreams?

Type: IResolvable | CognitoStreamsProperty (optional)

Configuration options for configuring Amazon Cognito streams.

developerProviderName?

Type: string (optional)

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

identityPoolName?

Type: string (optional)

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

Pattern : [\w\s+=,.@-]+

openIdConnectProviderArns?

Type: string[] (optional)

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

pushSync?

Type: IResolvable | PushSyncProperty (optional)

The configuration options to be applied to the identity pool.

samlProviderArns?

Type: string[] (optional)

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

supportedLoginProviders?

Type: any (optional)

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