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.102.0 (build e354887)",
date="2024-09-06T01:36:25.584Z")
@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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ProviderAttribute
The email attribute provided by Amazon.static final ProviderAttribute
The name attribute provided by Amazon.static final ProviderAttribute
The postal code attribute provided by Amazon.static final ProviderAttribute
The user id attribute provided by Amazon.static final ProviderAttribute
The email attribute provided by Apple.static final ProviderAttribute
The first name attribute provided by Apple.static final ProviderAttribute
The last name attribute provided by Apple.static final ProviderAttribute
The name attribute provided by Apple.static final ProviderAttribute
The birthday attribute provided by Facebook.static final ProviderAttribute
The email attribute provided by Facebook.static final ProviderAttribute
The first name attribute provided by Facebook.static final ProviderAttribute
The gender attribute provided by Facebook.static final ProviderAttribute
The user id attribute provided by Facebook.static final ProviderAttribute
The last name attribute provided by Facebook.static final ProviderAttribute
The locale attribute provided by Facebook.static final ProviderAttribute
The middle name attribute provided by Facebook.static final ProviderAttribute
The name attribute provided by Facebook.static final ProviderAttribute
The birthday attribute provided by Google.static final ProviderAttribute
The email attribute provided by Google.static final ProviderAttribute
The family name attribute provided by Google.static final ProviderAttribute
The gender attribute provided by Google.static final ProviderAttribute
The given name attribute provided by Google.static final ProviderAttribute
The name attribute provided by Google.static final ProviderAttribute
The name attribute provided by Google.static final ProviderAttribute
The phone number attribute provided by Google.static final ProviderAttribute
The picture attribute provided by Google. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ProviderAttribute
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ProviderAttribute
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe attribute value string as recognized by the provider.static ProviderAttribute
Use this to specify an attribute from the identity provider that is not pre-defined in the CDK.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
AMAZON_EMAIL
The email attribute provided by Amazon. -
AMAZON_NAME
The name attribute provided by Amazon. -
AMAZON_POSTAL_CODE
The postal code attribute provided by Amazon. -
AMAZON_USER_ID
The user id attribute provided by Amazon. -
APPLE_EMAIL
The email attribute provided by Apple. -
APPLE_FIRST_NAME
The first name attribute provided by Apple. -
APPLE_LAST_NAME
The last name attribute provided by Apple. -
APPLE_NAME
The name attribute provided by Apple. -
FACEBOOK_BIRTHDAY
The birthday attribute provided by Facebook. -
FACEBOOK_EMAIL
The email attribute provided by Facebook. -
FACEBOOK_FIRST_NAME
The first name attribute provided by Facebook. -
FACEBOOK_GENDER
The gender attribute provided by Facebook. -
FACEBOOK_ID
The user id attribute provided by Facebook. -
FACEBOOK_LAST_NAME
The last name attribute provided by Facebook. -
FACEBOOK_LOCALE
The locale attribute provided by Facebook. -
FACEBOOK_MIDDLE_NAME
The middle name attribute provided by Facebook. -
FACEBOOK_NAME
The name attribute provided by Facebook. -
GOOGLE_BIRTHDAYS
The birthday attribute provided by Google. -
GOOGLE_EMAIL
The email attribute provided by Google. -
GOOGLE_FAMILY_NAME
The family name attribute provided by Google. -
GOOGLE_GENDER
The gender attribute provided by Google. -
GOOGLE_GIVEN_NAME
The given name attribute provided by Google. -
GOOGLE_NAME
The name attribute provided by Google. -
GOOGLE_NAMES
The name attribute provided by Google. -
GOOGLE_PHONE_NUMBERS
The phone number attribute provided by Google. -
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
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
The attribute value string as recognized by the provider.
-