(aws-cognito): Don't use {username} in verification email templates

[douglasnaphas]

https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cognito-readme.html#sign-up

The above link has this code sample for setting up user verification:

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

But the Message Template docs say:

Note
{username} can't be used in verification emails. {username} is available for invitation emails sent after AdminCreateUser call. These invitation emails provide two place holders: username {username} and temporary password {####}

Remove {username} from emailBody, if it is indeed invalid there. I have not tested whether the emailBody and smsMessage from the docs will work in a real User Pool, but I intend to in a test project.

---

This is a 📕 documentation issue

[nija-at]

Sounds good. I'm sure that 'Note' in the documentation is a recent additional and wasn't present when this code was original written.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.