Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.848Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIdentityPool

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

    • CfnIdentityPool

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

    • CfnIdentityPool

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrName()
      The name of the Amazon Cognito identity pool, returned as a string.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAllowUnauthenticatedIdentities

      @Stability(Stable) @NotNull public Object getAllowUnauthenticatedIdentities()
      Specifies whether the identity pool supports unauthenticated logins.

    • setAllowUnauthenticatedIdentities

      @Stability(Stable) public void setAllowUnauthenticatedIdentities(@NotNull Boolean value)
      Specifies whether the identity pool supports unauthenticated logins.

    • setAllowUnauthenticatedIdentities

      @Stability(Stable) public void setAllowUnauthenticatedIdentities(@NotNull IResolvable value)
      Specifies whether the identity pool supports unauthenticated logins.

    • getCognitoEvents

      @Stability(Stable) @NotNull public Object getCognitoEvents()
      The events to configure.

    • setCognitoEvents

      @Stability(Stable) public void setCognitoEvents(@NotNull Object value)
      The events to configure.

    • getSupportedLoginProviders

      @Stability(Stable) @NotNull public Object getSupportedLoginProviders()
      Key-value pairs that map provider names to provider app IDs.

    • setSupportedLoginProviders

      @Stability(Stable) public void setSupportedLoginProviders(@NotNull Object value)
      Key-value pairs that map provider names to provider app IDs.

    • getAllowClassicFlow

      @Stability(Stable) @Nullable public Object getAllowClassicFlow()
      Enables the Basic (Classic) authentication flow.

    • setAllowClassicFlow

      @Stability(Stable) public void setAllowClassicFlow(@Nullable Boolean value)
      Enables the Basic (Classic) authentication flow.

    • setAllowClassicFlow

      @Stability(Stable) public void setAllowClassicFlow(@Nullable IResolvable value)
      Enables the Basic (Classic) authentication flow.

    • getCognitoIdentityProviders

      @Stability(Stable) @Nullable public Object getCognitoIdentityProviders()
      The Amazon Cognito user pools and their client IDs.

    • setCognitoIdentityProviders

      @Stability(Stable) public void setCognitoIdentityProviders(@Nullable IResolvable value)
      The Amazon Cognito user pools and their client IDs.

    • setCognitoIdentityProviders

      @Stability(Stable) public void setCognitoIdentityProviders(@Nullable List<Object> value)
      The Amazon Cognito user pools and their client IDs.

    • getCognitoStreams

      @Stability(Stable) @Nullable public Object getCognitoStreams()
      Configuration options for configuring Amazon Cognito streams.

    • setCognitoStreams

      @Stability(Stable) public void setCognitoStreams(@Nullable IResolvable value)
      Configuration options for configuring Amazon Cognito streams.

    • setCognitoStreams

      @Stability(Stable) public void setCognitoStreams(@Nullable CfnIdentityPool.CognitoStreamsProperty value)
      Configuration options for configuring Amazon Cognito streams.

    • getDeveloperProviderName

      @Stability(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(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(Stable) @Nullable public String getIdentityPoolName()
      The name of your Amazon Cognito identity pool.

      Minimum length : 1

      Maximum length : 128

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

    • setIdentityPoolName

      @Stability(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(Stable) @Nullable public List<String> getOpenIdConnectProviderArns()
      The Amazon Resource Names (ARNs) of the OpenID connect providers.

    • setOpenIdConnectProviderArns

      @Stability(Stable) public void setOpenIdConnectProviderArns(@Nullable List<String> value)
      The Amazon Resource Names (ARNs) of the OpenID connect providers.

    • getPushSync

      @Stability(Stable) @Nullable public Object getPushSync()
      The configuration options to be applied to the identity pool.

    • setPushSync

      @Stability(Stable) public void setPushSync(@Nullable IResolvable value)
      The configuration options to be applied to the identity pool.

    • setPushSync

      @Stability(Stable) public void setPushSync(@Nullable CfnIdentityPool.PushSyncProperty value)
      The configuration options to be applied to the identity pool.

    • getSamlProviderArns

      @Stability(Stable) @Nullable public List<String> getSamlProviderArns()
      The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

    • setSamlProviderArns

      @Stability(Stable) public void setSamlProviderArns(@Nullable List<String> value)
      The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.