Package software.amazon.awscdk.services.cognito

Interface CognitoDomainOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CognitoDomainOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.009Z")
@Stability(Stable)
public interface CognitoDomainOptions
extends software.amazon.jsii.JsiiSerializable

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainPrefix

@Stability(Stable)
@NotNull
String getDomainPrefix()

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

builder

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

Returns:

a CognitoDomainOptions.Builder of CognitoDomainOptions