software.amazon.awscdk.services.cognito

Interface CustomDomainOptions

All Known Implementing Classes:

CustomDomainOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.846Z")
public interface CustomDomainOptions

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 and Description
static class	CustomDomainOptions.Builder A builder for CustomDomainOptions
static class	CustomDomainOptions.Jsii$Proxy An implementation for CustomDomainOptions

Method Summary

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

Method Detail

getCertificate

ICertificate getCertificate()

The certificate to associate with this domain.

getDomainName

java.lang.String getDomainName()

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

builder

static CustomDomainOptions.Builder builder()

Returns:

a CustomDomainOptions.Builder of CustomDomainOptions