Class AttributeMapping.Builder
java.lang.Object
software.amazon.awscdk.services.cognito.AttributeMapping.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<AttributeMapping>
- Enclosing interface:
AttributeMapping
@Stability(Stable)
public static final class AttributeMapping.Builder
extends Object
implements software.amazon.jsii.Builder<AttributeMapping>
A builder for
AttributeMapping
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddress
(ProviderAttribute address) Sets the value ofAttributeMapping.getAddress()
birthdate
(ProviderAttribute birthdate) Sets the value ofAttributeMapping.getBirthdate()
build()
Builds the configured instance.custom
(Map<String, ? extends ProviderAttribute> custom) Sets the value ofAttributeMapping.getCustom()
email
(ProviderAttribute email) Sets the value ofAttributeMapping.getEmail()
emailVerified
(ProviderAttribute emailVerified) Sets the value ofAttributeMapping.getEmailVerified()
familyName
(ProviderAttribute familyName) Sets the value ofAttributeMapping.getFamilyName()
fullname
(ProviderAttribute fullname) Sets the value ofAttributeMapping.getFullname()
gender
(ProviderAttribute gender) Sets the value ofAttributeMapping.getGender()
givenName
(ProviderAttribute givenName) Sets the value ofAttributeMapping.getGivenName()
lastUpdateTime
(ProviderAttribute lastUpdateTime) Sets the value ofAttributeMapping.getLastUpdateTime()
locale
(ProviderAttribute locale) Sets the value ofAttributeMapping.getLocale()
middleName
(ProviderAttribute middleName) Sets the value ofAttributeMapping.getMiddleName()
nickname
(ProviderAttribute nickname) Sets the value ofAttributeMapping.getNickname()
phoneNumber
(ProviderAttribute phoneNumber) Sets the value ofAttributeMapping.getPhoneNumber()
preferredUsername
(ProviderAttribute preferredUsername) Sets the value ofAttributeMapping.getPreferredUsername()
profilePage
(ProviderAttribute profilePage) Sets the value ofAttributeMapping.getProfilePage()
profilePicture
(ProviderAttribute profilePicture) Sets the value ofAttributeMapping.getProfilePicture()
timezone
(ProviderAttribute timezone) Sets the value ofAttributeMapping.getTimezone()
website
(ProviderAttribute website) Sets the value ofAttributeMapping.getWebsite()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
address
Sets the value ofAttributeMapping.getAddress()
- Parameters:
address
- The user's postal address is a required attribute.- Returns:
this
-
birthdate
Sets the value ofAttributeMapping.getBirthdate()
- Parameters:
birthdate
- The user's birthday.- Returns:
this
-
custom
@Stability(Stable) public AttributeMapping.Builder custom(Map<String, ? extends ProviderAttribute> custom) Sets the value ofAttributeMapping.getCustom()
- Parameters:
custom
- Specify custom attribute mapping here and mapping for any standard attributes not supported yet.- Returns:
this
-
email
Sets the value ofAttributeMapping.getEmail()
- Parameters:
email
- The user's e-mail address.- Returns:
this
-
emailVerified
Sets the value ofAttributeMapping.getEmailVerified()
- Parameters:
emailVerified
- The user's e-mail address is verification.- Returns:
this
-
familyName
Sets the value ofAttributeMapping.getFamilyName()
- Parameters:
familyName
- The surname or last name of user.- Returns:
this
-
fullname
Sets the value ofAttributeMapping.getFullname()
- Parameters:
fullname
- The user's full name in displayable form.- Returns:
this
-
gender
Sets the value ofAttributeMapping.getGender()
- Parameters:
gender
- The user's gender.- Returns:
this
-
givenName
Sets the value ofAttributeMapping.getGivenName()
- Parameters:
givenName
- The user's first name or give name.- Returns:
this
-
lastUpdateTime
Sets the value ofAttributeMapping.getLastUpdateTime()
- Parameters:
lastUpdateTime
- Time, the user's information was last updated.- Returns:
this
-
locale
Sets the value ofAttributeMapping.getLocale()
- Parameters:
locale
- The user's locale.- Returns:
this
-
middleName
Sets the value ofAttributeMapping.getMiddleName()
- Parameters:
middleName
- The user's middle name.- Returns:
this
-
nickname
Sets the value ofAttributeMapping.getNickname()
- Parameters:
nickname
- The user's nickname or casual name.- Returns:
this
-
phoneNumber
Sets the value ofAttributeMapping.getPhoneNumber()
- Parameters:
phoneNumber
- The user's telephone number.- Returns:
this
-
preferredUsername
@Stability(Stable) public AttributeMapping.Builder preferredUsername(ProviderAttribute preferredUsername) Sets the value ofAttributeMapping.getPreferredUsername()
- Parameters:
preferredUsername
- The user's preferred username.- Returns:
this
-
profilePage
Sets the value ofAttributeMapping.getProfilePage()
- Parameters:
profilePage
- The URL to the user's profile page.- Returns:
this
-
profilePicture
Sets the value ofAttributeMapping.getProfilePicture()
- Parameters:
profilePicture
- The URL to the user's profile picture.- Returns:
this
-
timezone
Sets the value ofAttributeMapping.getTimezone()
- Parameters:
timezone
- The user's time zone.- Returns:
this
-
website
Sets the value ofAttributeMapping.getWebsite()
- Parameters:
website
- The URL to the user's web page or blog.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AttributeMapping>
- Returns:
- a new instance of
AttributeMapping
- Throws:
NullPointerException
- if any required attribute was not provided
-