CfnIdentityPool

java.lang.Object
- 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:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.724Z")
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 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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnIdentityPool(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAllowClassicFlow()` Enables the Basic (Classic) authentication flow.
`java.lang.Object`	`getAllowUnauthenticatedIdentities()` Specifies whether the identity pool supports unauthenticated logins.
`java.lang.String`	`getAttrName()` The name of the Amazon Cognito identity pool, returned as a string.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getCognitoEvents()` The events to configure.
`java.lang.Object`	`getCognitoIdentityProviders()` The Amazon Cognito user pools and their client IDs.
`java.lang.Object`	`getCognitoStreams()` Configuration options for configuring Amazon Cognito streams.
`java.lang.String`	`getDeveloperProviderName()` The "domain" Amazon Cognito uses when referencing your users.
`java.lang.String`	`getIdentityPoolName()` The name of your Amazon Cognito identity pool.
`java.util.List<java.lang.String>`	`getOpenIdConnectProviderArns()` The Amazon Resource Names (ARNs) of the OpenID connect providers.
`java.lang.Object`	`getPushSync()` The configuration options to be applied to the identity pool.
`java.util.List<java.lang.String>`	`getSamlProviderArns()` The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAllowClassicFlow(java.lang.Boolean value)` Enables the Basic (Classic) authentication flow.
`void`	`setAllowClassicFlow(IResolvable value)` Enables the Basic (Classic) authentication flow.
`void`	`setAllowUnauthenticatedIdentities(java.lang.Boolean value)` Specifies whether the identity pool supports unauthenticated logins.
`void`	`setAllowUnauthenticatedIdentities(IResolvable value)` Specifies whether the identity pool supports unauthenticated logins.
`void`	`setCognitoEvents(java.lang.Object value)` The events to configure.
`void`	`setCognitoIdentityProviders(IResolvable value)` The Amazon Cognito user pools and their client IDs.
`void`	`setCognitoIdentityProviders(java.util.List<java.lang.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(java.lang.String value)` The "domain" Amazon Cognito uses when referencing your users.
`void`	`setIdentityPoolName(java.lang.String value)` The name of your Amazon Cognito identity pool.
`void`	`setOpenIdConnectProviderArns(java.util.List<java.lang.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(java.util.List<java.lang.String> value)` The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
`void`	`setSupportedLoginProviders(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnIdentityPool(Construct scope,
                       java.lang.String id,
                       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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrName
```
public java.lang.String getAttrName()
```
    The name of the Amazon Cognito identity pool, returned as a string.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getAllowUnauthenticatedIdentities
```
public java.lang.Object getAllowUnauthenticatedIdentities()
```
    Specifies whether the identity pool supports unauthenticated logins.
  - setAllowUnauthenticatedIdentities
```
public void setAllowUnauthenticatedIdentities(java.lang.Boolean value)
```
    Specifies whether the identity pool supports unauthenticated logins.
  - setAllowUnauthenticatedIdentities
```
public void setAllowUnauthenticatedIdentities(IResolvable value)
```
    Specifies whether the identity pool supports unauthenticated logins.
  - getCognitoEvents
```
public java.lang.Object getCognitoEvents()
```
    The events to configure.
  - setCognitoEvents
```
public void setCognitoEvents(java.lang.Object value)
```
    The events to configure.
  - getSupportedLoginProviders
```
public java.lang.Object getSupportedLoginProviders()
```
    Key-value pairs that map provider names to provider app IDs.
  - setSupportedLoginProviders
```
public void setSupportedLoginProviders(java.lang.Object value)
```
    Key-value pairs that map provider names to provider app IDs.
  - getAllowClassicFlow
```
public java.lang.Object getAllowClassicFlow()
```
    Enables the Basic (Classic) authentication flow.
  - setAllowClassicFlow
```
public void setAllowClassicFlow(java.lang.Boolean value)
```
    Enables the Basic (Classic) authentication flow.
  - setAllowClassicFlow
```
public void setAllowClassicFlow(IResolvable value)
```
    Enables the Basic (Classic) authentication flow.
  - getCognitoIdentityProviders
```
public java.lang.Object getCognitoIdentityProviders()
```
    The Amazon Cognito user pools and their client IDs.
  - setCognitoIdentityProviders
```
public void setCognitoIdentityProviders(IResolvable value)
```
    The Amazon Cognito user pools and their client IDs.
  - setCognitoIdentityProviders
```
public void setCognitoIdentityProviders(java.util.List<java.lang.Object> value)
```
    The Amazon Cognito user pools and their client IDs.
  - getCognitoStreams
```
public java.lang.Object getCognitoStreams()
```
    Configuration options for configuring Amazon Cognito streams.
  - setCognitoStreams
```
public void setCognitoStreams(IResolvable value)
```
    Configuration options for configuring Amazon Cognito streams.
  - setCognitoStreams
```
public void setCognitoStreams(CfnIdentityPool.CognitoStreamsProperty value)
```
    Configuration options for configuring Amazon Cognito streams.
  - getDeveloperProviderName
```
public 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
  - setDeveloperProviderName
```
public void setDeveloperProviderName(java.lang.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
```
public java.lang.String getIdentityPoolName()
```
    The name of your Amazon Cognito identity pool.
    Minimum length : 1
    Maximum length : 128
    Pattern : [\w\s+=,.@-]+
  - setIdentityPoolName
```
public void setIdentityPoolName(java.lang.String value)
```
    The name of your Amazon Cognito identity pool.
    Minimum length : 1
    Maximum length : 128
    Pattern : [\w\s+=,.@-]+
  - getOpenIdConnectProviderArns
```
public java.util.List<java.lang.String> getOpenIdConnectProviderArns()
```
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
  - setOpenIdConnectProviderArns
```
public void setOpenIdConnectProviderArns(java.util.List<java.lang.String> value)
```
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
  - getPushSync
```
public java.lang.Object getPushSync()
```
    The configuration options to be applied to the identity pool.
  - setPushSync
```
public void setPushSync(IResolvable value)
```
    The configuration options to be applied to the identity pool.
  - setPushSync
```
public void setPushSync(CfnIdentityPool.PushSyncProperty value)
```
    The configuration options to be applied to the identity pool.
  - getSamlProviderArns
```
public java.util.List<java.lang.String> getSamlProviderArns()
```
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
  - setSamlProviderArns
```
public void setSamlProviderArns(java.util.List<java.lang.String> value)
```
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

Class CfnIdentityPool

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnIdentityPool

CfnIdentityPool

CfnIdentityPool

Method Detail

inspect

renderProperties

getAttrName

getCfnProperties

getAllowUnauthenticatedIdentities

setAllowUnauthenticatedIdentities

setAllowUnauthenticatedIdentities

getCognitoEvents

setCognitoEvents

getSupportedLoginProviders

setSupportedLoginProviders

getAllowClassicFlow

setAllowClassicFlow

setAllowClassicFlow

getCognitoIdentityProviders

setCognitoIdentityProviders

setCognitoIdentityProviders

getCognitoStreams

setCognitoStreams

setCognitoStreams

getDeveloperProviderName

setDeveloperProviderName

getIdentityPoolName

setIdentityPoolName

getOpenIdConnectProviderArns

setOpenIdConnectProviderArns

getPushSync

setPushSync

setPushSync

getSamlProviderArns

setSamlProviderArns