Package software.amazon.awscdk.services.cognito

Interface StandardAttributes

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StandardAttributes.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.056Z") @Stability(Stable) public interface StandardAttributes extends software.amazon.jsii.JsiiSerializable
The set of standard attributes that can be marked as required or mutable.

Example: 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .standardAttributes(StandardAttributes.builder()
                 .fullname(StandardAttribute.builder()
                         .required(true)
                         .mutable(false)
                         .build())
                 .address(StandardAttribute.builder()
                         .required(false)
                         .mutable(true)
                         .build())
                 .build())
         .customAttributes(Map.of(
                 "myappid", StringAttribute.Builder.create().minLen(5).maxLen(15).mutable(false).build(),
                 "callingcode", NumberAttribute.Builder.create().min(1).max(3).mutable(true).build(),
                 "isEmployee", BooleanAttribute.Builder.create().mutable(true).build(),
                 "joinedOn", new DateTimeAttribute()))
         .build();

See Also:

  • Method Details

    • getAddress

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

      Default: - see the defaults under `StandardAttribute`

    • getBirthdate

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

      Default: - see the defaults under `StandardAttribute`

    • getEmail

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

      Default: - see the defaults under `StandardAttribute`

    • getEmailVerified

      @Stability(Deprecated) @Deprecated @Nullable default StandardAttribute getEmailVerified()
      Deprecated.
      this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.
      (deprecated) DEPRECATED.

      Default: - see the defaults under `StandardAttribute`

    • getFamilyName

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

      Default: - see the defaults under `StandardAttribute`

    • getFullname

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

      Default: - see the defaults under `StandardAttribute`

    • getGender

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

      Default: - see the defaults under `StandardAttribute`

    • getGivenName

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

      Default: - see the defaults under `StandardAttribute`

    • getLastUpdateTime

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

      Default: - see the defaults under `StandardAttribute`

    • getLocale

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

      Default: - see the defaults under `StandardAttribute`

    • getMiddleName

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

      Default: - see the defaults under `StandardAttribute`

    • getNickname

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

      Default: - see the defaults under `StandardAttribute`

    • getPhoneNumber

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

      Default: - see the defaults under `StandardAttribute`

    • getPhoneNumberVerified

      @Stability(Deprecated) @Deprecated @Nullable default StandardAttribute getPhoneNumberVerified()
      Deprecated.
      this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.
      (deprecated) DEPRECATED.

      Default: - see the defaults under `StandardAttribute`

    • getPreferredUsername

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

      Default: - see the defaults under `StandardAttribute`

    • getProfilePage

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

      Default: - see the defaults under `StandardAttribute`

    • getProfilePicture

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

      Default: - see the defaults under `StandardAttribute`

    • getTimezone

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

      Default: - see the defaults under `StandardAttribute`

    • getWebsite

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

      Default: - see the defaults under `StandardAttribute`

    • builder

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