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

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

Overview

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.

<note markdown=“1”> 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].

</note>

This data type is a request parameter of [CreateUserPool], [UpdateUserPool], and [SetUserPoolMfaConfig], and a response parameter of [CreateUserPool], [UpdateUserPool], and [GetUserPoolMfaConfig].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html [5]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.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) 


5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5705

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 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][1] in the *Amazon Cognito Developer Guide*.

The default FROM address is `[email protected]`. To
customize the FROM address, provide the Amazon Resource Name (ARN)
of an Amazon SES verified email address for the `SourceArn`
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 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][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) 


5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5705

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, ‘[email protected]` or `Test User <[email protected]>`. This address appears before the body of the email.

Returns:

  • (String) 


5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5705

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) 


5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5705

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html

Returns:

  • (String) 


5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5705

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