software.amazon.awscdk.services.cognito

Interface UserInvitationConfig

All Known Implementing Classes:

UserInvitationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.885Z")
public interface UserInvitationConfig

User pool configuration when administrators sign users up.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .userInvitation(UserInvitationConfig.builder()
                 .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 {####}")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserInvitationConfig.Builder A builder for UserInvitationConfig
static class	UserInvitationConfig.Jsii$Proxy An implementation for UserInvitationConfig

Method Summary

Modifier and Type	Method and Description
static UserInvitationConfig.Builder	builder()
default java.lang.String	getEmailBody() The template to the email body that is sent to the user when an administrator signs them up to the user pool.
default java.lang.String	getEmailSubject() The template to the email subject that is sent to the user when an administrator signs them up to the user pool.
default java.lang.String	getSmsMessage() The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

Method Detail

getEmailBody

default java.lang.String getEmailBody()

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

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

getEmailSubject

default java.lang.String getEmailSubject()

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

Default: 'Your temporary password'

getSmsMessage

default java.lang.String getSmsMessage()

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

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

builder

static UserInvitationConfig.Builder builder()

Returns:

a UserInvitationConfig.Builder of UserInvitationConfig