public class EmailConfigurationType
extends java.lang.Object
implements java.io.Serializable
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.
| Constructor and Description |
|---|
EmailConfigurationType() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getConfigurationSet()
The set of configuration rules that can be applied to emails sent using
Amazon Simple Email Service.
|
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()
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 or an address from a verified domain
in Amazon SES.
|
int |
hashCode() |
void |
setConfigurationSet(java.lang.String configurationSet)
The set of configuration rules that can be applied to emails sent using
Amazon Simple Email Service.
|
void |
setEmailSendingAccount(EmailSendingAccountType 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.
|
void |
setEmailSendingAccount(java.lang.String 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.
|
void |
setFrom(java.lang.String from)
Either the sender’s email address or the sender’s name with their email
address.
|
void |
setReplyToEmailAddress(java.lang.String replyToEmailAddress)
The destination to which the receiver of the email should reply.
|
void |
setSourceArn(java.lang.String sourceArn)
The ARN of a verified email address or an address from a verified domain
in Amazon SES.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EmailConfigurationType |
withConfigurationSet(java.lang.String configurationSet)
The set of configuration rules that can be applied to emails sent using
Amazon Simple Email Service.
|
EmailConfigurationType |
withEmailSendingAccount(EmailSendingAccountType 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.
|
EmailConfigurationType |
withEmailSendingAccount(java.lang.String 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.
|
EmailConfigurationType |
withFrom(java.lang.String from)
Either the sender’s email address or the sender’s name with their email
address.
|
EmailConfigurationType |
withReplyToEmailAddress(java.lang.String replyToEmailAddress)
The destination to which the receiver of the email should reply.
|
EmailConfigurationType |
withSourceArn(java.lang.String sourceArn)
The ARN of a verified email address or an address from a verified domain
in Amazon SES.
|
public java.lang.String getSourceArn()
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:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this
address as the custom FROM address when it emails your users using its
built-in email account.
If you specify 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 Amazon Web Services 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.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
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:
If you specify COGNITO_DEFAULT, Amazon Cognito uses
this address as the custom FROM address when it emails your users
using its built-in email account.
If you specify 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 Amazon Web Services 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.
public void setSourceArn(java.lang.String sourceArn)
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:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this
address as the custom FROM address when it emails your users using its
built-in email account.
If you specify 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 Amazon Web Services 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.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
sourceArn -
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:
If you specify COGNITO_DEFAULT, Amazon Cognito
uses this address as the custom FROM address when it emails
your users using its built-in email account.
If you specify 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 Amazon Web Services 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.
public EmailConfigurationType withSourceArn(java.lang.String sourceArn)
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:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this
address as the custom FROM address when it emails your users using its
built-in email account.
If you specify 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 Amazon Web Services 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
sourceArn -
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:
If you specify COGNITO_DEFAULT, Amazon Cognito
uses this address as the custom FROM address when it emails
your users using its built-in email account.
If you specify 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 Amazon Web Services 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.
public java.lang.String getReplyToEmailAddress()
The destination to which the receiver of the email should reply.
Constraints:
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+
The destination to which the receiver of the email should reply.
public void setReplyToEmailAddress(java.lang.String replyToEmailAddress)
The destination to which the receiver of the email should reply.
Constraints:
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+
replyToEmailAddress - The destination to which the receiver of the email should reply.
public EmailConfigurationType withReplyToEmailAddress(java.lang.String replyToEmailAddress)
The destination to which the receiver of the email should reply.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+
replyToEmailAddress - The destination to which the receiver of the email should reply.
public 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. Specify one of the following values:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER
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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
EmailSendingAccountTypepublic void setEmailSendingAccount(java.lang.String 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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER
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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
EmailSendingAccountTypepublic EmailConfigurationType withEmailSendingAccount(java.lang.String 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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER
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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
EmailSendingAccountTypepublic void setEmailSendingAccount(EmailSendingAccountType 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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER
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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
EmailSendingAccountTypepublic EmailConfigurationType withEmailSendingAccount(EmailSendingAccountType 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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER
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:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
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.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
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 Amazon Web Services 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.
EmailSendingAccountTypepublic java.lang.String getFrom()
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.
Constraints:
Length: 0 - 131072
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.
public void setFrom(java.lang.String from)
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.
Constraints:
Length: 0 - 131072
from -
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.
public EmailConfigurationType withFrom(java.lang.String from)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 131072
from -
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.
public java.lang.String getConfigurationSet()
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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
public void setConfigurationSet(java.lang.String configurationSet)
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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
configurationSet - 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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
public EmailConfigurationType withConfigurationSet(java.lang.String configurationSet)
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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
configurationSet - 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:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object