Interface ICfnIdentityPoolProps

Properties for defining a CfnIdentityPool.

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.AWS.Cognito.dll

Syntax (csharp)

public interface ICfnIdentityPoolProps

Syntax (vb)

Public Interface ICfnIdentityPoolProps

Remarks

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

ExampleMetadata: infused

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

Properties

AllowClassicFlow	Enables the Basic (Classic) authentication flow.
AllowUnauthenticatedIdentities	Specifies whether the identity pool supports unauthenticated logins.
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.

Properties

AllowClassicFlow

Enables the Basic (Classic) authentication flow.

virtual object AllowClassicFlow { get; }

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.

object AllowUnauthenticatedIdentities { get; }

Property Value

System.Object

Remarks

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

CognitoEvents

The events to configure.

virtual object CognitoEvents { get; }

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.

virtual object CognitoIdentityProviders { get; }

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.

virtual object CognitoStreams { get; }

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.

virtual string DeveloperProviderName { get; }

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.

virtual string IdentityPoolName { get; }

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.

virtual string[] OpenIdConnectProviderArns { get; }

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.

virtual object PushSync { get; }

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.

virtual string[] SamlProviderArns { get; }

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.

virtual object SupportedLoginProviders { get; }

Property Value

System.Object

Remarks

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