Skip to content
v2.276.0

UserVerificationConfig Struct ​

User pool configuration for user self sign up.

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 {####}',
  },
});
python
cognito.UserPool(self, "myuserpool",
    # ...
    self_sign_up_enabled=True,
    user_verification=cognito.UserVerificationConfig(
        email_subject="Verify your email for our awesome app!",
        email_body="Thanks for signing up to our awesome app! Your verification code is {####}",
        email_style=cognito.VerificationEmailStyle.CODE,
        sms_message="Thanks for signing up to our awesome app! Your verification code is {####}"
    )
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new UserPool(this, "myuserpool", new UserPoolProps {
    // ...
    SelfSignUpEnabled = true,
    UserVerification = new UserVerificationConfig {
        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 {####}"
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
cognito.NewUserPool(this, jsii.String("myuserpool"), &UserPoolProps{
	// ...
	SelfSignUpEnabled: jsii.Boolean(true),
	UserVerification: &UserVerificationConfig{
		EmailSubject: jsii.String("Verify your email for our awesome app!"),
		EmailBody: jsii.String("Thanks for signing up to our awesome app! Your verification code is {####}"),
		EmailStyle: cognito.VerificationEmailStyle_CODE,
		SmsMessage: jsii.String("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.
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.