interface CfnUserPoolDomainProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPoolDomainProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolDomainProps`
Java	`software.amazon.awscdk.services.cognito.CfnUserPoolDomainProps`
Python	`aws_cdk.aws_cognito.CfnUserPoolDomainProps`
TypeScript	`aws-cdk-lib` » `aws_cognito` » `CfnUserPoolDomainProps`

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 { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolDomainProps: cognito.CfnUserPoolDomainProps = {
  domain: 'domain',
  userPoolId: 'userPoolId',

  // the properties below are optional
  customDomainConfig: {
    certificateArn: 'certificateArn',
  },
  managedLoginVersion: 123,
};

Properties

Name	Type	Description
domain	`string`	The name of the domain that you want to update.
userPoolId	`string`	The ID of the user pool that is associated with the domain you're updating.
customDomainConfig?	`IResolvable` `\|` `CustomDomainConfigTypeProperty`	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
managedLoginVersion?	`number`	A version number that indicates the state of managed login for your domain.

domain

Type: string

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 .

userPoolId

Type: string

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

customDomainConfig?

Type: IResolvable | CustomDomainConfigTypeProperty (optional)

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.

managedLoginVersion?

Type: number (optional)

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 .