Class: Aws::CognitoIdentityProvider::Types::EmailConfigurationType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass EmailConfigurationType data as a hash:

{
  source_arn: "ArnType",
  reply_to_email_address: "EmailAddressType",
  email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
  from: "StringType",
  configuration_set: "SESConfigurationSet",
}

The email configuration type.

<note markdown=“1”> Amazon Cognito has specific Regions for use with Amazon Simple Email Service. For more information on the supported Regions, see [Email settings for Amazon Cognito user pools].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set ⇒ 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:

  • Event publishing – 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.

  • IP pool management – 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:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4804

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  SENSITIVE = []
  include Aws::Structure
end

#email_sending_account ⇒ String

Specifies whether Amazon Cognito emails your users by using its built-in email functionality or 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 ][1] in the <i> Developer Guide</i>.

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 EmailSendingAccount is COGNITO\_DEFAULT, you can't use the
following parameters:

* EmailVerificationMessage

* EmailVerificationSubject

* InviteMessageTemplate.EmailMessage

* InviteMessageTemplate.EmailSubject

* VerificationMessageTemplate.EmailMessage

* VerificationMessageTemplate.EmailMessageByLink

* VerificationMessageTemplate.EmailSubject,

* VerificationMessageTemplate.EmailSubjectByLink

<note markdown="1"> DEVELOPER EmailSendingAccount is required.

 </note>

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 Amazon Web
Services account.

If you use this option, you must 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 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][2] in
the *Amazon Cognito Developer Guide*.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/limits.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4804

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4804

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to_email_address ⇒ String

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

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4804

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

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.

Returns:

  • (String) 


4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4804

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  SENSITIVE = []
  include Aws::Structure
end