Interface CfnIdentityPoolProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnIdentityPoolProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:13.250Z")
@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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIdentityPoolProps
static final class
An implementation forCfnIdentityPoolProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnIdentityPoolProps.Builder
builder()
default Object
Enables the Basic (Classic) authentication flow.Specifies whether the identity pool supports unauthenticated logins.default Object
The events to configure.default Object
The Amazon Cognito user pools and their client IDs.default Object
Configuration options for configuring Amazon Cognito streams.default String
The "domain" Amazon Cognito uses when referencing your users.default String
The name of your Amazon Cognito identity pool.Tags to assign to the identity pool.The Amazon Resource Names (ARNs) of the OpenID connect providers.default Object
The configuration options to be applied to the identity pool.The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.default Object
Key-value pairs that map provider names to provider app IDs.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllowUnauthenticatedIdentities
Specifies whether the identity pool supports unauthenticated logins.- See Also:
-
getAllowClassicFlow
Enables the Basic (Classic) authentication flow.- See Also:
-
getCognitoEvents
The events to configure.- See Also:
-
getCognitoIdentityProviders
The Amazon Cognito user pools and their client IDs.- See Also:
-
getCognitoStreams
Configuration options for configuring Amazon Cognito streams.- See Also:
-
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
- See Also:
-
getIdentityPoolName
The name of your Amazon Cognito identity pool.Minimum length : 1
Maximum length : 128
Pattern :
[\w\s+=,.@-]+
- See Also:
-
getIdentityPoolTags
Tags to assign to the identity pool.A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
- See Also:
-
getOpenIdConnectProviderArns
The Amazon Resource Names (ARNs) of the OpenID connect providers.- See Also:
-
getPushSync
The configuration options to be applied to the identity pool.- See Also:
-
getSamlProviderArns
The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.- See Also:
-
getSupportedLoginProviders
Key-value pairs that map provider names to provider app IDs.- See Also:
-
builder
- Returns:
- a
CfnIdentityPoolProps.Builder
ofCfnIdentityPoolProps
-