Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.856Z") @Stability(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();

  • Method Details

    • getAllowUnauthenticatedIdentities

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

    • getAllowClassicFlow

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

    • getCognitoEvents

      @Stability(Stable) @Nullable default Object getCognitoEvents()
      The events to configure.

    • getCognitoIdentityProviders

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

    • getCognitoStreams

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

    • getDeveloperProviderName

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

      Minimum length : 1

      Maximum length : 128

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

    • getOpenIdConnectProviderArns

      @Stability(Stable) @Nullable default List<String> getOpenIdConnectProviderArns()
      The Amazon Resource Names (ARNs) of the OpenID connect providers.

    • getPushSync

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

    • getSamlProviderArns

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

    • getSupportedLoginProviders

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

    • builder

      @Stability(Stable) static CfnIdentityPoolProps.Builder builder()
      Returns:
      a CfnIdentityPoolProps.Builder of CfnIdentityPoolProps