Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Class CfnUserPoolDomainMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolDomainMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolDomainMixinProps>

Enclosing interface:

CfnUserPoolDomainMixinProps

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

A builder for CfnUserPoolDomainMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserPoolDomainMixinProps	build()	Builds the configured instance.
CfnUserPoolDomainMixinProps.Builder	customDomainConfig(CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty customDomainConfig)	Sets the value of CfnUserPoolDomainMixinProps.getCustomDomainConfig()
CfnUserPoolDomainMixinProps.Builder	customDomainConfig(IResolvable customDomainConfig)	Sets the value of CfnUserPoolDomainMixinProps.getCustomDomainConfig()
CfnUserPoolDomainMixinProps.Builder	domain(String domain)	Sets the value of CfnUserPoolDomainMixinProps.getDomain()
CfnUserPoolDomainMixinProps.Builder	managedLoginVersion(Number managedLoginVersion)	Sets the value of CfnUserPoolDomainMixinProps.getManagedLoginVersion()
CfnUserPoolDomainMixinProps.Builder	userPoolId(String userPoolId)	Sets the value of CfnUserPoolDomainMixinProps.getUserPoolId()

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

customDomainConfig

@Stability(Stable)
public CfnUserPoolDomainMixinProps.Builder customDomainConfig(IResolvable customDomainConfig)

Sets the value of CfnUserPoolDomainMixinProps.getCustomDomainConfig()

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

Returns:

this

customDomainConfig

@Stability(Stable)
public CfnUserPoolDomainMixinProps.Builder customDomainConfig(CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty customDomainConfig)

Sets the value of CfnUserPoolDomainMixinProps.getCustomDomainConfig()

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

Returns:

this

domain

@Stability(Stable)
public CfnUserPoolDomainMixinProps.Builder domain(String domain)

Sets the value of CfnUserPoolDomainMixinProps.getDomain()

Parameters:

domain - The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .

Returns:

this

managedLoginVersion

@Stability(Stable)
public CfnUserPoolDomainMixinProps.Builder managedLoginVersion(Number managedLoginVersion)

Sets the value of CfnUserPoolDomainMixinProps.getManagedLoginVersion()

Parameters:

managedLoginVersion - A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding editor. For more information, see Managed login .

Returns:

this

userPoolId

@Stability(Stable)
public CfnUserPoolDomainMixinProps.Builder userPoolId(String userPoolId)

Sets the value of CfnUserPoolDomainMixinProps.getUserPoolId()

Parameters:

userPoolId - The ID of the user pool that is associated with the domain you're updating.

Returns:

this

build

@Stability(Stable)
public CfnUserPoolDomainMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUserPoolDomainMixinProps

Throws:

NullPointerException - if any required attribute was not provided