software.amazon.awscdk.services.cognito

Interface CognitoDomainOptions

All Known Implementing Classes:

CognitoDomainOptions.Jsii$Proxy

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

Options while specifying a cognito prefix 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-assign-domain-prefix.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CognitoDomainOptions.Builder	builder()
java.lang.String	getDomainPrefix() The prefix to the Cognito hosted domain name that will be associated with the user pool.

Method Detail

getDomainPrefix

java.lang.String getDomainPrefix()

The prefix to the Cognito hosted domain name that will be associated with the user pool.

builder

static CognitoDomainOptions.Builder builder()

Returns:

a CognitoDomainOptions.Builder of CognitoDomainOptions