- class aws_cdk.aws_cognito.UserPoolEmail
Configure how Cognito sends emails.
cognito.UserPool(self, "myuserpool", email=cognito.UserPoolEmail.with_sES( from_email="email@example.com", from_name="Awesome App", reply_to="firstname.lastname@example.org" ) )
- classmethod with_cognito(reply_to=None)
Send email using Cognito.
- Return type
- 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.
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.
str]) – The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito. Default: - no configuration set
str]) – An optional name that should be used as the sender’s name along with the email. Default: - no name
str]) – The destination to which the receiver of the email should reploy to. Default: - same as the fromEmail
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
str]) – SES Verified custom domain to be used to verify the identity. Default: - no domain
- Return type