# UserVerificationConfig

User pool configuration for user self sign up.

- Source: [`aws-cognito/lib/user-pool.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool.ts#L336)

## 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

- `emailBody`: 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.

- `emailStyle`: [VerificationEmailStyle](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.VerificationEmailStyle.html) = 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

- `emailSubject`: 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.

- `smsMessage`: 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.
