aws-cdk-lib.aws_cognito.CfnUserPool.InviteMessageTemplateProperty

interface InviteMessageTemplateProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPool.InviteMessageTemplateProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_InviteMessageTemplateProperty
Javasoftware.amazon.awscdk.services.cognito.CfnUserPool.InviteMessageTemplateProperty
Pythonaws_cdk.aws_cognito.CfnUserPool.InviteMessageTemplateProperty
TypeScript aws-cdk-lib » aws_cognito » CfnUserPool » InviteMessageTemplateProperty

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages .

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

NameTypeDescription
emailMessage?stringThe message template for email messages.
emailSubject?stringThe subject line for email messages.
smsMessage?stringThe message template for SMS messages.

emailMessage?

Type: string (optional)

The message template for email messages.

EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.


emailSubject?

Type: string (optional)

The subject line for email messages.

EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.


smsMessage?

Type: string (optional)

The message template for SMS messages.