StandardAttributes Struct
The set of standard attributes that can be marked as required or mutable.
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
addressStandardAttributeaddressStandardAttributeaddressStandardAttributeAddressStandardAttributeAddressStandardAttribute= see the defaults under `Standard…#The user's postal address.
default
Default: see the defaults under StandardAttribute
birthdateStandardAttributebirthdateStandardAttributebirthdateStandardAttributeBirthdateStandardAttributeBirthdateStandardAttribute= see the defaults under `Standard…#The user's birthday, represented as an ISO 8601:2004 format.
default
Default: see the defaults under StandardAttribute
emailStandardAttributeemailStandardAttributeemailStandardAttributeEmailStandardAttributeEmailStandardAttribute= see the defaults under `Standard…#The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
default
Default: see the defaults under StandardAttribute
familyNameStandardAttributefamily_nameStandardAttributefamilyNameStandardAttributeFamilyNameStandardAttributeFamilyNameStandardAttribute= see the defaults under `Standard…#The surname or last name of the user.
default
Default: see the defaults under StandardAttribute
fullnameStandardAttributefullnameStandardAttributefullnameStandardAttributeFullnameStandardAttributeFullnameStandardAttribute= see the defaults under `Standard…#The user's full name in displayable form, including all name parts, titles and suffixes.
default
Default: see the defaults under StandardAttribute
genderStandardAttributegenderStandardAttributegenderStandardAttributeGenderStandardAttributeGenderStandardAttribute= see the defaults under `Standard…#The user's gender.
default
Default: see the defaults under StandardAttribute
givenNameStandardAttributegiven_nameStandardAttributegivenNameStandardAttributeGivenNameStandardAttributeGivenNameStandardAttribute= see the defaults under `Standard…#The user's first name or give name.
default
Default: see the defaults under StandardAttribute
lastUpdateTimeStandardAttributelast_update_timeStandardAttributelastUpdateTimeStandardAttributeLastUpdateTimeStandardAttributeLastUpdateTimeStandardAttribute= see the defaults under `Standard…#The time, the user's information was last updated.
default
Default: see the defaults under StandardAttribute
localeStandardAttributelocaleStandardAttributelocaleStandardAttributeLocaleStandardAttributeLocaleStandardAttribute= see the defaults under `Standard…#The user's locale, represented as a BCP47 [RFC5646] language tag.
default
Default: see the defaults under StandardAttribute
middleNameStandardAttributemiddle_nameStandardAttributemiddleNameStandardAttributeMiddleNameStandardAttributeMiddleNameStandardAttribute= see the defaults under `Standard…#The user's middle name.
default
Default: see the defaults under StandardAttribute
nicknameStandardAttributenicknameStandardAttributenicknameStandardAttributeNicknameStandardAttributeNicknameStandardAttribute= see the defaults under `Standard…#The user's nickname or casual name.
default
Default: see the defaults under StandardAttribute
phoneNumberStandardAttributephone_numberStandardAttributephoneNumberStandardAttributePhoneNumberStandardAttributePhoneNumberStandardAttribute= see the defaults under `Standard…#The user's telephone number.
default
Default: see the defaults under StandardAttribute
preferredUsernameStandardAttributepreferred_usernameStandardAttributepreferredUsernameStandardAttributePreferredUsernameStandardAttributePreferredUsernameStandardAttribute= see the defaults under `Standard…#The user's preferred username, different from the immutable user name.
default
Default: see the defaults under StandardAttribute
profilePageStandardAttributeprofile_pageStandardAttributeprofilePageStandardAttributeProfilePageStandardAttributeProfilePageStandardAttribute= see the defaults under `Standard…#The URL to the user's profile page.
default
Default: see the defaults under StandardAttribute
profilePictureStandardAttributeprofile_pictureStandardAttributeprofilePictureStandardAttributeProfilePictureStandardAttributeProfilePictureStandardAttribute= see the defaults under `Standard…#The URL to the user's profile picture.
default
Default: see the defaults under StandardAttribute
timezoneStandardAttributetimezoneStandardAttributetimezoneStandardAttributeTimezoneStandardAttributeTimezoneStandardAttribute= see the defaults under `Standard…#The user's time zone.
default
Default: see the defaults under StandardAttribute
websiteStandardAttributewebsiteStandardAttributewebsiteStandardAttributeWebsiteStandardAttributeWebsiteStandardAttribute= see the defaults under `Standard…#The URL to the user's web page or blog.
default
Default: see the defaults under StandardAttribute