# StandardAttributesMask

This interface contains standard attributes recognized by Cognito from https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html including built-in attributes `email_verified` and `phone_number_verified`.

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

## Example

```ts
const pool = new cognito.UserPool(this, 'Pool');

const clientWriteAttributes = (new cognito.ClientAttributes())
  .withStandardAttributes({fullname: true, email: true})
  .withCustomAttributes('favoritePizza', 'favoriteBeverage');

const clientReadAttributes = clientWriteAttributes
  .withStandardAttributes({emailVerified: true})
  .withCustomAttributes('pointsEarned');

pool.addClient('app-client', {
  // ...
  readAttributes: clientReadAttributes,
  writeAttributes: clientWriteAttributes,
});
```

## Properties

- `address`: boolean = false — The user's postal address.

- `birthdate`: boolean = false — The user's birthday, represented as an ISO 8601:2004 format.

- `email`: boolean = false — The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

- `emailVerified`: boolean = false — Whether the email address has been verified.

- `familyName`: boolean = false — The surname or last name of the user.

- `fullname`: boolean = false — The user's full name in displayable form, including all name parts, titles and suffixes.

- `gender`: boolean = false — The user's gender.

- `givenName`: boolean = false — The user's first name or give name.

- `lastUpdateTime`: boolean = false — The time, the user's information was last updated.

- `locale`: boolean = false — The user's locale, represented as a BCP47 [RFC5646] language tag.

- `middleName`: boolean = false — The user's middle name.

- `nickname`: boolean = false — The user's nickname or casual name.

- `phoneNumber`: boolean = false — The user's telephone number.

- `phoneNumberVerified`: boolean = false — Whether the phone number has been verified.

- `preferredUsername`: boolean = false — The user's preferred username, different from the immutable user name.

- `profilePage`: boolean = false — The URL to the user's profile page.

- `profilePicture`: boolean = false — The URL to the user's profile picture.

- `timezone`: boolean = false — The user's time zone.

- `website`: boolean = false — The URL to the user's web page or blog.