software.amazon.awscdk.services.cognito

Class ProviderAttribute

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.ProviderAttribute

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:26.082Z")
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 Summary

Fields

Modifier and Type	Field and Description
static ProviderAttribute	AMAZON_EMAIL The email attribute provided by Amazon.
static ProviderAttribute	AMAZON_NAME The name attribute provided by Amazon.
static ProviderAttribute	AMAZON_POSTAL_CODE The postal code attribute provided by Amazon.
static ProviderAttribute	AMAZON_USER_ID The user id attribute provided by Amazon.
static ProviderAttribute	APPLE_EMAIL The email attribute provided by Apple.
static ProviderAttribute	APPLE_FIRST_NAME The first name attribute provided by Apple.
static ProviderAttribute	APPLE_LAST_NAME The last name attribute provided by Apple.
static ProviderAttribute	APPLE_NAME The name attribute provided by Apple.
static ProviderAttribute	FACEBOOK_BIRTHDAY The birthday attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_EMAIL The email attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_FIRST_NAME The first name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_GENDER The gender attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_ID The user id attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_LAST_NAME The last name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_LOCALE The locale attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_MIDDLE_NAME The middle name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_NAME The name attribute provided by Facebook.
static ProviderAttribute	GOOGLE_BIRTHDAYS The birthday attribute provided by Google.
static ProviderAttribute	GOOGLE_EMAIL The email attribute provided by Google.
static ProviderAttribute	GOOGLE_FAMILY_NAME The family name attribute provided by Google.
static ProviderAttribute	GOOGLE_GENDER The gender attribute provided by Google.
static ProviderAttribute	GOOGLE_GIVEN_NAME The given name attribute provided by Google.
static ProviderAttribute	GOOGLE_NAME The name attribute provided by Google.
static ProviderAttribute	GOOGLE_NAMES The name attribute provided by Google.
static ProviderAttribute	GOOGLE_PHONE_NUMBERS The phone number attribute provided by Google.
static ProviderAttribute	GOOGLE_PICTURE The picture attribute provided by Google.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProviderAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProviderAttribute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName() The attribute value string as recognized by the provider.
static ProviderAttribute	other(java.lang.String attributeName) Use this to specify an attribute from the identity provider that is not pre-defined in the CDK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AMAZON_EMAIL

public static final ProviderAttribute AMAZON_EMAIL

The email attribute provided by Amazon.

AMAZON_NAME

public static final ProviderAttribute AMAZON_NAME

The name attribute provided by Amazon.

AMAZON_POSTAL_CODE

public static final ProviderAttribute AMAZON_POSTAL_CODE

The postal code attribute provided by Amazon.

AMAZON_USER_ID

public static final ProviderAttribute AMAZON_USER_ID

The user id attribute provided by Amazon.

APPLE_EMAIL

public static final ProviderAttribute APPLE_EMAIL

The email attribute provided by Apple.

APPLE_FIRST_NAME

public static final ProviderAttribute APPLE_FIRST_NAME

The first name attribute provided by Apple.

APPLE_LAST_NAME

public static final ProviderAttribute APPLE_LAST_NAME

The last name attribute provided by Apple.

APPLE_NAME

public static final ProviderAttribute APPLE_NAME

The name attribute provided by Apple.

FACEBOOK_BIRTHDAY

public static final ProviderAttribute FACEBOOK_BIRTHDAY

The birthday attribute provided by Facebook.

FACEBOOK_EMAIL

public static final ProviderAttribute FACEBOOK_EMAIL

The email attribute provided by Facebook.

FACEBOOK_FIRST_NAME

public static final ProviderAttribute FACEBOOK_FIRST_NAME

The first name attribute provided by Facebook.

FACEBOOK_GENDER

public static final ProviderAttribute FACEBOOK_GENDER

The gender attribute provided by Facebook.

FACEBOOK_ID

public static final ProviderAttribute FACEBOOK_ID

The user id attribute provided by Facebook.

FACEBOOK_LAST_NAME

public static final ProviderAttribute FACEBOOK_LAST_NAME

The last name attribute provided by Facebook.

FACEBOOK_LOCALE

public static final ProviderAttribute FACEBOOK_LOCALE

The locale attribute provided by Facebook.

FACEBOOK_MIDDLE_NAME

public static final ProviderAttribute FACEBOOK_MIDDLE_NAME

The middle name attribute provided by Facebook.

FACEBOOK_NAME

public static final ProviderAttribute FACEBOOK_NAME

The name attribute provided by Facebook.

GOOGLE_BIRTHDAYS

public static final ProviderAttribute GOOGLE_BIRTHDAYS

The birthday attribute provided by Google.

GOOGLE_EMAIL

public static final ProviderAttribute GOOGLE_EMAIL

The email attribute provided by Google.

GOOGLE_FAMILY_NAME

public static final ProviderAttribute GOOGLE_FAMILY_NAME

The family name attribute provided by Google.

GOOGLE_GENDER

public static final ProviderAttribute GOOGLE_GENDER

The gender attribute provided by Google.

GOOGLE_GIVEN_NAME

public static final ProviderAttribute GOOGLE_GIVEN_NAME

The given name attribute provided by Google.

GOOGLE_NAME

public static final ProviderAttribute GOOGLE_NAME

The name attribute provided by Google.

GOOGLE_NAMES

public static final ProviderAttribute GOOGLE_NAMES

The name attribute provided by Google.

GOOGLE_PHONE_NUMBERS

public static final ProviderAttribute GOOGLE_PHONE_NUMBERS

The phone number attribute provided by Google.

GOOGLE_PICTURE

public static final ProviderAttribute GOOGLE_PICTURE

The picture attribute provided by Google.

Constructor Detail

ProviderAttribute

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

ProviderAttribute

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

Method Detail

other

public static ProviderAttribute other(java.lang.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

public java.lang.String getAttributeName()

The attribute value string as recognized by the provider.