AWS CDK Reference

Appearance

v2.273.0

StandardAttributesMask Struct ​

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

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 ​

addressbooleanaddressbooladdressBooleanAddressboolAddress*bool= false#
The user's postal address.
birthdatebooleanbirthdateboolbirthdateBooleanBirthdateboolBirthdate*bool= false#
The user's birthday, represented as an ISO 8601:2004 format.
emailbooleanemailboolemailBooleanEmailboolEmail*bool= false#
The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
emailVerifiedbooleanemail_verifiedboolemailVerifiedBooleanEmailVerifiedboolEmailVerified*bool= false#
Whether the email address has been verified.
familyNamebooleanfamily_nameboolfamilyNameBooleanFamilyNameboolFamilyName*bool= false#
The surname or last name of the user.
fullnamebooleanfullnameboolfullnameBooleanFullnameboolFullname*bool= false#
The user's full name in displayable form, including all name parts, titles and suffixes.
genderbooleangenderboolgenderBooleanGenderboolGender*bool= false#
The user's gender.
givenNamebooleangiven_nameboolgivenNameBooleanGivenNameboolGivenName*bool= false#
The user's first name or give name.
lastUpdateTimebooleanlast_update_timeboollastUpdateTimeBooleanLastUpdateTimeboolLastUpdateTime*bool= false#
The time, the user's information was last updated.
localebooleanlocaleboollocaleBooleanLocaleboolLocale*bool= false#
The user's locale, represented as a BCP47 [RFC5646] language tag.
middleNamebooleanmiddle_nameboolmiddleNameBooleanMiddleNameboolMiddleName*bool= false#
The user's middle name.
nicknamebooleannicknameboolnicknameBooleanNicknameboolNickname*bool= false#
The user's nickname or casual name.
phoneNumberbooleanphone_numberboolphoneNumberBooleanPhoneNumberboolPhoneNumber*bool= false#
The user's telephone number.
phoneNumberVerifiedbooleanphone_number_verifiedboolphoneNumberVerifiedBooleanPhoneNumberVerifiedboolPhoneNumberVerified*bool= false#
Whether the phone number has been verified.
preferredUsernamebooleanpreferred_usernameboolpreferredUsernameBooleanPreferredUsernameboolPreferredUsername*bool= false#
The user's preferred username, different from the immutable user name.
profilePagebooleanprofile_pageboolprofilePageBooleanProfilePageboolProfilePage*bool= false#
The URL to the user's profile page.
profilePicturebooleanprofile_pictureboolprofilePictureBooleanProfilePictureboolProfilePicture*bool= false#
The URL to the user's profile picture.
timezonebooleantimezonebooltimezoneBooleanTimezoneboolTimezone*bool= false#
The user's time zone.
websitebooleanwebsiteboolwebsiteBooleanWebsiteboolWebsite*bool= false#
The URL to the user's web page or blog.