Package software.amazon.awscdk.services.cognito

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StandardAttributes.Builder	address(StandardAttribute address)	Sets the value of StandardAttributes.getAddress()
StandardAttributes.Builder	birthdate(StandardAttribute birthdate)	Sets the value of StandardAttributes.getBirthdate()
StandardAttributes	build()	Builds the configured instance.
StandardAttributes.Builder	email(StandardAttribute email)	Sets the value of StandardAttributes.getEmail()
StandardAttributes.Builder	emailVerified(StandardAttribute emailVerified)	Deprecated. this is not a standard attribute and was incorrectly added to the CDK.
StandardAttributes.Builder	familyName(StandardAttribute familyName)	Sets the value of StandardAttributes.getFamilyName()
StandardAttributes.Builder	fullname(StandardAttribute fullname)	Sets the value of StandardAttributes.getFullname()
StandardAttributes.Builder	gender(StandardAttribute gender)	Sets the value of StandardAttributes.getGender()
StandardAttributes.Builder	givenName(StandardAttribute givenName)	Sets the value of StandardAttributes.getGivenName()
StandardAttributes.Builder	lastUpdateTime(StandardAttribute lastUpdateTime)	Sets the value of StandardAttributes.getLastUpdateTime()
StandardAttributes.Builder	locale(StandardAttribute locale)	Sets the value of StandardAttributes.getLocale()
StandardAttributes.Builder	middleName(StandardAttribute middleName)	Sets the value of StandardAttributes.getMiddleName()
StandardAttributes.Builder	nickname(StandardAttribute nickname)	Sets the value of StandardAttributes.getNickname()
StandardAttributes.Builder	phoneNumber(StandardAttribute phoneNumber)	Sets the value of StandardAttributes.getPhoneNumber()
StandardAttributes.Builder	phoneNumberVerified(StandardAttribute phoneNumberVerified)	Deprecated. this is not a standard attribute and was incorrectly added to the CDK.
StandardAttributes.Builder	preferredUsername(StandardAttribute preferredUsername)	Sets the value of StandardAttributes.getPreferredUsername()
StandardAttributes.Builder	profilePage(StandardAttribute profilePage)	Sets the value of StandardAttributes.getProfilePage()
StandardAttributes.Builder	profilePicture(StandardAttribute profilePicture)	Sets the value of StandardAttributes.getProfilePicture()
StandardAttributes.Builder	timezone(StandardAttribute timezone)	Sets the value of StandardAttributes.getTimezone()
StandardAttributes.Builder	website(StandardAttribute website)	Sets the value of StandardAttributes.getWebsite()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

address

@Stability(Stable)
public StandardAttributes.Builder address(StandardAttribute address)

Sets the value of StandardAttributes.getAddress()

Parameters:

address - The user's postal address.

Returns:

this

birthdate

@Stability(Stable)
public StandardAttributes.Builder birthdate(StandardAttribute birthdate)

Sets the value of StandardAttributes.getBirthdate()

Parameters:

birthdate - The user's birthday, represented as an ISO 8601:2004 format.

Returns:

this

email

@Stability(Stable)
public StandardAttributes.Builder email(StandardAttribute email)

Sets the value of StandardAttributes.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 of StandardAttributes.getEmailVerified()

Parameters:

emailVerified - DEPRECATED.

Returns:

this

familyName

@Stability(Stable)
public StandardAttributes.Builder familyName(StandardAttribute familyName)

Sets the value of StandardAttributes.getFamilyName()

Parameters:

familyName - The surname or last name of the user.

Returns:

this

fullname

@Stability(Stable)
public StandardAttributes.Builder fullname(StandardAttribute fullname)

Sets the value of StandardAttributes.getFullname()

Parameters:

fullname - The user's full name in displayable form, including all name parts, titles and suffixes.

Returns:

this

gender

@Stability(Stable)
public StandardAttributes.Builder gender(StandardAttribute gender)

Sets the value of StandardAttributes.getGender()

Parameters:

gender - The user's gender.

Returns:

this

givenName

@Stability(Stable)
public StandardAttributes.Builder givenName(StandardAttribute givenName)

Sets the value of StandardAttributes.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 of StandardAttributes.getLastUpdateTime()

Parameters:

lastUpdateTime - The time, the user's information was last updated.

Returns:

this

locale

@Stability(Stable)
public StandardAttributes.Builder locale(StandardAttribute locale)

Sets the value of StandardAttributes.getLocale()

Parameters:

locale - The user's locale, represented as a BCP47 [RFC5646] language tag.

Returns:

this

middleName

@Stability(Stable)
public StandardAttributes.Builder middleName(StandardAttribute middleName)

Sets the value of StandardAttributes.getMiddleName()

Parameters:

middleName - The user's middle name.

Returns:

this

nickname

@Stability(Stable)
public StandardAttributes.Builder nickname(StandardAttribute nickname)

Sets the value of StandardAttributes.getNickname()

Parameters:

nickname - The user's nickname or casual name.

Returns:

this

phoneNumber

@Stability(Stable)
public StandardAttributes.Builder phoneNumber(StandardAttribute phoneNumber)

Sets the value of StandardAttributes.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 of StandardAttributes.getPhoneNumberVerified()

Parameters:

phoneNumberVerified - DEPRECATED.

Returns:

this

preferredUsername

@Stability(Stable)
public StandardAttributes.Builder preferredUsername(StandardAttribute preferredUsername)

Sets the value of StandardAttributes.getPreferredUsername()

Parameters:

preferredUsername - The user's preffered username, different from the immutable user name.

Returns:

this

profilePage

@Stability(Stable)
public StandardAttributes.Builder profilePage(StandardAttribute profilePage)

Sets the value of StandardAttributes.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 of StandardAttributes.getProfilePicture()

Parameters:

profilePicture - The URL to the user's profile picture.

Returns:

this

timezone

@Stability(Stable)
public StandardAttributes.Builder timezone(StandardAttribute timezone)

Sets the value of StandardAttributes.getTimezone()

Parameters:

timezone - The user's time zone.

Returns:

this

website

@Stability(Stable)
public StandardAttributes.Builder website(StandardAttribute website)

Sets the value of StandardAttributes.getWebsite()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public StandardAttributes build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<StandardAttributes>

Returns:

a new instance of StandardAttributes

Throws:

NullPointerException - if any required attribute was not provided