Package software.amazon.awscdk.services.cognito

Interface UserInvitationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserInvitationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:12.538Z")
@Stability(Stable)
public interface UserInvitationConfig
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	UserInvitationConfig.Builder	A builder for UserInvitationConfig
static final class	UserInvitationConfig.Jsii$Proxy	An implementation for UserInvitationConfig

Method Summary

Modifier and Type	Method	Description
static UserInvitationConfig.Builder	builder()
default 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 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 String	getSmsMessage()	The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmailBody

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static UserInvitationConfig.Builder builder()

Returns:

a UserInvitationConfig.Builder of UserInvitationConfig