public static final class CfnUserPool.EmailConfigurationProperty.Builder
extends java.lang.Object
CfnUserPool.EmailConfigurationProperty
Constructor and Description |
---|
Builder() |
public CfnUserPool.EmailConfigurationProperty.Builder configurationSet(java.lang.String configurationSet)
CfnUserPool.EmailConfigurationProperty.getConfigurationSet()
configurationSet
- The set of configuration rules that can be applied to emails sent using Amazon SES.
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:
this
public CfnUserPool.EmailConfigurationProperty.Builder emailSendingAccount(java.lang.String emailSendingAccount)
CfnUserPool.EmailConfigurationProperty.getEmailSendingAccount()
emailSendingAccount
- 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:
To look up the email delivery limit for the default option, see Limits in in the Developer Guide .
The default FROM address is no-reply@verificationemail.com
. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn
parameter.
If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn
parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role , which is a type of role, in your AWS account . This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide .
this
public CfnUserPool.EmailConfigurationProperty.Builder from(java.lang.String from)
CfnUserPool.EmailConfigurationProperty.getFrom()
from
- Identifies 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.this
public CfnUserPool.EmailConfigurationProperty.Builder replyToEmailAddress(java.lang.String replyToEmailAddress)
CfnUserPool.EmailConfigurationProperty.getReplyToEmailAddress()
replyToEmailAddress
- The destination to which the receiver of the email should reply.this
public CfnUserPool.EmailConfigurationProperty.Builder sourceArn(java.lang.String sourceArn)
CfnUserPool.EmailConfigurationProperty.getSourceArn()
sourceArn
- The ARN of a verified email address in Amazon SES.
Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount
parameter:
COGNITO_DEFAULT
, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.DEVELOPER
, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn
parameter must indicate a supported AWS Region of your user pool. Typically, the Region in the SourceArn
and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide .
this
public CfnUserPool.EmailConfigurationProperty build()
CfnUserPool.EmailConfigurationProperty
java.lang.NullPointerException
- if any required attribute was not provided