# UserInvitationConfig

User pool configuration when administrators sign users 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#L376)

## Example

```ts
new cognito.UserPool(this, 'myuserpool', {
  // ...
  userInvitation: {
    emailSubject: 'Invite to join our awesome app!',
    emailBody: 'Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}',
    smsMessage: 'Hello {username}, your temporary password for our awesome app is {####}',
  },
});
```

## Properties

- `emailBody`: string — The template to the email body that is sent to the user when an administrator signs them up to the user pool.

  **Default:** 'Your username is {username} and temporary password is {####}.'

- `emailSubject`: string — The template to the email subject that is sent to the user when an administrator signs them up to the user pool.

  **Default:** 'Your temporary password'

- `smsMessage`: string — The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

  **Default:** 'Your username is {username} and temporary password is {####}'