aws-cdk-lib.aws_cognito.UserInvitationConfig

UserInvitationConfig Struct

User pool configuration when administrators sign users up.

Source

aws-cognito/lib/user-pool.ts

Example

new cognito.UserPool(this, 'myuserpool', {
  // ...
  userInvitation: {
    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

emailBodystringemail_bodystremailBodyStringEmailBodystringEmailBody*string= 'Your username is {username} and…#

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

default

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

emailSubjectstringemail_subjectstremailSubjectStringEmailSubjectstringEmailSubject*string= 'Your temporary password'#

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

smsMessagestringsms_messagestrsmsMessageStringSmsMessagestringSmsMessage*string= 'Your username is {username} and…#

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

default

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