UserPoolEmailConfiguration

data class UserPoolEmailConfiguration(val configurationSet: String? = null, val emailSendingAccount: String? = null, val from: String? = null, val replyToEmailAddress: String? = null, val sourceArn: String? = null)

Constructors

Link copied to clipboard
constructor(configurationSet: String? = null, emailSendingAccount: String? = null, from: String? = null, replyToEmailAddress: String? = null, sourceArn: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Link copied to clipboard

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

Link copied to clipboard
val from: String? = null

Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com> . This address appears before the body of the email.

Link copied to clipboard

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

Link copied to clipboard
val sourceArn: String? = null

The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter: