Package software.amazon.awscdk.services.cognito

Interface UserVerificationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserVerificationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.108Z")
@Stability(Stable)
public interface UserVerificationConfig
extends software.amazon.jsii.JsiiSerializable

User pool configuration for user self sign up.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .selfSignUpEnabled(true)
         .userVerification(UserVerificationConfig.builder()
                 .emailSubject("Verify your email for our awesome app!")
                 .emailBody("Thanks for signing up to our awesome app! Your verification code is {####}")
                 .emailStyle(VerificationEmailStyle.CODE)
                 .smsMessage("Thanks for signing up to our awesome app! Your verification code is {####}")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserVerificationConfig.Builder	builder()
default String	getEmailBody()	The email body template for the verification email sent to the user upon sign up.
default VerificationEmailStyle	getEmailStyle()	Emails can be verified either using a code or a link.
default String	getEmailSubject()	The email subject template for the verification email sent to the user upon sign up.
default String	getSmsMessage()	The message template for the verification SMS sent to the user upon sign up.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmailBody

@Stability(Stable)
@Nullable
default String getEmailBody()

The email body template for the verification email sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Default: - 'The verification code to your new account is {####}' if VerificationEmailStyle.CODE is chosen, 'Verify your account by clicking on {##Verify Email##}' if VerificationEmailStyle.LINK is chosen.

getEmailStyle

@Stability(Stable)
@Nullable
default VerificationEmailStyle getEmailStyle()

Emails can be verified either using a code or a link.

Learn more at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-email-verification-message-customization.html

Default: VerificationEmailStyle.CODE

getEmailSubject

@Stability(Stable)
@Nullable
default String getEmailSubject()

The email subject template for the verification email sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Default: 'Verify your new account'

getSmsMessage

@Stability(Stable)
@Nullable
default String getSmsMessage()

The message template for the verification SMS sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Default: - 'The verification code to your new account is {####}' if VerificationEmailStyle.CODE is chosen, not configured if VerificationEmailStyle.LINK is chosen

builder

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

Returns:

a UserVerificationConfig.Builder of UserVerificationConfig