# StandardAttributes

The set of standard attributes that can be marked as required or mutable.

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

## Example

```ts
new cognito.UserPool(this, 'myuserpool', {
  // ...
  standardAttributes: {
    fullname: {
      required: true,
      mutable: false,
    },
    address: {
      required: false,
      mutable: true,
    },
  },
  customAttributes: {
    'myappid': new cognito.StringAttribute({ minLen: 5, maxLen: 15, mutable: false }),
    'callingcode': new cognito.NumberAttribute({ min: 1, max: 3, mutable: true }),
    'isEmployee': new cognito.BooleanAttribute({ mutable: true }),
    'joinedOn': new cognito.DateTimeAttribute(),
  },
});
```

## Properties

- `address`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's postal address.

  **Default:** see the defaults under `StandardAttribute`

- `birthdate`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's birthday, represented as an ISO 8601:2004 format.

  **Default:** see the defaults under `StandardAttribute`

- `email`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

  **Default:** see the defaults under `StandardAttribute`

- `familyName`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The surname or last name of the user.

  **Default:** see the defaults under `StandardAttribute`

- `fullname`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's full name in displayable form, including all name parts, titles and suffixes.

  **Default:** see the defaults under `StandardAttribute`

- `gender`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's gender.

  **Default:** see the defaults under `StandardAttribute`

- `givenName`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's first name or give name.

  **Default:** see the defaults under `StandardAttribute`

- `lastUpdateTime`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The time, the user's information was last updated.

  **Default:** see the defaults under `StandardAttribute`

- `locale`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's locale, represented as a BCP47 [RFC5646] language tag.

  **Default:** see the defaults under `StandardAttribute`

- `middleName`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's middle name.

  **Default:** see the defaults under `StandardAttribute`

- `nickname`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's nickname or casual name.

  **Default:** see the defaults under `StandardAttribute`

- `phoneNumber`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's telephone number.

  **Default:** see the defaults under `StandardAttribute`

- `preferredUsername`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's preferred username, different from the immutable user name.

  **Default:** see the defaults under `StandardAttribute`

- `profilePage`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The URL to the user's profile page.

  **Default:** see the defaults under `StandardAttribute`

- `profilePicture`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The URL to the user's profile picture.

  **Default:** see the defaults under `StandardAttribute`

- `timezone`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The user's time zone.

  **Default:** see the defaults under `StandardAttribute`

- `website`: [StandardAttribute](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.StandardAttribute.html) — The URL to the user's web page or blog.

  **Default:** see the defaults under `StandardAttribute`