Package software.amazon.awscdk.services.cognito

Class ProviderAttribute

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.ProviderAttribute
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-30T01:25:08.555Z") @Stability(Stable) public class ProviderAttribute extends software.amazon.jsii.JsiiObject
An attribute available from a third party identity provider.

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();

  • Field Details

    • AMAZON_EMAIL

      @Stability(Stable) public static final ProviderAttribute AMAZON_EMAIL
      The email attribute provided by Amazon.

    • AMAZON_NAME

      @Stability(Stable) public static final ProviderAttribute AMAZON_NAME
      The name attribute provided by Amazon.

    • AMAZON_POSTAL_CODE

      @Stability(Stable) public static final ProviderAttribute AMAZON_POSTAL_CODE
      The postal code attribute provided by Amazon.

    • AMAZON_USER_ID

      @Stability(Stable) public static final ProviderAttribute AMAZON_USER_ID
      The user id attribute provided by Amazon.

    • APPLE_EMAIL

      @Stability(Stable) public static final ProviderAttribute APPLE_EMAIL
      The email attribute provided by Apple.

    • APPLE_FIRST_NAME

      @Stability(Stable) public static final ProviderAttribute APPLE_FIRST_NAME
      The first name attribute provided by Apple.

    • APPLE_LAST_NAME

      @Stability(Stable) public static final ProviderAttribute APPLE_LAST_NAME
      The last name attribute provided by Apple.

    • APPLE_NAME

      @Stability(Stable) public static final ProviderAttribute APPLE_NAME
      The name attribute provided by Apple.

    • FACEBOOK_BIRTHDAY

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_BIRTHDAY
      The birthday attribute provided by Facebook.

    • FACEBOOK_EMAIL

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_EMAIL
      The email attribute provided by Facebook.

    • FACEBOOK_FIRST_NAME

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_FIRST_NAME
      The first name attribute provided by Facebook.

    • FACEBOOK_GENDER

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_GENDER
      The gender attribute provided by Facebook.

    • FACEBOOK_ID

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_ID
      The user id attribute provided by Facebook.

    • FACEBOOK_LAST_NAME

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_LAST_NAME
      The last name attribute provided by Facebook.

    • FACEBOOK_LOCALE

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_LOCALE
      The locale attribute provided by Facebook.

    • FACEBOOK_MIDDLE_NAME

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_MIDDLE_NAME
      The middle name attribute provided by Facebook.

    • FACEBOOK_NAME

      @Stability(Stable) public static final ProviderAttribute FACEBOOK_NAME
      The name attribute provided by Facebook.

    • GOOGLE_BIRTHDAYS

      @Stability(Stable) public static final ProviderAttribute GOOGLE_BIRTHDAYS
      The birthday attribute provided by Google.

    • GOOGLE_EMAIL

      @Stability(Stable) public static final ProviderAttribute GOOGLE_EMAIL
      The email attribute provided by Google.

    • GOOGLE_FAMILY_NAME

      @Stability(Stable) public static final ProviderAttribute GOOGLE_FAMILY_NAME
      The family name attribute provided by Google.

    • GOOGLE_GENDER

      @Stability(Stable) public static final ProviderAttribute GOOGLE_GENDER
      The gender attribute provided by Google.

    • GOOGLE_GIVEN_NAME

      @Stability(Stable) public static final ProviderAttribute GOOGLE_GIVEN_NAME
      The given name attribute provided by Google.

    • GOOGLE_NAME

      @Stability(Stable) public static final ProviderAttribute GOOGLE_NAME
      The name attribute provided by Google.

    • GOOGLE_NAMES

      @Stability(Stable) public static final ProviderAttribute GOOGLE_NAMES
      The name attribute provided by Google.

    • GOOGLE_PHONE_NUMBERS

      @Stability(Stable) public static final ProviderAttribute GOOGLE_PHONE_NUMBERS
      The phone number attribute provided by Google.

    • GOOGLE_PICTURE

      @Stability(Stable) public static final ProviderAttribute GOOGLE_PICTURE
      The picture attribute provided by Google.

  • Constructor Details

    • ProviderAttribute

      protected ProviderAttribute(software.amazon.jsii.JsiiObjectRef objRef)

    • ProviderAttribute

      protected ProviderAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • other

      @Stability(Stable) @NotNull public static ProviderAttribute other(@NotNull String attributeName)
      Use this to specify an attribute from the identity provider that is not pre-defined in the CDK.

      Parameters:
      attributeName - the attribute value string as recognized by the provider. This parameter is required.

    • getAttributeName

      @Stability(Stable) @NotNull public String getAttributeName()
      The attribute value string as recognized by the provider.