interface CustomDomainOptions

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

Options while specifying custom domain.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html

Example

const pool = new cognito.UserPool(this, 'Pool');

pool.addDomain('CognitoDomain', {
  cognitoDomain: {
    domainPrefix: 'my-awesome-app',
  },
});

const certificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d';

const domainCert = certificatemanager.Certificate.fromCertificateArn(this, 'domainCert', certificateArn);
pool.addDomain('CustomDomain', {
  customDomain: {
    domainName: 'user.myapp.com',
    certificate: domainCert,
  },
});

Properties

Name	Type	Description
certificate	ICertificate	The certificate to associate with this domain.
domainName	string	The custom domain name that you would like to associate with this User Pool.

---

certificate

Type: ICertificate

The certificate to associate with this domain.

---

domainName

Type: string

The custom domain name that you would like to associate with this User Pool.