Package software.amazon.awscdk.services.cognito

Class UserPoolDomain.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolDomain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolDomain>

Enclosing class:

UserPoolDomain

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

A fluent builder for UserPoolDomain.

Method Summary

Modifier and Type	Method	Description
UserPoolDomain	build()
UserPoolDomain.Builder	cognitoDomain(CognitoDomainOptions cognitoDomain)	Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified.
static UserPoolDomain.Builder	create(software.constructs.Construct scope, String id)
UserPoolDomain.Builder	customDomain(CustomDomainOptions customDomain)	Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified.
UserPoolDomain.Builder	managedLoginVersion(ManagedLoginVersion managedLoginVersion)	A version that indicates the state of managed login.
UserPoolDomain.Builder	userPool(IUserPool userPool)	The user pool to which this domain should be associated.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static UserPoolDomain.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolDomain.Builder.

cognitoDomain

@Stability(Stable)
public UserPoolDomain.Builder cognitoDomain(CognitoDomainOptions cognitoDomain)

Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified.

Default: - not set if `customDomain` is specified, otherwise, throws an error.

Parameters:

cognitoDomain - Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html

customDomain

@Stability(Stable)
public UserPoolDomain.Builder customDomain(CustomDomainOptions customDomain)

Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified.

Default: - not set if `cognitoDomain` is specified, otherwise, throws an error.

Parameters:

customDomain - Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html

managedLoginVersion

@Stability(Stable)
public UserPoolDomain.Builder managedLoginVersion(ManagedLoginVersion managedLoginVersion)

A version that indicates the state of managed login.

This choice applies to all app clients that host services at the domain.

Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI

Parameters:

managedLoginVersion - A version that indicates the state of managed login. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html

userPool

@Stability(Stable)
public UserPoolDomain.Builder userPool(IUserPool userPool)

The user pool to which this domain should be associated.

Parameters:

userPool - The user pool to which this domain should be associated. This parameter is required.

Returns:

this

build

@Stability(Stable)
public UserPoolDomain build()

Specified by:

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

Returns:

a newly built instance of UserPoolDomain.