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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.599Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AttributeMapping.Builder A builder for AttributeMapping
static class	AttributeMapping.Jsii$Proxy An implementation for AttributeMapping

Method Summary

Modifier and Type	Method and Description
static AttributeMapping.Builder	builder()
default ProviderAttribute	getAddress() The user's postal address is a required attribute.
default ProviderAttribute	getBirthdate() The user's birthday.
default Map<String,ProviderAttribute>	getCustom() Specify custom attribute mapping here and mapping for any standard attributes not supported yet.
default ProviderAttribute	getEmail() The user's e-mail address.
default ProviderAttribute	getFamilyName() The surname or last name of user.
default ProviderAttribute	getFullname() The user's full name in displayable form.
default ProviderAttribute	getGender() The user's gender.
default ProviderAttribute	getGivenName() The user's first name or give name.
default ProviderAttribute	getLastUpdateTime() Time, the user's information was last updated.
default ProviderAttribute	getLocale() The user's locale.
default ProviderAttribute	getMiddleName() The user's middle name.
default ProviderAttribute	getNickname() The user's nickname or casual name.
default ProviderAttribute	getPhoneNumber() The user's telephone number.
default ProviderAttribute	getPreferredUsername() The user's preferred username.
default ProviderAttribute	getProfilePage() The URL to the user's profile page.
default ProviderAttribute	getProfilePicture() The URL to the user's profile picture.
default ProviderAttribute	getTimezone() The user's time zone.
default ProviderAttribute	getWebsite() The URL to the user's web page or blog.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddress

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getAddress()

The user's postal address is a required attribute.

Default: - not mapped

getBirthdate

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getBirthdate()

The user's birthday.

Default: - not mapped

getCustom

@Stability(value=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(value=Stable)
 @Nullable
default ProviderAttribute getEmail()

The user's e-mail address.

Default: - not mapped

getFamilyName

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getFamilyName()

The surname or last name of user.

Default: - not mapped

getFullname

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getFullname()

The user's full name in displayable form.

Default: - not mapped

getGender

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getGender()

The user's gender.

Default: - not mapped

getGivenName

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getGivenName()

The user's first name or give name.

Default: - not mapped

getLastUpdateTime

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getLastUpdateTime()

Time, the user's information was last updated.

Default: - not mapped

getLocale

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getLocale()

The user's locale.

Default: - not mapped

getMiddleName

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getMiddleName()

The user's middle name.

Default: - not mapped

getNickname

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getNickname()

The user's nickname or casual name.

Default: - not mapped

getPhoneNumber

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getPhoneNumber()

The user's telephone number.

Default: - not mapped

getPreferredUsername

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getPreferredUsername()

The user's preferred username.

Default: - not mapped

getProfilePage

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getProfilePage()

The URL to the user's profile page.

Default: - not mapped

getProfilePicture

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getProfilePicture()

The URL to the user's profile picture.

Default: - not mapped

getTimezone

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getTimezone()

The user's time zone.

Default: - not mapped

getWebsite

@Stability(value=Stable)
 @Nullable
default ProviderAttribute getWebsite()

The URL to the user's web page or blog.

Default: - not mapped

builder

@Stability(value=Stable)
static AttributeMapping.Builder builder()

Returns:

a AttributeMapping.Builder of AttributeMapping