aws-cdk-lib.aws_cognito.StandardAttributesMask

interface StandardAttributesMask

LanguageType name
.NETAmazon.CDK.AWS.Cognito.StandardAttributesMask
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#StandardAttributesMask
Javasoftware.amazon.awscdk.services.cognito.StandardAttributesMask
Pythonaws_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('favouritePizza', 'favouriteBeverage');

const clientReadAttributes = clientWriteAttributes
  .withStandardAttributes({emailVerified: true})
  .withCustomAttributes('pointsEarned');

pool.addClient('app-client', {
  // ...
  readAttributes: clientReadAttributes,
  writeAttributes: clientWriteAttributes,
});

Properties

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