Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.538Z")
@Stability(Stable)
public interface CfnUserPoolDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolDomain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolDomainProps cfnUserPoolDomainProps = CfnUserPoolDomainProps.builder()
         .domain("domain")
         .userPoolId("userPoolId")
         // the properties below are optional
         .customDomainConfig(CustomDomainConfigTypeProperty.builder()
                 .certificateArn("certificateArn")
                 .build())
         .managedLoginVersion(123)
         .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	CfnUserPoolDomainProps.Builder	A builder for CfnUserPoolDomainProps
static final class	CfnUserPoolDomainProps.Jsii$Proxy	An implementation for CfnUserPoolDomainProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolDomainProps.Builder	builder()
default Object	getCustomDomainConfig()	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
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.
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

getDomain

@Stability(Stable)
@NotNull
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

getUserPoolId

@Stability(Stable)
@NotNull
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

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 CfnUserPoolDomain.CustomDomainConfigTypeProperty

See Also:

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

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

builder

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

Returns:

a CfnUserPoolDomainProps.Builder of CfnUserPoolDomainProps