UserPoolEmail

class aws_cdk.aws_cognito.UserPoolEmail

Bases: object

Configure how Cognito sends emails.

ExampleMetadata

infused

Example:

cognito.UserPool(self, "myuserpool",
    email=cognito.UserPoolEmail.with_sES(
        from_email="noreply@myawesomeapp.com",
        from_name="Awesome App",
        reply_to="support@myawesomeapp.com"
    )
)

Static Methods

classmethod with_cognito(reply_to=None)

Send email using Cognito.

Parameters

reply_to (Optional[str]) –

Return type

UserPoolEmail

classmethod with_ses(*, from_email, configuration_set_name=None, from_name=None, reply_to=None, ses_region=None, ses_verified_domain=None)

Send email using SES.

Parameters
  • from_email (str) – The verified Amazon SES email address that Cognito should use to send emails. The email address used must be a verified email address in Amazon SES and must be configured to allow Cognito to send emails.

  • configuration_set_name (Optional[str]) – The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito. Default: - no configuration set

  • from_name (Optional[str]) – An optional name that should be used as the sender’s name along with the email. Default: - no name

  • reply_to (Optional[str]) – The destination to which the receiver of the email should reploy to. Default: - same as the fromEmail

  • ses_region (Optional[str]) – Required if the UserPool region is different than the SES region. If sending emails with a Amazon SES verified email address, and the region that SES is configured is different than the region in which the UserPool is deployed, you must specify that region here. Default: - The same region as the Cognito UserPool

  • ses_verified_domain (Optional[str]) – SES Verified custom domain to be used to verify the identity. Default: - no domain

Return type

UserPoolEmail