Class CfnIdentityPool

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::IdentityPool.

public class CfnIdentityPool : CfnResource, IInspectable

Inheritance

object

CfnIdentityPool

Implements

IInspectable

Examples

using Amazon.CDK.AWS.Cognito;

             OpenIdConnectProvider myProvider;

             new CfnIdentityPool(this, "IdentityPool", new CfnIdentityPoolProps {
                 OpenIdConnectProviderArns = new [] { myProvider.OpenIdConnectProviderArn },
                 // And the other properties for your identity pool
                 AllowUnauthenticatedIdentities = false
             });

Remarks

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.

CloudformationResource: AWS::Cognito::IdentityPool

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

ExampleMetadata: infused

Constructors

CfnIdentityPool(Construct, string, ICfnIdentityPoolProps)

Create a new AWS::Cognito::IdentityPool.

public CfnIdentityPool(Construct scope, string id, ICfnIdentityPoolProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnIdentityPoolProps

• resource properties.

Properties

AllowClassicFlow

Enables the Basic (Classic) authentication flow.

public virtual object? AllowClassicFlow { get; set; }

Property Value

object

Remarks

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

AllowUnauthenticatedIdentities

Specifies whether the identity pool supports unauthenticated logins.

public virtual object AllowUnauthenticatedIdentities { get; set; }

Property Value

object

Remarks

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

AttrName

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

public virtual string AttrName { get; }

Property Value

string

Remarks

CloudformationAttribute: Name

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

CognitoEvents

The events to configure.

public virtual object CognitoEvents { get; set; }

Property Value

object

Remarks

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

CognitoIdentityProviders

The Amazon Cognito user pools and their client IDs.

public virtual object? CognitoIdentityProviders { get; set; }

Property Value

object

Remarks

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

CognitoStreams

Configuration options for configuring Amazon Cognito streams.

public virtual object? CognitoStreams { get; set; }

Property Value

object

Remarks

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

DeveloperProviderName

The "domain" Amazon Cognito uses when referencing your users.

public virtual string? DeveloperProviderName { get; set; }

Property Value

string

Remarks

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

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

IdentityPoolName

The name of your Amazon Cognito identity pool.

public virtual string? IdentityPoolName { get; set; }

Property Value

string

Remarks

Minimum length : 1

Maximum length : 128

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

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

OpenIdConnectProviderArns

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

public virtual string[]? OpenIdConnectProviderArns { get; set; }

Property Value

string[]

Remarks

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

PushSync

The configuration options to be applied to the identity pool.

public virtual object? PushSync { get; set; }

Property Value

object

Remarks

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

SamlProviderArns

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

public virtual string[]? SamlProviderArns { get; set; }

Property Value

string[]

Remarks

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

SupportedLoginProviders

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

public virtual object SupportedLoginProviders { get; set; }

Property Value

object

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>