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

Class CfnUserPoolDomainPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolDomainPropsMixin>

Enclosing class:

CfnUserPoolDomainPropsMixin

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

A fluent builder for CfnUserPoolDomainPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUserPoolDomainPropsMixin	build()
static CfnUserPoolDomainPropsMixin.Builder	create()
static CfnUserPoolDomainPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUserPoolDomainPropsMixin.Builder	customDomainConfig(CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
CfnUserPoolDomainPropsMixin.Builder	customDomainConfig(IResolvable customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
CfnUserPoolDomainPropsMixin.Builder	domain(String domain)	The name of the domain that you want to update.
CfnUserPoolDomainPropsMixin.Builder	managedLoginVersion(Number managedLoginVersion)	A version number that indicates the state of managed login for your domain.
CfnUserPoolDomainPropsMixin.Builder	userPoolId(String userPoolId)	The ID of the user pool that is associated with the domain you're updating.

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 CfnUserPoolDomainPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUserPoolDomainPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUserPoolDomainPropsMixin.Builder create()

Returns:

a new instance of CfnUserPoolDomainPropsMixin.Builder.

customDomainConfig

@Stability(Stable)
public CfnUserPoolDomainPropsMixin.Builder customDomainConfig(IResolvable 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.

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig

customDomainConfig

@Stability(Stable)
public CfnUserPoolDomainPropsMixin.Builder customDomainConfig(CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty 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.

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig

domain

@Stability(Stable)
public CfnUserPoolDomainPropsMixin.Builder domain(String 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 .

Parameters:

domain - The name of the domain that you want to update. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-domain

managedLoginVersion

@Stability(Stable)
public CfnUserPoolDomainPropsMixin.Builder managedLoginVersion(Number 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 .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-managedloginversion

userPoolId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-userpoolid

build

@Stability(Stable)
public CfnUserPoolDomainPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnUserPoolDomainPropsMixin.