Interface AttributeMapping
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AttributeMapping.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-09-06T01:36:25.476Z")
@Stability(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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forAttributeMapping
static final class
An implementation forAttributeMapping
-
Method Summary
Modifier and TypeMethodDescriptionstatic AttributeMapping.Builder
builder()
default ProviderAttribute
The user's postal address is a required attribute.default ProviderAttribute
The user's birthday.default Map<String,
ProviderAttribute> 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
The surname or last name of user.default ProviderAttribute
The user's full name in displayable form.default ProviderAttribute
The user's gender.default ProviderAttribute
The user's first name or give name.default ProviderAttribute
Time, the user's information was last updated.default ProviderAttribute
The user's locale.default ProviderAttribute
The user's middle name.default ProviderAttribute
The user's nickname or casual name.default ProviderAttribute
The user's telephone number.default ProviderAttribute
The user's preferred username.default ProviderAttribute
The URL to the user's profile page.default ProviderAttribute
The URL to the user's profile picture.default ProviderAttribute
The user's time zone.default ProviderAttribute
The URL to the user's web page or blog.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAddress
The user's postal address is a required attribute.Default: - not mapped
-
getBirthdate
The user's birthday.Default: - not mapped
-
getCustom
Specify custom attribute mapping here and mapping for any standard attributes not supported yet.Default: - no custom attribute mapping
-
getEmail
The user's e-mail address.Default: - not mapped
-
getFamilyName
The surname or last name of user.Default: - not mapped
-
getFullname
The user's full name in displayable form.Default: - not mapped
-
getGender
The user's gender.Default: - not mapped
-
getGivenName
The user's first name or give name.Default: - not mapped
-
getLastUpdateTime
Time, the user's information was last updated.Default: - not mapped
-
getLocale
The user's locale.Default: - not mapped
-
getMiddleName
The user's middle name.Default: - not mapped
-
getNickname
The user's nickname or casual name.Default: - not mapped
-
getPhoneNumber
The user's telephone number.Default: - not mapped
-
getPreferredUsername
The user's preferred username.Default: - not mapped
-
getProfilePage
The URL to the user's profile page.Default: - not mapped
-
getProfilePicture
The URL to the user's profile picture.Default: - not mapped
-
getTimezone
The user's time zone.Default: - not mapped
-
getWebsite
The URL to the user's web page or blog.Default: - not mapped
-
builder
- Returns:
- a
AttributeMapping.Builder
ofAttributeMapping
-