class CfnIdentityPoolPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Cognito.CfnIdentityPoolPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscognito#CfnIdentityPoolPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnIdentityPoolPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_cognito.CfnIdentityPoolPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_cognito » CfnIdentityPoolPropsMixin

Implements IMixin

Extends Mixin

The AWS::Cognito::IdentityPool resource creates an Amazon Cognito identity pool.

To avoid deleting the resource accidentally from CloudFormation , use DeletionPolicy Attribute and the UpdateReplacePolicy Attribute to retain the resource on deletion or replacement.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html

Example

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

declare const cognitoEvents: any;
declare const mergeStrategy: cdk.IMergeStrategy;
declare const supportedLoginProviders: any;
const cfnIdentityPoolPropsMixin = new cognito.CfnIdentityPoolPropsMixin({
  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,
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnIdentityPoolPropsMixin(props: CfnIdentityPoolMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnIdentityPoolMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Cognito::IdentityPool.

Properties

Name	Type	Description
props	CfnIdentityPoolMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnIdentityPoolMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.