software.amazon.awscdk.services.cognito

Class UserPoolEmail

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.UserPoolEmail

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.688Z")
 @Stability(value=Stable)
public abstract class UserPoolEmail
extends software.amazon.jsii.JsiiObject

Configure how Cognito sends emails.

Example:

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("Awesome App")
                 .replyTo("support@myawesomeapp.com")
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserPoolEmail()
protected	UserPoolEmail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolEmail(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static UserPoolEmail	withCognito() Send email using Cognito.
static UserPoolEmail	withCognito(String replyTo) Send email using Cognito.
static UserPoolEmail	withSES(UserPoolSESOptions options) Send email using SES.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UserPoolEmail

protected UserPoolEmail(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolEmail

protected UserPoolEmail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolEmail

@Stability(value=Stable)
protected UserPoolEmail()

Method Detail

withCognito

@Stability(value=Stable)
 @NotNull
public static UserPoolEmail withCognito(@Nullable
                                                                           String replyTo)

Send email using Cognito.

Parameters:

replyTo -

withCognito

@Stability(value=Stable)
 @NotNull
public static UserPoolEmail withCognito()

Send email using Cognito.

withSES

@Stability(value=Stable)
 @NotNull
public static UserPoolEmail withSES(@NotNull
                                                                       UserPoolSESOptions options)

Send email using SES.

Parameters:

options - This parameter is required.