software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolProps

All Known Implementing Classes:

CfnIdentityPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.440Z")
public interface CfnIdentityPoolProps

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

Method Detail

getAllowUnauthenticatedIdentities

java.lang.Object getAllowUnauthenticatedIdentities()

Specifies whether the identity pool supports unauthenticated logins.

getAllowClassicFlow

default java.lang.Object getAllowClassicFlow()

Enables the Basic (Classic) authentication flow.

getCognitoEvents

default java.lang.Object getCognitoEvents()

The events to configure.

getCognitoIdentityProviders

default java.lang.Object getCognitoIdentityProviders()

The Amazon Cognito user pools and their client IDs.

getCognitoStreams

default java.lang.Object getCognitoStreams()

Configuration options for configuring Amazon Cognito streams.

getDeveloperProviderName

default java.lang.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

default java.lang.String getIdentityPoolName()

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

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

getOpenIdConnectProviderArns

default java.util.List<java.lang.String> getOpenIdConnectProviderArns()

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

getPushSync

default java.lang.Object getPushSync()

The configuration options to be applied to the identity pool.

getSamlProviderArns

default java.util.List<java.lang.String> getSamlProviderArns()

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

getSupportedLoginProviders

default java.lang.Object getSupportedLoginProviders()

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

builder

static CfnIdentityPoolProps.Builder builder()

Returns:

a CfnIdentityPoolProps.Builder of CfnIdentityPoolProps