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
allowClassicFlowoptionalboolean | IResolvableallow_classic_flowoptionaltyping.Union[bool, IResolvable]allowClassicFlowoptionalBooleanAllowClassicFlowoptionalboolAllowClassicFlowoptionalinterface{}#Enables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentitiesboolean | IResolvableallow_unauthenticated_identitiestyping.Union[bool, IResolvable]allowUnauthenticatedIdentitiesBooleanAllowUnauthenticatedIdentitiesboolAllowUnauthenticatedIdentitiesinterface{}required#Specifies whether the identity pool supports unauthenticated logins.
cognitoEventsoptionalanycognito_eventsoptionalAnycognitoEventsoptionalObjectCognitoEventsoptionalobjectCognitoEventsoptionalinterface{}#The events to configure.
cognitoIdentityProvidersoptionalIResolvable | IResolvable | CfnIdentityPool.CognitoIdentityProviderProperty[]cognito_identity_providersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CognitoIdentityProviderProperty]]]cognitoIdentityProvidersoptionalIResolvableCognitoIdentityProvidersoptionalIResolvableCognitoIdentityProvidersoptionalinterface{}#The Amazon Cognito user pools and their client IDs.
cognitoStreamsoptionalIResolvable | CfnIdentityPool.CognitoStreamsPropertycognito_streamsoptionaltyping.Union[IResolvable, CognitoStreamsProperty]cognitoStreamsoptionalIResolvableCognitoStreamsoptionalIResolvableCognitoStreamsoptionalinterface{}#Configuration options for configuring Amazon Cognito streams.
developerProviderNameoptionalstringdeveloper_provider_nameoptionalstrdeveloperProviderNameoptionalStringDeveloperProviderNameoptionalstringDeveloperProviderNameoptional*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
identityPoolNameoptionalstringidentity_pool_nameoptionalstridentityPoolNameoptionalStringIdentityPoolNameoptionalstringIdentityPoolNameoptional*string#The name of your Amazon Cognito identity pool.
Minimum length : 1
Maximum length : 128
Pattern : [\w\s+=,.@-]+
identityPoolTagsoptionalCfnTag[]identity_pool_tagsoptionaltyping.List[CfnTag]identityPoolTagsoptionalList<CfnTag>IdentityPoolTagsoptionalCfnTag[]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.
openIdConnectProviderArnsoptionalstring | IOIDCProviderRef[]open_id_connect_provider_arnsoptionaltyping.List[typing.Union[str, IOIDCProviderRef]]openIdConnectProviderArnsoptionalList<String>OpenIdConnectProviderArnsoptionalstring[]OpenIdConnectProviderArnsoptional*[]interface{}#The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSyncoptionalIResolvable | CfnIdentityPool.PushSyncPropertypush_syncoptionaltyping.Union[IResolvable, PushSyncProperty]pushSyncoptionalIResolvablePushSyncoptionalIResolvablePushSyncoptionalinterface{}#The configuration options to be applied to the identity pool.
samlProviderArnsoptionalstring[]saml_provider_arnsoptionaltyping.List[str]samlProviderArnsoptionalList<String>SamlProviderArnsoptionalstring[]SamlProviderArnsoptional*[]*string#The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supportedLoginProvidersoptionalanysupported_login_providersoptionalAnysupportedLoginProvidersoptionalObjectSupportedLoginProvidersoptionalobjectSupportedLoginProvidersoptionalinterface{}#Key-value pairs that map provider names to provider app IDs.