Package software.amazon.awscdk.services.cognito.identitypool

Class IdentityPoolProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.identitypool.IdentityPoolProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IdentityPoolProps>

Enclosing interface:

IdentityPoolProps

@Stability(Stable)
public static final class IdentityPoolProps.Builder
extends Object
implements software.amazon.jsii.Builder<IdentityPoolProps>

A builder for IdentityPoolProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IdentityPoolProps.Builder	allowClassicFlow(Boolean allowClassicFlow)	Sets the value of IdentityPoolProps.getAllowClassicFlow()
IdentityPoolProps.Builder	allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)	Sets the value of IdentityPoolProps.getAllowUnauthenticatedIdentities()
IdentityPoolProps.Builder	authenticatedRole(IRole authenticatedRole)	Sets the value of IdentityPoolProps.getAuthenticatedRole()
IdentityPoolProps.Builder	authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders)	Sets the value of IdentityPoolProps.getAuthenticationProviders()
IdentityPoolProps	build()	Builds the configured instance.
IdentityPoolProps.Builder	identityPoolName(String identityPoolName)	Sets the value of IdentityPoolProps.getIdentityPoolName()
IdentityPoolProps.Builder	roleMappings(List<? extends IdentityPoolRoleMapping> roleMappings)	Sets the value of IdentityPoolProps.getRoleMappings()
IdentityPoolProps.Builder	unauthenticatedRole(IRole unauthenticatedRole)	Sets the value of IdentityPoolProps.getUnauthenticatedRole()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

allowClassicFlow

@Stability(Stable)
public IdentityPoolProps.Builder allowClassicFlow(Boolean allowClassicFlow)

Sets the value of IdentityPoolProps.getAllowClassicFlow()

Parameters:

allowClassicFlow - Enables the Basic (Classic) authentication flow.

Returns:

this

allowUnauthenticatedIdentities

@Stability(Stable)
public IdentityPoolProps.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

Sets the value of IdentityPoolProps.getAllowUnauthenticatedIdentities()

Parameters:

allowUnauthenticatedIdentities - Whether the Identity Pool supports unauthenticated logins.

Returns:

this

authenticatedRole

@Stability(Stable)
public IdentityPoolProps.Builder authenticatedRole(IRole authenticatedRole)

Sets the value of IdentityPoolProps.getAuthenticatedRole()

Parameters:

authenticatedRole - The default Role to be assumed by authenticated users.

Returns:

this

authenticationProviders

@Stability(Stable)
public IdentityPoolProps.Builder authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders)

Sets the value of IdentityPoolProps.getAuthenticationProviders()

Parameters:

authenticationProviders - Authentication Providers for using in Identity Pool.

Returns:

this

identityPoolName

@Stability(Stable)
public IdentityPoolProps.Builder identityPoolName(String identityPoolName)

Sets the value of IdentityPoolProps.getIdentityPoolName()

Parameters:

identityPoolName - The name of the Identity Pool.

Returns:

this

roleMappings

@Stability(Stable)
public IdentityPoolProps.Builder roleMappings(List<? extends IdentityPoolRoleMapping> roleMappings)

Sets the value of IdentityPoolProps.getRoleMappings()

Parameters:

roleMappings - Rules for mapping roles to users.

Returns:

this

unauthenticatedRole

@Stability(Stable)
public IdentityPoolProps.Builder unauthenticatedRole(IRole unauthenticatedRole)

Sets the value of IdentityPoolProps.getUnauthenticatedRole()

Parameters:

unauthenticatedRole - The default Role to be assumed by unauthenticated users.

Returns:

this

build

@Stability(Stable)
public IdentityPoolProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<IdentityPoolProps>

Returns:

a new instance of IdentityPoolProps

Throws:

NullPointerException - if any required attribute was not provided