software.amazon.awscdk.services.cognito

Class CfnIdentityPool

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnIdentityPool

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.461Z")
 @Stability(value=Stable)
public class CfnIdentityPool
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::IdentityPool`.

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.

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	Class and Description
static class	CfnIdentityPool.Builder A fluent builder for CfnIdentityPool.
static interface	CfnIdentityPool.CognitoIdentityProviderProperty `CognitoIdentityProvider` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that represents an Amazon Cognito user pool and its client ID.
static interface	CfnIdentityPool.CognitoStreamsProperty `CognitoStreams` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines configuration options for Amazon Cognito streams.
static interface	CfnIdentityPool.PushSyncProperty `PushSync` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines the configuration options to be applied to an Amazon Cognito identity pool.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIdentityPool(Construct scope, String id, CfnIdentityPoolProps props) Create a new `AWS::Cognito::IdentityPool`.
protected	CfnIdentityPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIdentityPool(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAllowClassicFlow() Enables the Basic (Classic) authentication flow.
Object	getAllowUnauthenticatedIdentities() Specifies whether the identity pool supports unauthenticated logins.
String	getAttrName() The name of the Amazon Cognito identity pool, returned as a string.
protected Map<String,Object>	getCfnProperties()
Object	getCognitoEvents() The events to configure.
Object	getCognitoIdentityProviders() The Amazon Cognito user pools and their client IDs.
Object	getCognitoStreams() Configuration options for configuring Amazon Cognito streams.
String	getDeveloperProviderName() The "domain" Amazon Cognito uses when referencing your users.
String	getIdentityPoolName() The name of your Amazon Cognito identity pool.
List<String>	getOpenIdConnectProviderArns() The Amazon Resource Names (ARNs) of the OpenID connect providers.
Object	getPushSync() The configuration options to be applied to the identity pool.
List<String>	getSamlProviderArns() The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
Object	getSupportedLoginProviders() Key-value pairs that map provider names to provider app IDs.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowClassicFlow(Boolean value) Enables the Basic (Classic) authentication flow.
void	setAllowClassicFlow(IResolvable value) Enables the Basic (Classic) authentication flow.
void	setAllowUnauthenticatedIdentities(Boolean value) Specifies whether the identity pool supports unauthenticated logins.
void	setAllowUnauthenticatedIdentities(IResolvable value) Specifies whether the identity pool supports unauthenticated logins.
void	setCognitoEvents(Object value) The events to configure.
void	setCognitoIdentityProviders(IResolvable value) The Amazon Cognito user pools and their client IDs.
void	setCognitoIdentityProviders(List<Object> value) The Amazon Cognito user pools and their client IDs.
void	setCognitoStreams(CfnIdentityPool.CognitoStreamsProperty value) Configuration options for configuring Amazon Cognito streams.
void	setCognitoStreams(IResolvable value) Configuration options for configuring Amazon Cognito streams.
void	setDeveloperProviderName(String value) The "domain" Amazon Cognito uses when referencing your users.
void	setIdentityPoolName(String value) The name of your Amazon Cognito identity pool.
void	setOpenIdConnectProviderArns(List<String> value) The Amazon Resource Names (ARNs) of the OpenID connect providers.
void	setPushSync(CfnIdentityPool.PushSyncProperty value) The configuration options to be applied to the identity pool.
void	setPushSync(IResolvable value) The configuration options to be applied to the identity pool.
void	setSamlProviderArns(List<String> value) The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
void	setSupportedLoginProviders(Object value) Key-value pairs that map provider names to provider app IDs.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnIdentityPool

protected CfnIdentityPool(software.amazon.jsii.JsiiObjectRef objRef)

CfnIdentityPool

protected CfnIdentityPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIdentityPool

@Stability(value=Stable)
public CfnIdentityPool(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnIdentityPoolProps props)

Create a new `AWS::Cognito::IdentityPool`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the Amazon Cognito identity pool, returned as a string.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAllowUnauthenticatedIdentities

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

Specifies whether the identity pool supports unauthenticated logins.

setAllowUnauthenticatedIdentities

@Stability(value=Stable)
public void setAllowUnauthenticatedIdentities(@NotNull
                                                                       Boolean value)

Specifies whether the identity pool supports unauthenticated logins.

setAllowUnauthenticatedIdentities

@Stability(value=Stable)
public void setAllowUnauthenticatedIdentities(@NotNull
                                                                       IResolvable value)

Specifies whether the identity pool supports unauthenticated logins.

getCognitoEvents

@Stability(value=Stable)
 @NotNull
public Object getCognitoEvents()

The events to configure.

setCognitoEvents

@Stability(value=Stable)
public void setCognitoEvents(@NotNull
                                                      Object value)

The events to configure.

getSupportedLoginProviders

@Stability(value=Stable)
 @NotNull
public Object getSupportedLoginProviders()

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

setSupportedLoginProviders

@Stability(value=Stable)
public void setSupportedLoginProviders(@NotNull
                                                                Object value)

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

getAllowClassicFlow

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

Enables the Basic (Classic) authentication flow.

setAllowClassicFlow

@Stability(value=Stable)
public void setAllowClassicFlow(@Nullable
                                                         Boolean value)

Enables the Basic (Classic) authentication flow.

setAllowClassicFlow

@Stability(value=Stable)
public void setAllowClassicFlow(@Nullable
                                                         IResolvable value)

Enables the Basic (Classic) authentication flow.

getCognitoIdentityProviders

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

The Amazon Cognito user pools and their client IDs.

setCognitoIdentityProviders

@Stability(value=Stable)
public void setCognitoIdentityProviders(@Nullable
                                                                 IResolvable value)

The Amazon Cognito user pools and their client IDs.

setCognitoIdentityProviders

@Stability(value=Stable)
public void setCognitoIdentityProviders(@Nullable
                                                                 List<Object> value)

The Amazon Cognito user pools and their client IDs.

getCognitoStreams

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

Configuration options for configuring Amazon Cognito streams.

setCognitoStreams

@Stability(value=Stable)
public void setCognitoStreams(@Nullable
                                                       IResolvable value)

Configuration options for configuring Amazon Cognito streams.

setCognitoStreams

@Stability(value=Stable)
public void setCognitoStreams(@Nullable
                                                       CfnIdentityPool.CognitoStreamsProperty value)

Configuration options for configuring Amazon Cognito streams.

getDeveloperProviderName

@Stability(value=Stable)
 @Nullable
public 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

setDeveloperProviderName

@Stability(value=Stable)
public void setDeveloperProviderName(@Nullable
                                                              String value)

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
public String getIdentityPoolName()

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

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

setIdentityPoolName

@Stability(value=Stable)
public void setIdentityPoolName(@Nullable
                                                         String value)

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

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

getOpenIdConnectProviderArns

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

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

setOpenIdConnectProviderArns

@Stability(value=Stable)
public void setOpenIdConnectProviderArns(@Nullable
                                                                  List<String> value)

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

getPushSync

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

The configuration options to be applied to the identity pool.

setPushSync

@Stability(value=Stable)
public void setPushSync(@Nullable
                                                 IResolvable value)

The configuration options to be applied to the identity pool.

setPushSync

@Stability(value=Stable)
public void setPushSync(@Nullable
                                                 CfnIdentityPool.PushSyncProperty value)

The configuration options to be applied to the identity pool.

getSamlProviderArns

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

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

setSamlProviderArns

@Stability(value=Stable)
public void setSamlProviderArns(@Nullable
                                                         List<String> value)

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