public static final class CfnUserPool.EmailConfigurationProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserPool.EmailConfigurationProperty
CfnUserPool.EmailConfigurationProperty
CfnUserPool.EmailConfigurationProperty.Builder, CfnUserPool.EmailConfigurationProperty.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getConfigurationSet()
The set of configuration rules that can be applied to emails sent using Amazon SES.
|
java.lang.String |
getEmailSendingAccount()
Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration.
|
java.lang.String |
getFrom()
Identifies either the sender's email address or the sender's name with their email address.
|
java.lang.String |
getReplyToEmailAddress()
The destination to which the receiver of the email should reply.
|
java.lang.String |
getSourceArn()
The ARN of a verified email address in Amazon SES.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.String getConfigurationSet()
CfnUserPool.EmailConfigurationProperty
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:
getConfigurationSet
in interface CfnUserPool.EmailConfigurationProperty
public final java.lang.String getEmailSendingAccount()
CfnUserPool.EmailConfigurationProperty
Specify one of the following values:
To look up the email delivery limit for the default option, see Limits in the Amazon Cognito 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 you to access Amazon SES and send email messages from your email 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 .
getEmailSendingAccount
in interface CfnUserPool.EmailConfigurationProperty
public final java.lang.String getFrom()
CfnUserPool.EmailConfigurationProperty
For example, testuser@example.com
or Test User <testuser@example.com>
. This address appears before the body of the email.
getFrom
in interface CfnUserPool.EmailConfigurationProperty
public final java.lang.String getReplyToEmailAddress()
CfnUserPool.EmailConfigurationProperty
getReplyToEmailAddress
in interface CfnUserPool.EmailConfigurationProperty
public final java.lang.String getSourceArn()
CfnUserPool.EmailConfigurationProperty
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 .
getSourceArn
in interface CfnUserPool.EmailConfigurationProperty
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()