software.amazon.awscdk.services.cognito.identitypool

Class IdentityPool.Builder

java.lang.Object

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

Enclosing class:

IdentityPool

public static final class IdentityPool.Builder
extends java.lang.Object

(experimental) A fluent builder for IdentityPool.

Method Summary

Modifier and Type	Method and Description
IdentityPool.Builder	allowClassicFlow(java.lang.Boolean allowClassicFlow) (experimental) Enables the Basic (Classic) authentication flow.
IdentityPool.Builder	allowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities) (experimental) Wwhether the identity pool supports unauthenticated logins.
IdentityPool.Builder	authenticatedRole(IRole authenticatedRole) (experimental) The Default Role to be assumed by Authenticated Users.
IdentityPool.Builder	authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders) (experimental) Authentication providers for using in identity pool.
IdentityPool	build()
static IdentityPool.Builder	create(software.constructs.Construct scope, java.lang.String id)
IdentityPool.Builder	identityPoolName(java.lang.String identityPoolName) (experimental) The name of the Identity Pool.
IdentityPool.Builder	roleMappings(java.util.List<? extends IdentityPoolRoleMapping> roleMappings) (experimental) Rules for mapping roles to users.
IdentityPool.Builder	unauthenticatedRole(IRole unauthenticatedRole) (experimental) The Default Role to be assumed by Unauthenticated Users.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static IdentityPool.Builder create(software.constructs.Construct scope,
                                          java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of IdentityPool.Builder.

allowClassicFlow

public IdentityPool.Builder allowClassicFlow(java.lang.Boolean allowClassicFlow)

(experimental) Enables the Basic (Classic) authentication flow.

Default: - Classic Flow not allowed

Parameters:

allowClassicFlow - Enables the Basic (Classic) authentication flow. This parameter is required.

Returns:

this

allowUnauthenticatedIdentities

public IdentityPool.Builder allowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities)

(experimental) Wwhether the identity pool supports unauthenticated logins.

Default: - false

Parameters:

allowUnauthenticatedIdentities - Wwhether the identity pool supports unauthenticated logins. This parameter is required.

Returns:

this

authenticatedRole

public IdentityPool.Builder authenticatedRole(IRole authenticatedRole)

(experimental) The Default Role to be assumed by Authenticated Users.

Default: - A Default Authenticated Role will be added

Parameters:

authenticatedRole - The Default Role to be assumed by Authenticated Users. This parameter is required.

Returns:

this

authenticationProviders

public IdentityPool.Builder authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders)

(experimental) Authentication providers for using in identity pool.

Default: - No Authentication Providers passed directly to Identity Pool

Parameters:

authenticationProviders - Authentication providers for using in identity pool. This parameter is required.

Returns:

this

identityPoolName

public IdentityPool.Builder identityPoolName(java.lang.String identityPoolName)

(experimental) The name of the Identity Pool.

Default: - automatically generated name by CloudFormation at deploy time

Parameters:

identityPoolName - The name of the Identity Pool. This parameter is required.

Returns:

this

roleMappings

public IdentityPool.Builder roleMappings(java.util.List<? extends IdentityPoolRoleMapping> roleMappings)

(experimental) Rules for mapping roles to users.

Default: - no Role Mappings

Parameters:

roleMappings - Rules for mapping roles to users. This parameter is required.

Returns:

this

unauthenticatedRole

public IdentityPool.Builder unauthenticatedRole(IRole unauthenticatedRole)

(experimental) The Default Role to be assumed by Unauthenticated Users.

Default: - A Default Unauthenticated Role will be added

Parameters:

unauthenticatedRole - The Default Role to be assumed by Unauthenticated Users. This parameter is required.

Returns:

this

build

public IdentityPool build()