Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.InviteMessageTemplateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.InviteMessageTemplateProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.InviteMessageTemplateProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.InviteMessageTemplateProperty.Builder	A builder for CfnUserPool.InviteMessageTemplateProperty
static final class	CfnUserPool.InviteMessageTemplateProperty.Jsii$Proxy	An implementation for CfnUserPool.InviteMessageTemplateProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.InviteMessageTemplateProperty.Builder	builder()
default String	getEmailMessage()	The message template for email messages.
default String	getEmailSubject()	The subject line for email messages.
default String	getSmsMessage()	The message template for SMS messages.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmailMessage

@Stability(Stable)
@Nullable
default String getEmailMessage()

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

getEmailSubject

@Stability(Stable)
@Nullable
default String getEmailSubject()

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

getSmsMessage

@Stability(Stable)
@Nullable
default String getSmsMessage()

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

builder

@Stability(Stable)
static CfnUserPool.InviteMessageTemplateProperty.Builder builder()

Returns:

a CfnUserPool.InviteMessageTemplateProperty.Builder of CfnUserPool.InviteMessageTemplateProperty