aws-cdk-lib.aws_cognito.EmailSettings

EmailSettings Struct

Email settings for the user pool.

Source

aws-cognito/lib/user-pool.ts

Type last changed

v2.72.0 · 29 Mar 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const emailSettings: cognito.EmailSettings = {
  from: 'from',
  replyTo: 'replyTo',
};

Properties

fromstringfromstrfromStringFromstringFrom*string= noreply@verificationemail.com#

The 'from' address on the emails received by the user.

replyTostringreply_tostrreplyToStringReplyTostringReplyTo*string= Not set.#

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.