CfnUserPoolDomainProps Struct
Properties for defining a CfnUserPoolDomain.
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
customDomainConfigIResolvable | CfnUserPoolDomain.CustomDomainConfigTypePropertycustom_domain_configtyping.Union[IResolvable, CustomDomainConfigTypeProperty]customDomainConfigIResolvableCustomDomainConfigIResolvableCustomDomainConfiginterface{}#The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
notes
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.
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 .
managedLoginVersionnumbermanaged_login_versionint | floatmanagedLoginVersionNumberManagedLoginVersiondoubleManagedLoginVersion*float64#A version number that indicates the state of managed login for your domain.
notes
Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding editor. For more information, see Managed login .
routingIResolvable | CfnUserPoolDomain.RoutingTypePropertyroutingtyping.Union[IResolvable, RoutingTypeProperty]routingIResolvableRoutingIResolvableRoutinginterface{}#The ID of the user pool that is associated with the domain you're updating.