UserPoolSESOptions

class aws_cdk.aws_cognito.UserPoolSESOptions(*, from_email, configuration_set_name=None, from_name=None, reply_to=None, ses_region=None, ses_verified_domain=None)

Bases: object

Configuration for Cognito sending emails via Amazon 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

ExampleMetadata

infused

Example:

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

Attributes

configuration_set_name

The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.

Default
  • no configuration set

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset

Return type

Optional[str]

from_email

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.

See

https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html

Return type

str

from_name

An optional name that should be used as the sender’s name along with the email.

Default
  • no name

Return type

Optional[str]

reply_to

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

Default
  • same as the fromEmail

Return type

Optional[str]

ses_region

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

Return type

Optional[str]

ses_verified_domain

SES Verified custom domain to be used to verify the identity.

Default
  • no domain

Return type

Optional[str]