Class UserInvitationConfig

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

User pool configuration when administrators sign users up.

public class UserInvitationConfig : IUserInvitationConfig

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

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 {####}"
                }
            });

Remarks

ExampleMetadata: infused

Constructors

UserInvitationConfig()

public UserInvitationConfig()

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 {####}'