class CfnIdentityPool (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnIdentityPool
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnIdentityPool
Java	software.amazon.awscdk.services.cognito.CfnIdentityPool
Python	aws_cdk.aws_cognito.CfnIdentityPool
TypeScript	aws-cdk-lib » aws_cognito » CfnIdentityPool

Implements IConstruct, IDependable, IInspectable, IIdentityPoolRef, ITaggableV2

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

To avoid deleting the resource accidentally from AWS 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

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,
});

Initializer

new CfnIdentityPool(scope: Construct, id: string, props: CfnIdentityPoolProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnIdentityPoolProps — Resource properties.

Construct Props

Name	Type	Description
allowUnauthenticatedIdentities	boolean | IResolvable	Specifies whether the identity pool supports unauthenticated logins.
allowClassicFlow?	boolean | IResolvable	Enables the Basic (Classic) authentication flow.
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.

---

allowUnauthenticatedIdentities

Type: boolean | IResolvable

Specifies whether the identity pool supports unauthenticated logins.

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

---

allowClassicFlow?

Type: boolean | IResolvable (optional)

Enables the Basic (Classic) authentication flow.

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

---

cognitoEvents?

Type: any (optional)

The events to configure.

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

---

cognitoIdentityProviders?

Type: IResolvable | (IResolvable | CognitoIdentityProviderProperty)[] (optional)

The Amazon Cognito user pools and their client IDs.

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

---

cognitoStreams?

Type: IResolvable | CognitoStreamsProperty (optional)

Configuration options for configuring Amazon Cognito streams.

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

---

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

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

---

identityPoolName?

Type: string (optional)

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

Pattern : [\w\s+=,.@-]+

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

---

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.

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

---

openIdConnectProviderArns?

Type: string[] (optional)

The Amazon Resource Names (ARNs) of the OpenID connect providers.

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

---

pushSync?

Type: IResolvable | PushSyncProperty (optional)

The configuration options to be applied to the identity pool.

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

---

samlProviderArns?

Type: string[] (optional)

The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

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

---

supportedLoginProviders?

Type: any (optional)

Key-value pairs that map provider names to provider app IDs.

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

Properties

Name	Type	Description
allowUnauthenticatedIdentities	boolean | IResolvable	Specifies whether the identity pool supports unauthenticated logins.
attrId	string
attrName	string	The name of the Amazon Cognito identity pool, returned as a string.
cdkTagManager	TagManager	Tag Manager which manages the tags for this resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
identityPoolRef	IdentityPoolReference	A reference to a IdentityPool resource.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
allowClassicFlow?	boolean | IResolvable	Enables the Basic (Classic) authentication flow.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

allowUnauthenticatedIdentities

Type: boolean | IResolvable

Specifies whether the identity pool supports unauthenticated logins.

---

attrId

Type: string

---

attrName

Type: string

The name of the Amazon Cognito identity pool, returned as a string.

---

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

identityPoolRef

Type: IdentityPoolReference

A reference to a IdentityPool resource.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

allowClassicFlow?

Type: boolean | IResolvable (optional)

Enables the Basic (Classic) authentication flow.

---

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.

---

identityPoolName?

Type: string (optional)

The name of your Amazon Cognito identity pool.

---

identityPoolTags?

Type: CfnTag[] (optional)

Tags to assign to the identity pool.

---

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?

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.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)
static fromIdentityPoolId(scope, id, identityPoolId)	Creates a new IIdentityPoolRef from a identityPoolId.

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): (Stack | CfnResource)[]

Returns

• (Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }

---

static fromIdentityPoolId(scope, id, identityPoolId)

public static fromIdentityPoolId(scope: Construct, id: string, identityPoolId: string): IIdentityPoolRef

Parameters

• scope Construct
• id string
• identityPoolId string

Returns

• IIdentityPoolRef

Creates a new IIdentityPoolRef from a identityPoolId.