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

Interface CfnUserPoolDomainMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolDomainMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:40.279Z")
@Stability(Stable)
public interface CfnUserPoolDomainMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnUserPoolDomainPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 CfnUserPoolDomainMixinProps cfnUserPoolDomainMixinProps = CfnUserPoolDomainMixinProps.builder()
         .customDomainConfig(CustomDomainConfigTypeProperty.builder()
                 .certificateArn("certificateArn")
                 .build())
         .domain("domain")
         .managedLoginVersion(123)
         .routing(RoutingTypeProperty.builder()
                 .failover(FailoverTypeProperty.builder()
                         .primaryRoute53HealthCheckId("primaryRoute53HealthCheckId")
                         .secondaryRegion("secondaryRegion")
                         .build())
                 .build())
         .userPoolId("userPoolId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolDomainMixinProps.Builder	A builder for CfnUserPoolDomainMixinProps
static final class	CfnUserPoolDomainMixinProps.Jsii$Proxy	An implementation for CfnUserPoolDomainMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolDomainMixinProps.Builder	builder()
default Object	getCustomDomainConfig()	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
default String	getDomain()	The name of the domain that you want to update.
default Number	getManagedLoginVersion()	A version number that indicates the state of managed login for your domain.
default Object	getRouting()	Returns union: either IResolvable or CfnUserPoolDomainPropsMixin.RoutingTypeProperty
default String	getUserPoolId()	The ID of the user pool that is associated with the domain you're updating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomDomainConfig

@Stability(Stable)
@Nullable
default Object getCustomDomainConfig()

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 union: either IResolvable or CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty

See Also:

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

getDomain

@Stability(Stable)
@Nullable
default String getDomain()

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 .

See Also:

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

getManagedLoginVersion

@Stability(Stable)
@Nullable
default Number getManagedLoginVersion()

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 .

See Also:

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

getRouting

@Stability(Stable)
@Nullable
default Object getRouting()

Returns union: either IResolvable or CfnUserPoolDomainPropsMixin.RoutingTypeProperty

See Also:

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

getUserPoolId

@Stability(Stable)
@Nullable
default String getUserPoolId()

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

See Also:

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

builder

@Stability(Stable)
static CfnUserPoolDomainMixinProps.Builder builder()

Returns:

a CfnUserPoolDomainMixinProps.Builder of CfnUserPoolDomainMixinProps