aws-cdk-lib.aws_cognito.CustomDomainOptions

CustomDomainOptions Struct

Options while specifying custom domain.

Source

aws-cognito/lib/user-pool-domain.ts

Type last changed

v2.235.0 · 15 Jan 2026

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

certificateICertificateRefcertificateICertificateRefcertificateICertificateRefCertificateICertificateRefCertificateICertificateRefrequired#

The certificate to associate with this domain.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#

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