AWS CDK Reference

Appearance

v2.275.0

UserVerificationConfig Struct ​

User pool configuration for user self sign up.

Source
aws-cognito/lib/user-pool.ts

Example ​

ts
new cognito.UserPool(this, 'myuserpool', {
  // ...
  selfSignUpEnabled: true,
  userVerification: {
    emailSubject: 'Verify your email for our awesome app!',
    emailBody: 'Thanks for signing up to our awesome app! Your verification code is {####}',
    emailStyle: cognito.VerificationEmailStyle.CODE,
    smsMessage: 'Thanks for signing up to our awesome app! Your verification code is {####}',
  },
});

Properties ​

emailBodyoptionalstringemail_bodyoptionalstremailBodyoptionalStringEmailBodyoptionalstringEmailBodyoptional*string#
The email body template for the verification email sent to the user upon sign up.

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.

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

emailStyleoptionalVerificationEmailStyleemail_styleoptionalVerificationEmailStyleemailStyleoptionalVerificationEmailStyleEmailStyleoptionalVerificationEmailStyleEmailStyleoptionalVerificationEmailStyle= VerificationEmailStyle.CODE#
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

emailSubjectoptionalstringemail_subjectoptionalstremailSubjectoptionalStringEmailSubjectoptionalstringEmailSubjectoptional*string#
The email subject template for the verification email sent to the user upon sign up.

Default: 'Verify your new account'

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

smsMessageoptionalstringsms_messageoptionalstrsmsMessageoptionalStringSmsMessageoptionalstringSmsMessageoptional*string#
The message template for the verification SMS sent to the user upon sign up.

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

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