Package software.amazon.awscdk.services.cognito

Interface UserPoolEmailConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolEmailConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:16.696Z")
@Stability(Stable)
public interface UserPoolEmailConfig
extends software.amazon.jsii.JsiiSerializable

Result of binding email settings with a 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.*;
 UserPoolEmailConfig userPoolEmailConfig = UserPoolEmailConfig.builder()
         .configurationSet("configurationSet")
         .emailSendingAccount("emailSendingAccount")
         .from("from")
         .replyToEmailAddress("replyToEmailAddress")
         .sourceArn("sourceArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolEmailConfig.Builder	builder()
default String	getConfigurationSet()	The name of the configuration set in SES.
default String	getEmailSendingAccount()	Specifies whether to use Cognito's built in email functionality or SES.
default String	getFrom()	Identifies either the sender's email address or the sender's name with their email address.
default String	getReplyToEmailAddress()	The destination to which the receiver of the email should reply to.
default String	getSourceArn()	The ARN of a verified email address in Amazon SES.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationSet

@Stability(Stable)
@Nullable
default String getConfigurationSet()

The name of the configuration set in SES.

Default: - none

getEmailSendingAccount

@Stability(Stable)
@Nullable
default String getEmailSendingAccount()

Specifies whether to use Cognito's built in email functionality or SES.

Default: - Cognito built in email functionality

getFrom

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

Identifies either the sender's email address or the sender's name with their email address.

If emailSendingAccount is DEVELOPER then this cannot be specified.

Default: 'no-reply@verificationemail.com'

getReplyToEmailAddress

@Stability(Stable)
@Nullable
default String getReplyToEmailAddress()

The destination to which the receiver of the email should reply to.

Default: - same as `from`

getSourceArn

@Stability(Stable)
@Nullable
default String getSourceArn()

The ARN of a verified email address in Amazon SES.

required if emailSendingAccount is DEVELOPER or if 'from' is provided.

Default: - none

builder

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

Returns:

a UserPoolEmailConfig.Builder of UserPoolEmailConfig