aws-cdk-lib.aws_cognito.EmailSettings

interface EmailSettings

LanguageType name
.NETAmazon.CDK.AWS.Cognito.EmailSettings
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#EmailSettings
Javasoftware.amazon.awscdk.services.cognito.EmailSettings
Pythonaws_cdk.aws_cognito.EmailSettings
TypeScript (source)aws-cdk-lib » aws_cognito » EmailSettings

Email settings for the user pool.

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

NameTypeDescription
from?stringThe 'from' address on the emails received by the user.
replyTo?stringThe 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.

from?

Type: string (optional, default: noreply@verificationemail.com)

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


replyTo?

Type: string (optional, default: 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.