L2 Construct

UserPoolDomain

Define a user pool domain.

Import

import { UserPoolDomain } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolDomain

Configuration passed to the constructor as UserPoolDomainProps.

userPoolRequired

IUserPoolRef

The user pool to which this domain should be associated.

3 properties inherited from UserPoolDomainOptions

cognitoDomainOptionalinherited from UserPoolDomainOptions

CognitoDomainOptions

Associate a cognito prefix domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

Default: - not set if `customDomain` is specified, otherwise, throws an error.

customDomainOptionalinherited from UserPoolDomainOptions

CustomDomainOptions

Associate a custom domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

Default: - not set if `cognitoDomain` is specified, otherwise, throws an error.

managedLoginVersionOptionalinherited from UserPoolDomainOptions

ManagedLoginVersion

A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain.

Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-cognito

Properties4