Package software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:13.250Z")
@Stability(Stable)
public interface CfnIdentityPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIdentityPool.

Example:

 import software.amazon.awscdk.services.cognito.*;
 OpenIdConnectProvider myProvider;
 CfnIdentityPool.Builder.create(this, "IdentityPool")
         .openIdConnectProviderArns(List.of(myProvider.getOpenIdConnectProviderArn()))
         // And the other properties for your identity pool
         .allowUnauthenticatedIdentities(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentityPoolProps.Builder	A builder for CfnIdentityPoolProps
static final class	CfnIdentityPoolProps.Jsii$Proxy	An implementation for CfnIdentityPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnIdentityPoolProps.Builder	builder()
default Object	getAllowClassicFlow()	Enables the Basic (Classic) authentication flow.
Object	getAllowUnauthenticatedIdentities()	Specifies whether the identity pool supports unauthenticated logins.
default Object	getCognitoEvents()	The events to configure.
default Object	getCognitoIdentityProviders()	The Amazon Cognito user pools and their client IDs.
default Object	getCognitoStreams()	Configuration options for configuring Amazon Cognito streams.
default String	getDeveloperProviderName()	The "domain" Amazon Cognito uses when referencing your users.
default String	getIdentityPoolName()	The name of your Amazon Cognito identity pool.
default List<CfnTag>	getIdentityPoolTags()	Tags to assign to the identity pool.
default List<String>	getOpenIdConnectProviderArns()	The Amazon Resource Names (ARNs) of the OpenID connect providers.
default Object	getPushSync()	The configuration options to be applied to the identity pool.
default List<String>	getSamlProviderArns()	The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
default Object	getSupportedLoginProviders()	Key-value pairs that map provider names to provider app IDs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowUnauthenticatedIdentities

@Stability(Stable)
@NotNull
Object getAllowUnauthenticatedIdentities()

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

getAllowClassicFlow

@Stability(Stable)
@Nullable
default Object getAllowClassicFlow()

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

getCognitoEvents

@Stability(Stable)
@Nullable
default Object getCognitoEvents()

The events to configure.

See Also:

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

getCognitoIdentityProviders

@Stability(Stable)
@Nullable
default Object getCognitoIdentityProviders()

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

getCognitoStreams

@Stability(Stable)
@Nullable
default Object getCognitoStreams()

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

getDeveloperProviderName

@Stability(Stable)
@Nullable
default String getDeveloperProviderName()

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

getIdentityPoolName

@Stability(Stable)
@Nullable
default String getIdentityPoolName()

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

getIdentityPoolTags

@Stability(Stable)
@Nullable
default List<CfnTag> getIdentityPoolTags()

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

getOpenIdConnectProviderArns

@Stability(Stable)
@Nullable
default List<String> getOpenIdConnectProviderArns()

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

getPushSync

@Stability(Stable)
@Nullable
default Object getPushSync()

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

getSamlProviderArns

@Stability(Stable)
@Nullable
default List<String> getSamlProviderArns()

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

getSupportedLoginProviders

@Stability(Stable)
@Nullable
default Object getSupportedLoginProviders()

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

builder

@Stability(Stable)
static CfnIdentityPoolProps.Builder builder()

Returns:

a CfnIdentityPoolProps.Builder of CfnIdentityPoolProps