Interface IdentityPoolProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IdentityPoolProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:45.469Z")
@Stability(Experimental)
public interface IdentityPoolProps
extends software.amazon.jsii.JsiiSerializable
(experimental) Props for the IdentityPool construct.
Example:
OpenIdConnectProvider openIdConnectProvider; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .authenticationProviders(IdentityPoolAuthenticationProviders.builder() .google(IdentityPoolGoogleLoginProvider.builder() .clientId("12345678012.apps.googleusercontent.com") .build()) .openIdConnectProviders(List.of(openIdConnectProvider)) .customProvider("my-custom-provider.example.com") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forIdentityPoolProps
static final class
An implementation forIdentityPoolProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic IdentityPoolProps.Builder
builder()
default Boolean
(experimental) Enables the Basic (Classic) authentication flow.default Boolean
(experimental) Wwhether the identity pool supports unauthenticated logins.default IRole
(experimental) The Default Role to be assumed by Authenticated Users.(experimental) Authentication providers for using in identity pool.default String
(experimental) The name of the Identity Pool.default List<IdentityPoolRoleMapping>
(experimental) Rules for mapping roles to users.default IRole
(experimental) The Default Role to be assumed by Unauthenticated Users.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllowClassicFlow
(experimental) Enables the Basic (Classic) authentication flow.Default: - Classic Flow not allowed
-
getAllowUnauthenticatedIdentities
(experimental) Wwhether the identity pool supports unauthenticated logins.Default: - false
-
getAuthenticatedRole
(experimental) The Default Role to be assumed by Authenticated Users.Default: - A Default Authenticated Role will be added
-
getAuthenticationProviders
@Stability(Experimental) @Nullable default IdentityPoolAuthenticationProviders getAuthenticationProviders()(experimental) Authentication providers for using in identity pool.Default: - No Authentication Providers passed directly to Identity Pool
-
getIdentityPoolName
(experimental) The name of the Identity Pool.Default: - automatically generated name by CloudFormation at deploy time
-
getRoleMappings
(experimental) Rules for mapping roles to users.Default: - no Role Mappings
-
getUnauthenticatedRole
(experimental) The Default Role to be assumed by Unauthenticated Users.Default: - A Default Unauthenticated Role will be added
-
builder
- Returns:
- a
IdentityPoolProps.Builder
ofIdentityPoolProps
-