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 .
Example
ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito
invite_message_template_property = cognito.CfnUserPool.InviteMessageTemplateProperty(
email_message="emailMessage",
email_subject="emailSubject",
sms_message="smsMessage"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cognito.*;
InviteMessageTemplateProperty inviteMessageTemplateProperty = InviteMessageTemplateProperty.builder()
.emailMessage("emailMessage")
.emailSubject("emailSubject")
.smsMessage("smsMessage")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var inviteMessageTemplateProperty = new InviteMessageTemplateProperty {
EmailMessage = "emailMessage",
EmailSubject = "emailSubject",
SmsMessage = "smsMessage"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
inviteMessageTemplateProperty := &InviteMessageTemplateProperty{
EmailMessage: jsii.String("emailMessage"),
EmailSubject: jsii.String("emailSubject"),
SmsMessage: jsii.String("smsMessage"),
}
Properties
emailMessageoptionalstringemail_messageoptionalstremailMessageoptionalStringEmailMessageoptionalstringEmailMessageoptional*string#The message template for email messages.
notes
EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
emailSubjectoptionalstringemail_subjectoptionalstremailSubjectoptionalStringEmailSubjectoptionalstringEmailSubjectoptional*string#The subject line for email messages.
notes
EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
smsMessageoptionalstringsms_messageoptionalstrsmsMessageoptionalStringSmsMessageoptionalstringSmsMessageoptional*string#The message template for SMS messages.