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.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.466Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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<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 Detail

getAllowUnauthenticatedIdentities

@Stability(value=Stable)
 @NotNull
Object getAllowUnauthenticatedIdentities()

Specifies whether the identity pool supports unauthenticated logins.

getAllowClassicFlow

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

Enables the Basic (Classic) authentication flow.

getCognitoEvents

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

The events to configure.

getCognitoIdentityProviders

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

The Amazon Cognito user pools and their client IDs.

getCognitoStreams

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

Configuration options for configuring Amazon Cognito streams.

getDeveloperProviderName

@Stability(value=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

getIdentityPoolName

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

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

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

getOpenIdConnectProviderArns

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

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

getPushSync

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

The configuration options to be applied to the identity pool.

getSamlProviderArns

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

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

getSupportedLoginProviders

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

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

builder

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

Returns:

a CfnIdentityPoolProps.Builder of CfnIdentityPoolProps