software.amazon.awscdk.services.cognito

Interface UserPoolDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolDomainOptions

All Known Implementing Classes:

UserPoolDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.687Z")
 @Stability(value=Stable)
public interface UserPoolDomainProps
extends software.amazon.jsii.JsiiSerializable, UserPoolDomainOptions

Props for UserPoolDomain construct.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.cognito.*;
 Certificate certificate;
 UserPool userPool;
 UserPoolDomainProps userPoolDomainProps = UserPoolDomainProps.builder()
         .userPool(userPool)
         // the properties below are optional
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("domainPrefix")
                 .build())
         .customDomain(CustomDomainOptions.builder()
                 .certificate(certificate)
                 .domainName("domainName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UserPoolDomainProps.Builder	builder()
IUserPool	getUserPool() The user pool to which this domain should be associated.

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolDomainOptions

getCognitoDomain, getCustomDomain

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUserPool

@Stability(value=Stable)
 @NotNull
IUserPool getUserPool()

The user pool to which this domain should be associated.

builder

@Stability(value=Stable)
static UserPoolDomainProps.Builder builder()

Specified by:

builder in interface UserPoolDomainOptions

Returns:

a UserPoolDomainProps.Builder of UserPoolDomainProps