software.amazon.awscdk.services.cognito

Interface EmailSettings

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmailSettings.Jsii$Proxy

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

Email settings for the user pool.

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.cognito.*;
 EmailSettings emailSettings = EmailSettings.builder()
         .from("from")
         .replyTo("replyTo")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EmailSettings.Builder	builder()
default String	getFrom() The 'from' address on the emails received by the user.
default String	getReplyTo() The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFrom

@Stability(value=Stable)
 @Nullable
default String getFrom()

The 'from' address on the emails received by the user.

Default: noreply

getReplyTo

@Stability(value=Stable)
 @Nullable
default String getReplyTo()

The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.

When set, most email clients recognize to change 'to' line to this address when a reply is drafted.

Default: - Not set.

builder

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

Returns:

a EmailSettings.Builder of EmailSettings