Package software.amazon.awscdk.services.cognito

Interface CustomDomainOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomDomainOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:48.109Z")
@Stability(Stable)
public interface CustomDomainOptions
extends software.amazon.jsii.JsiiSerializable

Options while specifying custom domain.

Example:

 UserPool pool = new UserPool(this, "Pool");
 pool.addDomain("CognitoDomain", UserPoolDomainOptions.builder()
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("my-awesome-app")
                 .build())
         .build());
 String certificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d";
 ICertificate domainCert = Certificate.fromCertificateArn(this, "domainCert", certificateArn);
 pool.addDomain("CustomDomain", UserPoolDomainOptions.builder()
         .customDomain(CustomDomainOptions.builder()
                 .domainName("user.myapp.com")
                 .certificate(domainCert)
                 .build())
         .build());
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomDomainOptions.Builder	A builder for CustomDomainOptions
static final class	CustomDomainOptions.Jsii$Proxy	An implementation for CustomDomainOptions

Method Summary

Modifier and Type	Method	Description
static CustomDomainOptions.Builder	builder()
ICertificate	getCertificate()	The certificate to associate with this domain.
String	getDomainName()	The custom domain name that you would like to associate with this User Pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificate

@Stability(Stable)
@NotNull
ICertificate getCertificate()

The certificate to associate with this domain.

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

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

builder

@Stability(Stable)
static CustomDomainOptions.Builder builder()

Returns:

a CustomDomainOptions.Builder of CustomDomainOptions