# CfnUserPoolDomainProps

Properties for defining a `CfnUserPoolDomain`.

Extends: CfnUserPoolDomainProps
Used as props by: CfnUserPoolDomain

- Source: Generated code
- Type last changed: v2.261.0 · 2 Jul 2026

## Example

```ts
// 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',
    securityPolicy: 'securityPolicy',
  },
  managedLoginVersion: 123,
  routing: {
    failover: {
      primaryRoute53HealthCheckId: 'primaryRoute53HealthCheckId',
      secondaryRegion: 'secondaryRegion',
    },
  },
};
```

## Properties

- `customDomainConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPoolDomain.CustomDomainConfigTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolDomain.CustomDomainConfigTypeProperty.html) — 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.

- `domain`: string (required) — 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` .

- `managedLoginVersion`: number — 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) .

- `routing`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPoolDomain.RoutingTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolDomain.RoutingTypeProperty.html)

- `userPoolId`: string (required) — The ID of the user pool that is associated with the domain you're updating.