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.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.314Z")
 @Stability(value=Experimental)
public interface UserPoolDomainOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to create a UserPoolDomain.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UserPoolDomainOptions.Builder	builder()
default CognitoDomainOptions	getCognitoDomain() (experimental) Associate a cognito prefix domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.
default CustomDomainOptions	getCustomDomain() (experimental) 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 Detail

getCognitoDomain

@Stability(value=Experimental)
 @Nullable
default CognitoDomainOptions getCognitoDomain()

(experimental) 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(value=Experimental)
 @Nullable
default CustomDomainOptions getCustomDomain()

(experimental) 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(value=Experimental)
static UserPoolDomainOptions.Builder builder()

Returns:

a UserPoolDomainOptions.Builder of UserPoolDomainOptions