CfnIdentityPoolProps Struct
Properties for defining a CfnIdentityPool.
Example
ts
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
allowClassicFlowboolean | IResolvableallow_classic_flowtyping.Union[bool, IResolvable]allowClassicFlowBooleanAllowClassicFlowboolAllowClassicFlowinterface{}#Enables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentitiesboolean | IResolvableallow_unauthenticated_identitiestyping.Union[bool, IResolvable]allowUnauthenticatedIdentitiesBooleanAllowUnauthenticatedIdentitiesboolAllowUnauthenticatedIdentitiesinterface{}required#Specifies whether the identity pool supports unauthenticated logins.
The events to configure.
cognitoIdentityProvidersIResolvable | IResolvable | CfnIdentityPool.CognitoIdentityProviderProperty[]cognito_identity_providerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CognitoIdentityProviderProperty]]]cognitoIdentityProvidersIResolvableCognitoIdentityProvidersIResolvableCognitoIdentityProvidersinterface{}#The Amazon Cognito user pools and their client IDs.
cognitoStreamsIResolvable | CfnIdentityPool.CognitoStreamsPropertycognito_streamstyping.Union[IResolvable, CognitoStreamsProperty]cognitoStreamsIResolvableCognitoStreamsIResolvableCognitoStreamsinterface{}#Configuration options for configuring Amazon Cognito streams.
developerProviderNamestringdeveloper_provider_namestrdeveloperProviderNameStringDeveloperProviderNamestringDeveloperProviderName*string#The "domain" Amazon Cognito uses when referencing your users.
notes
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
identityPoolNamestringidentity_pool_namestridentityPoolNameStringIdentityPoolNamestringIdentityPoolName*string#The name of your Amazon Cognito identity pool.
Minimum length : 1
Maximum length : 128
Pattern : [\w\s+=,.@-]+
identityPoolTagsCfnTag[]identity_pool_tagstyping.List[CfnTag]identityPoolTagsList<CfnTag>IdentityPoolTagsCfnTag[]IdentityPoolTags*[]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.
openIdConnectProviderArnsstring | IOIDCProviderRef[]open_id_connect_provider_arnstyping.List[typing.Union[str, IOIDCProviderRef]]openIdConnectProviderArnsList<String>OpenIdConnectProviderArnsstring[]OpenIdConnectProviderArns*[]interface{}#The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSyncIResolvable | CfnIdentityPool.PushSyncPropertypush_synctyping.Union[IResolvable, PushSyncProperty]pushSyncIResolvablePushSyncIResolvablePushSyncinterface{}#The configuration options to be applied to the identity pool.
samlProviderArnsstring[]saml_provider_arnstyping.List[str]samlProviderArnsList<String>SamlProviderArnsstring[]SamlProviderArns*[]*string#The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supportedLoginProvidersanysupported_login_providersAnysupportedLoginProvidersObjectSupportedLoginProvidersobjectSupportedLoginProvidersinterface{}#Key-value pairs that map provider names to provider app IDs.