interface InviteMessageTemplateProperty

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPool.InviteMessageTemplateProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_InviteMessageTemplateProperty
Java	software.amazon.awscdk.services.cognito.CfnUserPool.InviteMessageTemplateProperty
Python	aws_cdk.aws_cognito.CfnUserPool.InviteMessageTemplateProperty
TypeScript	aws-cdk-lib » aws_cognito » CfnUserPool » InviteMessageTemplateProperty

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html

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

Name	Type	Description
emailMessage?	string	The message template for email messages.
emailSubject?	string	The subject line for email messages.
smsMessage?	string	The message template for SMS messages.

---

emailMessage?

Type: string (optional)

The message template for email messages.

EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage

---

emailSubject?

Type: string (optional)

The subject line for email messages.

EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject

---

smsMessage?

Type: string (optional)

The message template for SMS messages.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage