interface CfnIdentityPoolMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnIdentityPoolMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnIdentityPoolMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnIdentityPoolMixinProps`
Python	`aws_cdk.mixins_preview.aws_cognito.mixins.CfnIdentityPoolMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_cognito` » `mixins` » `CfnIdentityPoolMixinProps`

Properties for CfnIdentityPoolPropsMixin.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';

declare const cognitoEvents: any;
declare const supportedLoginProviders: any;
const cfnIdentityPoolMixinProps: cognito_mixins.CfnIdentityPoolMixinProps = {
  allowClassicFlow: false,
  allowUnauthenticatedIdentities: false,
  cognitoEvents: cognitoEvents,
  cognitoIdentityProviders: [{
    clientId: 'clientId',
    providerName: 'providerName',
    serverSideTokenCheck: false,
  }],
  cognitoStreams: {
    roleArn: 'roleArn',
    streamingStatus: 'streamingStatus',
    streamName: 'streamName',
  },
  developerProviderName: 'developerProviderName',
  identityPoolName: 'identityPoolName',
  identityPoolTags: [{
    key: 'key',
    value: 'value',
  }],
  openIdConnectProviderArns: ['openIdConnectProviderArns'],
  pushSync: {
    applicationArns: ['applicationArns'],
    roleArn: 'roleArn',
  },
  samlProviderArns: ['samlProviderArns'],
  supportedLoginProviders: supportedLoginProviders,
};

Properties

Name	Type	Description
allowClassicFlow?	`boolean \|` `IResolvable`	Enables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentities?	`boolean \|` `IResolvable`	Specifies whether the identity pool supports unauthenticated logins.
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.
identityPoolTags?	`CfnTag[]`	Tags to assign to the 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.

allowClassicFlow?

Type: boolean | IResolvable (optional)

Enables the Basic (Classic) authentication flow.

allowUnauthenticatedIdentities?

Type: boolean | IResolvable (optional)

Specifies whether the identity pool supports unauthenticated logins.

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+=,.@-]+

identityPoolTags?

Type: CfnTag[] (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 | PushSyncProperty (optional)

The configuration options to be applied to the identity pool.

samlProviderArns?