Package software.amazon.awscdk.services.cognito

Class CfnUserPoolDomain.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolDomain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolDomain>

Enclosing class:

CfnUserPoolDomain

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

A fluent builder for CfnUserPoolDomain.

Method Summary

Modifier and Type	Method	Description
CfnUserPoolDomain	build()
static CfnUserPoolDomain.Builder	create(software.constructs.Construct scope, String id)
CfnUserPoolDomain.Builder	customDomainConfig(IResolvable customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
CfnUserPoolDomain.Builder	customDomainConfig(CfnUserPoolDomain.CustomDomainConfigTypeProperty customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
CfnUserPoolDomain.Builder	domain(String domain)	The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
CfnUserPoolDomain.Builder	managedLoginVersion(Number managedLoginVersion)	A version number that indicates the state of managed login for your domain.
CfnUserPoolDomain.Builder	userPoolId(String userPoolId)	The ID of the user pool that is associated with the custom domain whose certificate 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 CfnUserPoolDomain.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUserPoolDomain.Builder.

domain

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

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.

One example might be auth.example.com .

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

Parameters:

domain - The domain name for the 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-domain

userPoolId

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

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

Parameters:

userPoolId - The ID of the user pool that is associated with the custom domain whose certificate 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

customDomainConfig

@Stability(Stable)
public CfnUserPoolDomain.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. Update the RP ID in a SetUserPoolMfaConfig request.

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 CfnUserPoolDomain.Builder customDomainConfig(CfnUserPoolDomain.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. Update the RP ID in a SetUserPoolMfaConfig request.

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

managedLoginVersion

@Stability(Stable)
public CfnUserPoolDomain.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 designer. 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

build

@Stability(Stable)
public CfnUserPoolDomain build()

Specified by:

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

Returns:

a newly built instance of CfnUserPoolDomain.