Class StandardAttributes.Builder
java.lang.Object
software.amazon.awscdk.services.cognito.StandardAttributes.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<StandardAttributes>
- Enclosing interface:
StandardAttributes
@Stability(Stable)
public static final class StandardAttributes.Builder
extends Object
implements software.amazon.jsii.Builder<StandardAttributes>
A builder for
StandardAttributes
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddress
(StandardAttribute address) Sets the value ofStandardAttributes.getAddress()
birthdate
(StandardAttribute birthdate) Sets the value ofStandardAttributes.getBirthdate()
build()
Builds the configured instance.email
(StandardAttribute email) Sets the value ofStandardAttributes.getEmail()
emailVerified
(StandardAttribute emailVerified) Deprecated.this is not a standard attribute and was incorrectly added to the CDK.familyName
(StandardAttribute familyName) Sets the value ofStandardAttributes.getFamilyName()
fullname
(StandardAttribute fullname) Sets the value ofStandardAttributes.getFullname()
gender
(StandardAttribute gender) Sets the value ofStandardAttributes.getGender()
givenName
(StandardAttribute givenName) Sets the value ofStandardAttributes.getGivenName()
lastUpdateTime
(StandardAttribute lastUpdateTime) Sets the value ofStandardAttributes.getLastUpdateTime()
locale
(StandardAttribute locale) Sets the value ofStandardAttributes.getLocale()
middleName
(StandardAttribute middleName) Sets the value ofStandardAttributes.getMiddleName()
nickname
(StandardAttribute nickname) Sets the value ofStandardAttributes.getNickname()
phoneNumber
(StandardAttribute phoneNumber) Sets the value ofStandardAttributes.getPhoneNumber()
phoneNumberVerified
(StandardAttribute phoneNumberVerified) Deprecated.this is not a standard attribute and was incorrectly added to the CDK.preferredUsername
(StandardAttribute preferredUsername) Sets the value ofStandardAttributes.getPreferredUsername()
profilePage
(StandardAttribute profilePage) Sets the value ofStandardAttributes.getProfilePage()
profilePicture
(StandardAttribute profilePicture) Sets the value ofStandardAttributes.getProfilePicture()
timezone
(StandardAttribute timezone) Sets the value ofStandardAttributes.getTimezone()
website
(StandardAttribute website) Sets the value ofStandardAttributes.getWebsite()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
address
Sets the value ofStandardAttributes.getAddress()
- Parameters:
address
- The user's postal address.- Returns:
this
-
birthdate
Sets the value ofStandardAttributes.getBirthdate()
- Parameters:
birthdate
- The user's birthday, represented as an ISO 8601:2004 format.- Returns:
this
-
email
Sets the value ofStandardAttributes.getEmail()
- Parameters:
email
- The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.- Returns:
this
-
emailVerified
@Stability(Deprecated) @Deprecated public StandardAttributes.Builder emailVerified(StandardAttribute emailVerified) Deprecated.this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.Sets the value ofStandardAttributes.getEmailVerified()
- Parameters:
emailVerified
- DEPRECATED.- Returns:
this
-
familyName
Sets the value ofStandardAttributes.getFamilyName()
- Parameters:
familyName
- The surname or last name of the user.- Returns:
this
-
fullname
Sets the value ofStandardAttributes.getFullname()
- Parameters:
fullname
- The user's full name in displayable form, including all name parts, titles and suffixes.- Returns:
this
-
gender
Sets the value ofStandardAttributes.getGender()
- Parameters:
gender
- The user's gender.- Returns:
this
-
givenName
Sets the value ofStandardAttributes.getGivenName()
- Parameters:
givenName
- The user's first name or give name.- Returns:
this
-
lastUpdateTime
@Stability(Stable) public StandardAttributes.Builder lastUpdateTime(StandardAttribute lastUpdateTime) Sets the value ofStandardAttributes.getLastUpdateTime()
- Parameters:
lastUpdateTime
- The time, the user's information was last updated.- Returns:
this
-
locale
Sets the value ofStandardAttributes.getLocale()
- Parameters:
locale
- The user's locale, represented as a BCP47 [RFC5646] language tag.- Returns:
this
-
middleName
Sets the value ofStandardAttributes.getMiddleName()
- Parameters:
middleName
- The user's middle name.- Returns:
this
-
nickname
Sets the value ofStandardAttributes.getNickname()
- Parameters:
nickname
- The user's nickname or casual name.- Returns:
this
-
phoneNumber
Sets the value ofStandardAttributes.getPhoneNumber()
- Parameters:
phoneNumber
- The user's telephone number.- Returns:
this
-
phoneNumberVerified
@Stability(Deprecated) @Deprecated public StandardAttributes.Builder phoneNumberVerified(StandardAttribute phoneNumberVerified) Deprecated.this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.Sets the value ofStandardAttributes.getPhoneNumberVerified()
- Parameters:
phoneNumberVerified
- DEPRECATED.- Returns:
this
-
preferredUsername
@Stability(Stable) public StandardAttributes.Builder preferredUsername(StandardAttribute preferredUsername) Sets the value ofStandardAttributes.getPreferredUsername()
- Parameters:
preferredUsername
- The user's preffered username, different from the immutable user name.- Returns:
this
-
profilePage
Sets the value ofStandardAttributes.getProfilePage()
- Parameters:
profilePage
- The URL to the user's profile page.- Returns:
this
-
profilePicture
@Stability(Stable) public StandardAttributes.Builder profilePicture(StandardAttribute profilePicture) Sets the value ofStandardAttributes.getProfilePicture()
- Parameters:
profilePicture
- The URL to the user's profile picture.- Returns:
this
-
timezone
Sets the value ofStandardAttributes.getTimezone()
- Parameters:
timezone
- The user's time zone.- Returns:
this
-
website
Sets the value ofStandardAttributes.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<StandardAttributes>
- Returns:
- a new instance of
StandardAttributes
- Throws:
NullPointerException
- if any required attribute was not provided
-