aws-cdk-lib.aws_cognito.CfnUserPool.InviteMessageTemplateProperty

InviteMessageTemplateProperty Struct

The template for the welcome message to new users.

This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 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 inviteMessageTemplateProperty: cognito.CfnUserPool.InviteMessageTemplateProperty = {
  emailMessage: 'emailMessage',
  emailSubject: 'emailSubject',
  smsMessage: 'smsMessage',
};

Properties

emailMessagestringemail_messagestremailMessageStringEmailMessagestringEmailMessage*string#

The message template for email messages.

notes

EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

emailSubjectstringemail_subjectstremailSubjectStringEmailSubjectstringEmailSubject*string#

The subject line for email messages.

notes

EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

smsMessagestringsms_messagestrsmsMessageStringSmsMessagestringSmsMessage*string#

The message template for SMS messages.