cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/EmailConfigurationType

EmailConfigurationType

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.

Types

Builder

class Builder

Companion

object Companion

Properties

configurationSet

val configurationSet: String?

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:

emailSendingAccount

val emailSendingAccount: EmailSendingAccountType?

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:

from

val from: String?

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.

replyToEmailAddress

val replyToEmailAddress: String?

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

sourceArn

val sourceArn: String?

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:

Functions

copy

inline fun copy(block: EmailConfigurationType.Builder.() -> Unit = {}): EmailConfigurationType

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String