EmailSettings

class aws_cdk.aws_cognito.EmailSettings(*, from_=None, reply_to=None)

Bases: object

Email settings for the user pool.

Parameters:
  • from – The ‘from’ address on the emails received by the user. Default: noreply@verificationemail.com

  • reply_to (Optional[str]) – The ‘replyTo’ address on the emails received by the user as defined by IETF RFC-5322. When set, most email clients recognize to change ‘to’ line to this address when a reply is drafted. Default: - Not set.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

email_settings = cognito.EmailSettings(
    from="from",
    reply_to="replyTo"
)

Attributes

from_

The ‘from’ address on the emails received by the user.

Default:

noreply@verificationemail.com

reply_to

The ‘replyTo’ address on the emails received by the user as defined by IETF RFC-5322.

When set, most email clients recognize to change ‘to’ line to this address when a reply is drafted.

Default:
  • Not set.