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.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.309Z")
 @Stability(value=Experimental)
public class ProviderAttribute
extends software.amazon.jsii.JsiiObject

(experimental) An attribute available from a third party identity provider.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static ProviderAttribute	AMAZON_EMAIL (experimental) The email attribute provided by Amazon.
static ProviderAttribute	AMAZON_NAME (experimental) The name attribute provided by Amazon.
static ProviderAttribute	AMAZON_POSTAL_CODE (experimental) The postal code attribute provided by Amazon.
static ProviderAttribute	AMAZON_USER_ID (experimental) The user id attribute provided by Amazon.
static ProviderAttribute	APPLE_EMAIL (experimental) The email attribute provided by Apple.
static ProviderAttribute	APPLE_FIRST_NAME (experimental) The first name attribute provided by Apple.
static ProviderAttribute	APPLE_LAST_NAME (experimental) The last name attribute provided by Apple.
static ProviderAttribute	APPLE_NAME (experimental) The name attribute provided by Apple.
static ProviderAttribute	FACEBOOK_BIRTHDAY (experimental) The birthday attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_EMAIL (experimental) The email attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_FIRST_NAME (experimental) The first name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_GENDER (experimental) The gender attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_ID (experimental) The user id attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_LAST_NAME (experimental) The last name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_LOCALE (experimental) The locale attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_MIDDLE_NAME (experimental) The middle name attribute provided by Facebook.
static ProviderAttribute	FACEBOOK_NAME (experimental) The name attribute provided by Facebook.
static ProviderAttribute	GOOGLE_BIRTHDAYS (experimental) The birthday attribute provided by Google.
static ProviderAttribute	GOOGLE_EMAIL (experimental) The email attribute provided by Google.
static ProviderAttribute	GOOGLE_FAMILY_NAME (experimental) The family name attribute provided by Google.
static ProviderAttribute	GOOGLE_GENDER (experimental) The gender attribute provided by Google.
static ProviderAttribute	GOOGLE_GIVEN_NAME (experimental) The given name attribute provided by Google.
static ProviderAttribute	GOOGLE_NAME (experimental) The name attribute provided by Google.
static ProviderAttribute	GOOGLE_NAMES (experimental) The name attribute provided by Google.
static ProviderAttribute	GOOGLE_PHONE_NUMBERS (experimental) The phone number attribute provided by Google.
static ProviderAttribute	GOOGLE_PICTURE (experimental) 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
String	getAttributeName() (experimental) The attribute value string as recognized by the provider.
static ProviderAttribute	other(String attributeName) (experimental) 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 Detail

AMAZON_EMAIL

@Stability(value=Experimental)
public static final ProviderAttribute AMAZON_EMAIL

(experimental) The email attribute provided by Amazon.

AMAZON_NAME

@Stability(value=Experimental)
public static final ProviderAttribute AMAZON_NAME

(experimental) The name attribute provided by Amazon.

AMAZON_POSTAL_CODE

@Stability(value=Experimental)
public static final ProviderAttribute AMAZON_POSTAL_CODE

(experimental) The postal code attribute provided by Amazon.

AMAZON_USER_ID

@Stability(value=Experimental)
public static final ProviderAttribute AMAZON_USER_ID

(experimental) The user id attribute provided by Amazon.

APPLE_EMAIL

@Stability(value=Experimental)
public static final ProviderAttribute APPLE_EMAIL

(experimental) The email attribute provided by Apple.

APPLE_FIRST_NAME

@Stability(value=Experimental)
public static final ProviderAttribute APPLE_FIRST_NAME

(experimental) The first name attribute provided by Apple.

APPLE_LAST_NAME

@Stability(value=Experimental)
public static final ProviderAttribute APPLE_LAST_NAME

(experimental) The last name attribute provided by Apple.

APPLE_NAME

@Stability(value=Experimental)
public static final ProviderAttribute APPLE_NAME

(experimental) The name attribute provided by Apple.

FACEBOOK_BIRTHDAY

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_BIRTHDAY

(experimental) The birthday attribute provided by Facebook.

FACEBOOK_EMAIL

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_EMAIL

(experimental) The email attribute provided by Facebook.

FACEBOOK_FIRST_NAME

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_FIRST_NAME

(experimental) The first name attribute provided by Facebook.

FACEBOOK_GENDER

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_GENDER

(experimental) The gender attribute provided by Facebook.

FACEBOOK_ID

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_ID

(experimental) The user id attribute provided by Facebook.

FACEBOOK_LAST_NAME

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_LAST_NAME

(experimental) The last name attribute provided by Facebook.

FACEBOOK_LOCALE

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_LOCALE

(experimental) The locale attribute provided by Facebook.

FACEBOOK_MIDDLE_NAME

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_MIDDLE_NAME

(experimental) The middle name attribute provided by Facebook.

FACEBOOK_NAME

@Stability(value=Experimental)
public static final ProviderAttribute FACEBOOK_NAME

(experimental) The name attribute provided by Facebook.

GOOGLE_BIRTHDAYS

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_BIRTHDAYS

(experimental) The birthday attribute provided by Google.

GOOGLE_EMAIL

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_EMAIL

(experimental) The email attribute provided by Google.

GOOGLE_FAMILY_NAME

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_FAMILY_NAME

(experimental) The family name attribute provided by Google.

GOOGLE_GENDER

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_GENDER

(experimental) The gender attribute provided by Google.

GOOGLE_GIVEN_NAME

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_GIVEN_NAME

(experimental) The given name attribute provided by Google.

GOOGLE_NAME

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_NAME

(experimental) The name attribute provided by Google.

GOOGLE_NAMES

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_NAMES

(experimental) The name attribute provided by Google.

GOOGLE_PHONE_NUMBERS

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_PHONE_NUMBERS

(experimental) The phone number attribute provided by Google.

GOOGLE_PICTURE

@Stability(value=Experimental)
public static final ProviderAttribute GOOGLE_PICTURE

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

@Stability(value=Experimental)
 @NotNull
public static ProviderAttribute other(@NotNull
                                                                               String attributeName)

(experimental) 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(value=Experimental)
 @NotNull
public String getAttributeName()

(experimental) The attribute value string as recognized by the provider.