Interface UserVerificationConfig
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
UserVerificationConfig.Jsii$Proxy
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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forUserVerificationConfig
static final class
An implementation forUserVerificationConfig
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The email body template for the verification email sent to the user upon sign up.default VerificationEmailStyle
Emails can be verified either using a code or a link.default String
The email subject template for the verification email sent to the user upon sign up.default String
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
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
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
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
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
- Returns:
- a
UserVerificationConfig.Builder
ofUserVerificationConfig
-