Package software.amazon.awscdk.services.cognito

Interface StandardAttributesMask

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StandardAttributesMask.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:06.410Z") @Stability(Stable) public interface StandardAttributesMask extends software.amazon.jsii.JsiiSerializable
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: 

 UserPool pool = new UserPool(this, "Pool");
 ClientAttributes clientWriteAttributes = (new ClientAttributes()).withStandardAttributes(StandardAttributesMask.builder().fullname(true).email(true).build()).withCustomAttributes("favouritePizza", "favouriteBeverage");
 ClientAttributes clientReadAttributes = clientWriteAttributes.withStandardAttributes(StandardAttributesMask.builder().emailVerified(true).build()).withCustomAttributes("pointsEarned");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .readAttributes(clientReadAttributes)
         .writeAttributes(clientWriteAttributes)
         .build());

  • Method Details

    • getAddress

      @Stability(Stable) @Nullable default Boolean getAddress()
      The user's postal address.

      Default: false

    • getBirthdate

      @Stability(Stable) @Nullable default Boolean getBirthdate()
      The user's birthday, represented as an ISO 8601:2004 format.

      Default: false

    • getEmail

      @Stability(Stable) @Nullable default Boolean getEmail()
      The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

      Default: false

    • getEmailVerified

      @Stability(Stable) @Nullable default Boolean getEmailVerified()
      Whether the email address has been verified.

      Default: false

    • getFamilyName

      @Stability(Stable) @Nullable default Boolean getFamilyName()
      The surname or last name of the user.

      Default: false

    • getFullname

      @Stability(Stable) @Nullable default Boolean getFullname()
      The user's full name in displayable form, including all name parts, titles and suffixes.

      Default: false

    • getGender

      @Stability(Stable) @Nullable default Boolean getGender()
      The user's gender.

      Default: false

    • getGivenName

      @Stability(Stable) @Nullable default Boolean getGivenName()
      The user's first name or give name.

      Default: false

    • getLastUpdateTime

      @Stability(Stable) @Nullable default Boolean getLastUpdateTime()
      The time, the user's information was last updated.

      Default: false

    • getLocale

      @Stability(Stable) @Nullable default Boolean getLocale()
      The user's locale, represented as a BCP47 [RFC5646] language tag.

      Default: false

    • getMiddleName

      @Stability(Stable) @Nullable default Boolean getMiddleName()
      The user's middle name.

      Default: false

    • getNickname

      @Stability(Stable) @Nullable default Boolean getNickname()
      The user's nickname or casual name.

      Default: false

    • getPhoneNumber

      @Stability(Stable) @Nullable default Boolean getPhoneNumber()
      The user's telephone number.

      Default: false

    • getPhoneNumberVerified

      @Stability(Stable) @Nullable default Boolean getPhoneNumberVerified()
      Whether the phone number has been verified.

      Default: false

    • getPreferredUsername

      @Stability(Stable) @Nullable default Boolean getPreferredUsername()
      The user's preffered username, different from the immutable user name.

      Default: false

    • getProfilePage

      @Stability(Stable) @Nullable default Boolean getProfilePage()
      The URL to the user's profile page.

      Default: false

    • getProfilePicture

      @Stability(Stable) @Nullable default Boolean getProfilePicture()
      The URL to the user's profile picture.

      Default: false

    • getTimezone

      @Stability(Stable) @Nullable default Boolean getTimezone()
      The user's time zone.

      Default: false

    • getWebsite

      @Stability(Stable) @Nullable default Boolean getWebsite()
      The URL to the user's web page or blog.

      Default: false

    • builder

      @Stability(Stable) static StandardAttributesMask.Builder builder()
      Returns:
      a StandardAttributesMask.Builder of StandardAttributesMask