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.
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
addressoptionalbooleanaddressoptionalbooladdressoptionalBooleanAddressoptionalboolAddressoptional*bool= false#The user's postal address.
birthdateoptionalbooleanbirthdateoptionalboolbirthdateoptionalBooleanBirthdateoptionalboolBirthdateoptional*bool= false#The user's birthday, represented as an ISO 8601:2004 format.
emailoptionalbooleanemailoptionalboolemailoptionalBooleanEmailoptionalboolEmailoptional*bool= false#The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
emailVerifiedoptionalbooleanemail_verifiedoptionalboolemailVerifiedoptionalBooleanEmailVerifiedoptionalboolEmailVerifiedoptional*bool= false#Whether the email address has been verified.
familyNameoptionalbooleanfamily_nameoptionalboolfamilyNameoptionalBooleanFamilyNameoptionalboolFamilyNameoptional*bool= false#The surname or last name of the user.
fullnameoptionalbooleanfullnameoptionalboolfullnameoptionalBooleanFullnameoptionalboolFullnameoptional*bool= false#The user's full name in displayable form, including all name parts, titles and suffixes.
genderoptionalbooleangenderoptionalboolgenderoptionalBooleanGenderoptionalboolGenderoptional*bool= false#The user's gender.
givenNameoptionalbooleangiven_nameoptionalboolgivenNameoptionalBooleanGivenNameoptionalboolGivenNameoptional*bool= false#The user's first name or give name.
lastUpdateTimeoptionalbooleanlast_update_timeoptionalboollastUpdateTimeoptionalBooleanLastUpdateTimeoptionalboolLastUpdateTimeoptional*bool= false#The time, the user's information was last updated.
localeoptionalbooleanlocaleoptionalboollocaleoptionalBooleanLocaleoptionalboolLocaleoptional*bool= false#The user's locale, represented as a BCP47 [RFC5646] language tag.
middleNameoptionalbooleanmiddle_nameoptionalboolmiddleNameoptionalBooleanMiddleNameoptionalboolMiddleNameoptional*bool= false#The user's middle name.
nicknameoptionalbooleannicknameoptionalboolnicknameoptionalBooleanNicknameoptionalboolNicknameoptional*bool= false#The user's nickname or casual name.
phoneNumberoptionalbooleanphone_numberoptionalboolphoneNumberoptionalBooleanPhoneNumberoptionalboolPhoneNumberoptional*bool= false#The user's telephone number.
phoneNumberVerifiedoptionalbooleanphone_number_verifiedoptionalboolphoneNumberVerifiedoptionalBooleanPhoneNumberVerifiedoptionalboolPhoneNumberVerifiedoptional*bool= false#Whether the phone number has been verified.
preferredUsernameoptionalbooleanpreferred_usernameoptionalboolpreferredUsernameoptionalBooleanPreferredUsernameoptionalboolPreferredUsernameoptional*bool= false#The user's preferred username, different from the immutable user name.
profilePageoptionalbooleanprofile_pageoptionalboolprofilePageoptionalBooleanProfilePageoptionalboolProfilePageoptional*bool= false#The URL to the user's profile page.
profilePictureoptionalbooleanprofile_pictureoptionalboolprofilePictureoptionalBooleanProfilePictureoptionalboolProfilePictureoptional*bool= false#The URL to the user's profile picture.
timezoneoptionalbooleantimezoneoptionalbooltimezoneoptionalBooleanTimezoneoptionalboolTimezoneoptional*bool= false#The user's time zone.
websiteoptionalbooleanwebsiteoptionalboolwebsiteoptionalBooleanWebsiteoptionalboolWebsiteoptional*bool= false#The URL to the user's web page or blog.