Class CfnIdentityPool

A CloudFormation AWS::Cognito::IdentityPool.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnIdentityPool

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.AWS.Cognito.dll

Syntax (csharp)

public class CfnIdentityPool : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnIdentityPool
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

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

ExampleMetadata: infused

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

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

Synopsis

Constructors

CfnIdentityPool(Construct, String, ICfnIdentityPoolProps)	Create a new `AWS::Cognito::IdentityPool`.
CfnIdentityPool(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnIdentityPool(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AllowClassicFlow	Enables the Basic (Classic) authentication flow.
AllowUnauthenticatedIdentities	Specifies whether the identity pool supports unauthenticated logins.
AttrName	The name of the Amazon Cognito identity pool, returned as a string.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
CognitoEvents	The events to configure.
CognitoIdentityProviders	The Amazon Cognito user pools and their client IDs.
CognitoStreams	Configuration options for configuring Amazon Cognito streams.
DeveloperProviderName	The "domain" Amazon Cognito uses when referencing your users.
IdentityPoolName	The name of your Amazon Cognito identity pool.
OpenIdConnectProviderArns	The Amazon Resource Names (ARNs) of the OpenID connect providers.
PushSync	The configuration options to be applied to the identity pool.
SamlProviderArns	The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
SupportedLoginProviders	Key-value pairs that map provider names to provider app IDs.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

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 System.String

scoped id of the resource.

props ICfnIdentityPoolProps

resource properties.

CfnIdentityPool(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIdentityPool(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnIdentityPool(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIdentityPool(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AllowClassicFlow

Enables the Basic (Classic) authentication flow.

public virtual object AllowClassicFlow { get; set; }

Property Value

System.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

System.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

System.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

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

CognitoEvents

The events to configure.

public virtual object CognitoEvents { get; set; }

Property Value

System.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

System.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

System.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

System.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

System.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

System.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

System.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

System.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

System.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 System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable