Package software.amazon.awscdk.services.cognito

Interface AttributeMapping

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AttributeMapping.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:01.454Z") @Stability(Stable) public interface AttributeMapping extends software.amazon.jsii.JsiiSerializable
The mapping of user pool attributes to the attributes provided by the identity providers.

Example: 

 UserPool userpool = new UserPool(this, "Pool");
 UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .userPool(userpool)
         .attributeMapping(AttributeMapping.builder()
                 .email(ProviderAttribute.AMAZON_EMAIL)
                 .website(ProviderAttribute.other("url")) // use other() when an attribute is not pre-defined in the CDK
                 .custom(Map.of(
                         // custom user pool attributes go here
                         "uniqueId", ProviderAttribute.AMAZON_USER_ID))
                 .build())
         .build();

  • Method Details

    • getAddress

      @Stability(Stable) @Nullable default ProviderAttribute getAddress()
      The user's postal address is a required attribute.

      Default: - not mapped

    • getBirthdate

      @Stability(Stable) @Nullable default ProviderAttribute getBirthdate()
      The user's birthday.

      Default: - not mapped

    • getCustom

      @Stability(Stable) @Nullable default Map<String,ProviderAttribute> getCustom()
      Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

      Default: - no custom attribute mapping

    • getEmail

      @Stability(Stable) @Nullable default ProviderAttribute getEmail()
      The user's e-mail address.

      Default: - not mapped

    • getEmailVerified

      @Stability(Stable) @Nullable default ProviderAttribute getEmailVerified()
      The user's e-mail address is verification.

      Default: - not mapped

    • getFamilyName

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

      Default: - not mapped

    • getFullname

      @Stability(Stable) @Nullable default ProviderAttribute getFullname()
      The user's full name in displayable form.

      Default: - not mapped

    • getGender

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

      Default: - not mapped

    • getGivenName

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

      Default: - not mapped

    • getLastUpdateTime

      @Stability(Stable) @Nullable default ProviderAttribute getLastUpdateTime()
      Time, the user's information was last updated.

      Default: - not mapped

    • getLocale

      @Stability(Stable) @Nullable default ProviderAttribute getLocale()
      The user's locale.

      Default: - not mapped

    • getMiddleName

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

      Default: - not mapped

    • getNickname

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

      Default: - not mapped

    • getPhoneNumber

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

      Default: - not mapped

    • getPreferredUsername

      @Stability(Stable) @Nullable default ProviderAttribute getPreferredUsername()
      The user's preferred username.

      Default: - not mapped

    • getProfilePage

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

      Default: - not mapped

    • getProfilePicture

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

      Default: - not mapped

    • getTimezone

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

      Default: - not mapped

    • getWebsite

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

      Default: - not mapped

    • builder

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