Class CfnUserPoolPropsMixin.InviteMessageTemplateProperty

The template for the welcome message to new users.

Inheritance

object

CfnUserPoolPropsMixin.InviteMessageTemplateProperty

Implements

CfnUserPoolPropsMixin.IInviteMessageTemplateProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnUserPoolPropsMixin.InviteMessageTemplateProperty : CfnUserPoolPropsMixin.IInviteMessageTemplateProperty

Syntax (vb)

Public Class CfnUserPoolPropsMixin.InviteMessageTemplateProperty Implements CfnUserPoolPropsMixin.IInviteMessageTemplateProperty

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins;

             var inviteMessageTemplateProperty = new InviteMessageTemplateProperty {
                 EmailMessage = "emailMessage",
                 EmailSubject = "emailSubject",
                 SmsMessage = "smsMessage"
             };

Synopsis

Constructors

InviteMessageTemplateProperty()

The template for the welcome message to new users.

Properties

EmailMessage	The message template for email messages.
EmailSubject	The subject line for email messages.
SmsMessage	The message template for SMS messages.

Constructors

InviteMessageTemplateProperty()

The template for the welcome message to new users.

public InviteMessageTemplateProperty()

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins;

             var inviteMessageTemplateProperty = new InviteMessageTemplateProperty {
                 EmailMessage = "emailMessage",
                 EmailSubject = "emailSubject",
                 SmsMessage = "smsMessage"
             };

Properties

EmailMessage

The message template for email messages.

public string? EmailMessage { get; set; }

Property Value

string

Remarks

EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

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

EmailSubject

The subject line for email messages.

public string? EmailSubject { get; set; }

Property Value

string

Remarks

EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

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

SmsMessage

The message template for SMS messages.

public string? SmsMessage { get; set; }