Class IdentityPoolProps.Builder
java.lang.Object
software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<IdentityPoolProps>
- Enclosing interface:
IdentityPoolProps
@Stability(Experimental)
public static final class IdentityPoolProps.Builder
extends Object
implements software.amazon.jsii.Builder<IdentityPoolProps>
A builder for
IdentityPoolProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowClassicFlow
(Boolean allowClassicFlow) Sets the value ofIdentityPoolProps.getAllowClassicFlow()
allowUnauthenticatedIdentities
(Boolean allowUnauthenticatedIdentities) Sets the value ofIdentityPoolProps.getAllowUnauthenticatedIdentities()
authenticatedRole
(IRole authenticatedRole) Sets the value ofIdentityPoolProps.getAuthenticatedRole()
authenticationProviders
(IdentityPoolAuthenticationProviders authenticationProviders) Sets the value ofIdentityPoolProps.getAuthenticationProviders()
build()
Builds the configured instance.identityPoolName
(String identityPoolName) Sets the value ofIdentityPoolProps.getIdentityPoolName()
roleMappings
(List<? extends IdentityPoolRoleMapping> roleMappings) Sets the value ofIdentityPoolProps.getRoleMappings()
unauthenticatedRole
(IRole unauthenticatedRole) Sets the value ofIdentityPoolProps.getUnauthenticatedRole()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowClassicFlow
@Stability(Experimental) public IdentityPoolProps.Builder allowClassicFlow(Boolean allowClassicFlow) Sets the value ofIdentityPoolProps.getAllowClassicFlow()
- Parameters:
allowClassicFlow
- Enables the Basic (Classic) authentication flow.- Returns:
this
-
allowUnauthenticatedIdentities
@Stability(Experimental) public IdentityPoolProps.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) Sets the value ofIdentityPoolProps.getAllowUnauthenticatedIdentities()
- Parameters:
allowUnauthenticatedIdentities
- Whether the Identity Pool supports unauthenticated logins.- Returns:
this
-
authenticatedRole
@Stability(Experimental) public IdentityPoolProps.Builder authenticatedRole(IRole authenticatedRole) Sets the value ofIdentityPoolProps.getAuthenticatedRole()
- Parameters:
authenticatedRole
- The default Role to be assumed by authenticated users.- Returns:
this
-
authenticationProviders
@Stability(Experimental) public IdentityPoolProps.Builder authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders) Sets the value ofIdentityPoolProps.getAuthenticationProviders()
- Parameters:
authenticationProviders
- Authentication Providers for using in Identity Pool.- Returns:
this
-
identityPoolName
Sets the value ofIdentityPoolProps.getIdentityPoolName()
- Parameters:
identityPoolName
- The name of the Identity Pool.- Returns:
this
-
roleMappings
@Stability(Experimental) public IdentityPoolProps.Builder roleMappings(List<? extends IdentityPoolRoleMapping> roleMappings) Sets the value ofIdentityPoolProps.getRoleMappings()
- Parameters:
roleMappings
- Rules for mapping roles to users.- Returns:
this
-
unauthenticatedRole
@Stability(Experimental) public IdentityPoolProps.Builder unauthenticatedRole(IRole unauthenticatedRole) Sets the value ofIdentityPoolProps.getUnauthenticatedRole()
- Parameters:
unauthenticatedRole
- The default Role to be assumed by unauthenticated users.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<IdentityPoolProps>
- Returns:
- a new instance of
IdentityPoolProps
- Throws:
NullPointerException
- if any required attribute was not provided
-