aws-cdk-lib.aws_cognito.UserPoolEmailConfig

UserPoolEmailConfig Struct

Result of binding email settings with a user pool.

Source

aws-cognito/lib/user-pool-email.ts

Type last changed

v2.164.0 · 24 Oct 2024

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 userPoolEmailConfig: cognito.UserPoolEmailConfig = {
  configurationSet: 'configurationSet',
  emailSendingAccount: 'emailSendingAccount',
  from: 'from',
  replyToEmailAddress: 'replyToEmailAddress',
  sourceArn: 'sourceArn',
};

Properties

configurationSet?optionalstringconfiguration_set?optionalstrconfigurationSet?optionalStringConfigurationSet?optionalstringConfigurationSet?optional*string= none#

The name of the configuration set in SES.

emailSendingAccount?optionalstringemail_sending_account?optionalstremailSendingAccount?optionalStringEmailSendingAccount?optionalstringEmailSendingAccount?optional*string#

Specifies whether to use Cognito's built in email functionality or SES.

Default: Cognito built in email functionality

from?optionalstringfrom?optionalstrfrom?optionalStringFrom?optionalstringFrom?optional*string= 'no-reply@verificationemail.com'#

Identifies either the sender's email address or the sender's name with their email address.

If emailSendingAccount is DEVELOPER then this cannot be specified.

replyToEmailAddress?optionalstringreply_to_email_address?optionalstrreplyToEmailAddress?optionalStringReplyToEmailAddress?optionalstringReplyToEmailAddress?optional*string#

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

Default: same as from

sourceArn?optionalstringsource_arn?optionalstrsourceArn?optionalStringSourceArn?optionalstringSourceArn?optional*string= none#

The ARN of a verified email address in Amazon SES.

required if emailSendingAccount is DEVELOPER or if 'from' is provided.