Class CfnUserPool.EmailConfigurationProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnUserPool.EmailConfigurationProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnUserPool.EmailConfigurationProperty
CfnUserPool.EmailConfigurationProperty
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPool.EmailConfigurationProperty
CfnUserPool.EmailConfigurationProperty.Builder, CfnUserPool.EmailConfigurationProperty.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnUserPool.EmailConfigurationProperty.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
The set of configuration rules that can be applied to emails sent using Amazon SES.final String
Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration.final String
getFrom()
Identifies either the sender's email address or the sender's name with their email address.final String
The destination to which the receiver of the email should reply.final String
The ARN of a verified email address in Amazon SES.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnUserPool.EmailConfigurationProperty.Builder
.
-
-
Method Details
-
getConfigurationSet
Description copied from interface:CfnUserPool.EmailConfigurationProperty
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:
- Event publishing – Amazon SES 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 AWS services such as SNS and CloudWatch.
- IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
- Specified by:
getConfigurationSet
in interfaceCfnUserPool.EmailConfigurationProperty
-
getEmailSendingAccount
Description copied from interface:CfnUserPool.EmailConfigurationProperty
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:
- COGNITO_DEFAULT - 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 theSourceArn
parameter.- DEVELOPER - 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 AWS 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 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 .
- Specified by:
getEmailSendingAccount
in interfaceCfnUserPool.EmailConfigurationProperty
-
getFrom
Description copied from interface:CfnUserPool.EmailConfigurationProperty
Identifies either the sender's email address or the sender's name with their email address.For example,
testuser@example.com
orTest User <testuser@example.com>
. This address appears before the body of the email.- Specified by:
getFrom
in interfaceCfnUserPool.EmailConfigurationProperty
-
getReplyToEmailAddress
Description copied from interface:CfnUserPool.EmailConfigurationProperty
The destination to which the receiver of the email should reply.- Specified by:
getReplyToEmailAddress
in interfaceCfnUserPool.EmailConfigurationProperty
-
getSourceArn
Description copied from interface:CfnUserPool.EmailConfigurationProperty
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:- 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 AWS Region of your user pool. Typically, the Region in theSourceArn
and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide .- Specified by:
getSourceArn
in interfaceCfnUserPool.EmailConfigurationProperty
- If you specify
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-