Package software.amazon.awscdk.services.cognito

Class UserPoolDomainProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolDomainProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolDomainProps>

Enclosing interface:

UserPoolDomainProps

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

A builder for UserPoolDomainProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolDomainProps	build()	Builds the configured instance.
UserPoolDomainProps.Builder	cognitoDomain(CognitoDomainOptions cognitoDomain)	Sets the value of UserPoolDomainOptions.getCognitoDomain()
UserPoolDomainProps.Builder	customDomain(CustomDomainOptions customDomain)	Sets the value of UserPoolDomainOptions.getCustomDomain()
UserPoolDomainProps.Builder	managedLoginVersion(ManagedLoginVersion managedLoginVersion)	Sets the value of UserPoolDomainOptions.getManagedLoginVersion()
UserPoolDomainProps.Builder	userPool(IUserPool userPool)	Sets the value of UserPoolDomainProps.getUserPool()

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

userPool

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

Sets the value of UserPoolDomainProps.getUserPool()

Parameters:

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

Returns:

this

cognitoDomain

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

Sets the value of UserPoolDomainOptions.getCognitoDomain()

Parameters:

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

Returns:

this

customDomain

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

Sets the value of UserPoolDomainOptions.getCustomDomain()

Parameters:

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

Returns:

this

managedLoginVersion

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

Sets the value of UserPoolDomainOptions.getManagedLoginVersion()

Parameters:

managedLoginVersion - A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain.

Returns:

this

build

@Stability(Stable)
public UserPoolDomainProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolDomainProps

Throws:

NullPointerException - if any required attribute was not provided