interface CfnIdentityPoolProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.CfnIdentityPoolProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnIdentityPoolProps |
 Java | software.amazon.awscdk.services.cognito.CfnIdentityPoolProps |
 Python | aws_cdk.aws_cognito.CfnIdentityPoolProps |
 TypeScript | aws-cdk-lib » aws_cognito » CfnIdentityPoolProps |
Properties for defining a CfnIdentityPool.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html
Example
import * as cognito from 'aws-cdk-lib/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 |
|---|---|---|
| allow | boolean | IResolvable | Specifies whether the identity pool supports unauthenticated logins. |
| allow | boolean | IResolvable | Enables the Basic (Classic) authentication flow. |
| cognito | any | The events to configure. |
| cognito | IResolvable | IResolvable | Cognito[] | The Amazon Cognito user pools and their client IDs. |
| cognito | IResolvable | Cognito | Configuration options for configuring Amazon Cognito streams. |
| developer | string | The "domain" Amazon Cognito uses when referencing your users. |
| identity | string | The name of your Amazon Cognito identity pool. |
| identity | Cfn[] | Tags to assign to the identity pool. |
| open | string[] | The Amazon Resource Names (ARNs) of the OpenID connect providers. |
| push | IResolvable | Push | The configuration options to be applied to the identity pool. |
| saml | string[] | The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers. |
| supported | 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 | Cognito[]
(optional)
The Amazon Cognito user pools and their client IDs.
cognitoStreams?
Type:
IResolvable | Cognito
(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+=,.@-]+
identityPoolTags?
Type:
Cfn[]
(optional)
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.
openIdConnectProviderArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSync?
Type:
IResolvable | Push
(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.