Interface IUserInvitationConfig

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

User pool configuration when administrators sign users up.

public interface IUserInvitationConfig

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

Properties

EmailBody

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

string? EmailBody { get; }

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.

string? EmailSubject { get; }

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.

string? SmsMessage { get; }

Property Value

string

Remarks

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