interface StandardAttributesMask

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.StandardAttributesMask
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#StandardAttributesMask
Java	software.amazon.awscdk.services.cognito.StandardAttributesMask
Python	aws_cdk.aws_cognito.StandardAttributesMask
TypeScript (source)	aws-cdk-lib » aws_cognito » 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.

Example

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

Name	Type	Description
address?	boolean	The user's postal address.
birthdate?	boolean	The user's birthday, represented as an ISO 8601:2004 format.
email?	boolean	The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
emailVerified?	boolean	Whether the email address has been verified.
familyName?	boolean	The surname or last name of the user.
fullname?	boolean	The user's full name in displayable form, including all name parts, titles and suffixes.
gender?	boolean	The user's gender.
givenName?	boolean	The user's first name or give name.
lastUpdateTime?	boolean	The time, the user's information was last updated.
locale?	boolean	The user's locale, represented as a BCP47 [RFC5646] language tag.
middleName?	boolean	The user's middle name.
nickname?	boolean	The user's nickname or casual name.
phoneNumber?	boolean	The user's telephone number.
phoneNumberVerified?	boolean	Whether the phone number has been verified.
preferredUsername?	boolean	The user's preferred username, different from the immutable user name.
profilePage?	boolean	The URL to the user's profile page.
profilePicture?	boolean	The URL to the user's profile picture.
timezone?	boolean	The user's time zone.
website?	boolean	The URL to the user's web page or blog.

---

address?

Type: boolean (optional, default: false)

The user's postal address.

---

birthdate?

Type: boolean (optional, default: false)

The user's birthday, represented as an ISO 8601:2004 format.

---

email?

Type: boolean (optional, default: false)

The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

---

emailVerified?

Type: boolean (optional, default: false)

Whether the email address has been verified.

---

familyName?

Type: boolean (optional, default: false)

The surname or last name of the user.

---

fullname?

Type: boolean (optional, default: false)

The user's full name in displayable form, including all name parts, titles and suffixes.

---

gender?

Type: boolean (optional, default: false)

The user's gender.

---

givenName?

Type: boolean (optional, default: false)

The user's first name or give name.

---

lastUpdateTime?

Type: boolean (optional, default: false)

The time, the user's information was last updated.

---

locale?

Type: boolean (optional, default: false)

The user's locale, represented as a BCP47 [RFC5646] language tag.

---

middleName?

Type: boolean (optional, default: false)

The user's middle name.

---

nickname?

Type: boolean (optional, default: false)

The user's nickname or casual name.

---

phoneNumber?

Type: boolean (optional, default: false)

The user's telephone number.

---

phoneNumberVerified?

Type: boolean (optional, default: false)

Whether the phone number has been verified.

---

preferredUsername?

Type: boolean (optional, default: false)

The user's preferred username, different from the immutable user name.

---

profilePage?

Type: boolean (optional, default: false)

The URL to the user's profile page.

---

profilePicture?

Type: boolean (optional, default: false)

The URL to the user's profile picture.

---

timezone?

Type: boolean (optional, default: false)

The user's time zone.

---

website?

Type: boolean (optional, default: false)

The URL to the user's web page or blog.