Class UserInvitationConfig

User pool configuration when administrators sign users up.

Inheritance

object

UserInvitationConfig

Implements

IUserInvitationConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class UserInvitationConfig : IUserInvitationConfig

Syntax (vb)

Public Class UserInvitationConfig Implements IUserInvitationConfig

Remarks

ExampleMetadata: infused

Examples

new UserPool(this, "myuserpool", new UserPoolProps {
                // ...
                UserInvitation = new UserInvitationConfig {
                    EmailSubject = "Invite to join our awesome app!",
                    EmailBody = "Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}",
                    SmsMessage = "Hello {username}, your temporary password for our awesome app is {####}"
                }
            });

Synopsis

Constructors

UserInvitationConfig()

User pool configuration when administrators sign users up.

Properties

EmailBody	The template to the email body that is sent to the user when an administrator signs them up to the user pool.
EmailSubject	The template to the email subject that is sent to the user when an administrator signs them up to the user pool.
SmsMessage	The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

Constructors

UserInvitationConfig()

User pool configuration when administrators sign users up.

public UserInvitationConfig()

Remarks

ExampleMetadata: infused

Examples

new UserPool(this, "myuserpool", new UserPoolProps {
                // ...
                UserInvitation = new UserInvitationConfig {
                    EmailSubject = "Invite to join our awesome app!",
                    EmailBody = "Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}",
                    SmsMessage = "Hello {username}, your temporary password for our awesome app is {####}"
                }
            });

Properties

EmailBody

The template to the email body that is sent to the user when an administrator signs them up to the user pool.

public string? EmailBody { get; set; }

Property Value

string

Remarks

Default: 'Your username is {username} and temporary password is {####}.'

EmailSubject

The template to the email subject that is sent to the user when an administrator signs them up to the user pool.

public string? EmailSubject { get; set; }

Property Value

string

Remarks

Default: 'Your temporary password'

SmsMessage

The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

public string? SmsMessage { get; set; }

Property Value

string

Remarks

Default: 'Your username is {username} and temporary password is {####}'

Implements

IUserInvitationConfig