Package software.amazon.awscdk.services.cognito

Interface UserPoolDomainOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

UserPoolDomainProps

All Known Implementing Classes:

UserPoolDomainOptions.Jsii$Proxy, UserPoolDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.419Z")
@Stability(Stable)
public interface UserPoolDomainOptions
extends software.amazon.jsii.JsiiSerializable

Options to create a UserPoolDomain.

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());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolDomainOptions.Builder	builder()
default CognitoDomainOptions	getCognitoDomain()	Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified.
default CustomDomainOptions	getCustomDomain()	Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCognitoDomain

@Stability(Stable)
@Nullable
default CognitoDomainOptions getCognitoDomain()

Associate a cognito prefix domain with your user pool Either customDomain or cognitoDomain must be specified.

Default: - not set if `customDomain` is specified, otherwise, throws an error.

See Also:

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

getCustomDomain

@Stability(Stable)
@Nullable
default CustomDomainOptions getCustomDomain()

Associate a custom domain with your user pool Either customDomain or cognitoDomain must be specified.

Default: - not set if `cognitoDomain` is specified, otherwise, throws an error.

See Also:

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

builder

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

Returns:

a UserPoolDomainOptions.Builder of UserPoolDomainOptions