Package software.amazon.awscdk.services.cognito

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AttributeMapping.Builder	address(ProviderAttribute address)	Sets the value of AttributeMapping.getAddress()
AttributeMapping.Builder	birthdate(ProviderAttribute birthdate)	Sets the value of AttributeMapping.getBirthdate()
AttributeMapping	build()	Builds the configured instance.
AttributeMapping.Builder	custom(Map<String,? extends ProviderAttribute> custom)	Sets the value of AttributeMapping.getCustom()
AttributeMapping.Builder	email(ProviderAttribute email)	Sets the value of AttributeMapping.getEmail()
AttributeMapping.Builder	familyName(ProviderAttribute familyName)	Sets the value of AttributeMapping.getFamilyName()
AttributeMapping.Builder	fullname(ProviderAttribute fullname)	Sets the value of AttributeMapping.getFullname()
AttributeMapping.Builder	gender(ProviderAttribute gender)	Sets the value of AttributeMapping.getGender()
AttributeMapping.Builder	givenName(ProviderAttribute givenName)	Sets the value of AttributeMapping.getGivenName()
AttributeMapping.Builder	lastUpdateTime(ProviderAttribute lastUpdateTime)	Sets the value of AttributeMapping.getLastUpdateTime()
AttributeMapping.Builder	locale(ProviderAttribute locale)	Sets the value of AttributeMapping.getLocale()
AttributeMapping.Builder	middleName(ProviderAttribute middleName)	Sets the value of AttributeMapping.getMiddleName()
AttributeMapping.Builder	nickname(ProviderAttribute nickname)	Sets the value of AttributeMapping.getNickname()
AttributeMapping.Builder	phoneNumber(ProviderAttribute phoneNumber)	Sets the value of AttributeMapping.getPhoneNumber()
AttributeMapping.Builder	preferredUsername(ProviderAttribute preferredUsername)	Sets the value of AttributeMapping.getPreferredUsername()
AttributeMapping.Builder	profilePage(ProviderAttribute profilePage)	Sets the value of AttributeMapping.getProfilePage()
AttributeMapping.Builder	profilePicture(ProviderAttribute profilePicture)	Sets the value of AttributeMapping.getProfilePicture()
AttributeMapping.Builder	timezone(ProviderAttribute timezone)	Sets the value of AttributeMapping.getTimezone()
AttributeMapping.Builder	website(ProviderAttribute website)	Sets the value of AttributeMapping.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 AttributeMapping.Builder address(ProviderAttribute address)

Sets the value of AttributeMapping.getAddress()

Parameters:

address - The user's postal address is a required attribute.

Returns:

this

birthdate

@Stability(Stable)
public AttributeMapping.Builder birthdate(ProviderAttribute birthdate)

Sets the value of AttributeMapping.getBirthdate()

Parameters:

birthdate - The user's birthday.

Returns:

this

custom

@Stability(Stable)
public AttributeMapping.Builder custom(Map<String,? extends ProviderAttribute> custom)

Sets the value of AttributeMapping.getCustom()

Parameters:

custom - Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

Returns:

this

email

@Stability(Stable)
public AttributeMapping.Builder email(ProviderAttribute email)

Sets the value of AttributeMapping.getEmail()

Parameters:

email - The user's e-mail address.

Returns:

this

familyName

@Stability(Stable)
public AttributeMapping.Builder familyName(ProviderAttribute familyName)

Sets the value of AttributeMapping.getFamilyName()

Parameters:

familyName - The surname or last name of user.

Returns:

this

fullname

@Stability(Stable)
public AttributeMapping.Builder fullname(ProviderAttribute fullname)

Sets the value of AttributeMapping.getFullname()

Parameters:

fullname - The user's full name in displayable form.

Returns:

this

gender

@Stability(Stable)
public AttributeMapping.Builder gender(ProviderAttribute gender)

Sets the value of AttributeMapping.getGender()

Parameters:

gender - The user's gender.

Returns:

this

givenName

@Stability(Stable)
public AttributeMapping.Builder givenName(ProviderAttribute givenName)

Sets the value of AttributeMapping.getGivenName()

Parameters:

givenName - The user's first name or give name.

Returns:

this

lastUpdateTime

@Stability(Stable)
public AttributeMapping.Builder lastUpdateTime(ProviderAttribute lastUpdateTime)

Sets the value of AttributeMapping.getLastUpdateTime()

Parameters:

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

Returns:

this

locale

@Stability(Stable)
public AttributeMapping.Builder locale(ProviderAttribute locale)

Sets the value of AttributeMapping.getLocale()

Parameters:

locale - The user's locale.

Returns:

this

middleName

@Stability(Stable)
public AttributeMapping.Builder middleName(ProviderAttribute middleName)

Sets the value of AttributeMapping.getMiddleName()

Parameters:

middleName - The user's middle name.

Returns:

this

nickname

@Stability(Stable)
public AttributeMapping.Builder nickname(ProviderAttribute nickname)

Sets the value of AttributeMapping.getNickname()

Parameters:

nickname - The user's nickname or casual name.

Returns:

this

phoneNumber

@Stability(Stable)
public AttributeMapping.Builder phoneNumber(ProviderAttribute phoneNumber)

Sets the value of AttributeMapping.getPhoneNumber()

Parameters:

phoneNumber - The user's telephone number.

Returns:

this

preferredUsername

@Stability(Stable)
public AttributeMapping.Builder preferredUsername(ProviderAttribute preferredUsername)

Sets the value of AttributeMapping.getPreferredUsername()

Parameters:

preferredUsername - The user's preferred username.

Returns:

this

profilePage

@Stability(Stable)
public AttributeMapping.Builder profilePage(ProviderAttribute profilePage)

Sets the value of AttributeMapping.getProfilePage()

Parameters:

profilePage - The URL to the user's profile page.

Returns:

this

profilePicture

@Stability(Stable)
public AttributeMapping.Builder profilePicture(ProviderAttribute profilePicture)

Sets the value of AttributeMapping.getProfilePicture()

Parameters:

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

Returns:

this

timezone

@Stability(Stable)
public AttributeMapping.Builder timezone(ProviderAttribute timezone)

Sets the value of AttributeMapping.getTimezone()

Parameters:

timezone - The user's time zone.

Returns:

this

website

@Stability(Stable)
public AttributeMapping.Builder website(ProviderAttribute website)

Sets the value of AttributeMapping.getWebsite()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AttributeMapping build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AttributeMapping

Throws:

NullPointerException - if any required attribute was not provided