software.amazon.awssdk.services.identitystore.model

Interface CreateUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>, IdentitystoreRequest.Builder, SdkBuilder<CreateUserRequest.Builder,CreateUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateUserRequest

public static interface CreateUserRequest.Builder
extends IdentitystoreRequest.Builder, SdkPojo, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Method Summary

Modifier and Type	Method and Description
CreateUserRequest.Builder	addresses(Address... addresses) A list of Address objects containing addresses associated with the user.
CreateUserRequest.Builder	addresses(Collection<Address> addresses) A list of Address objects containing addresses associated with the user.
CreateUserRequest.Builder	addresses(Consumer<Address.Builder>... addresses) A list of Address objects containing addresses associated with the user.
CreateUserRequest.Builder	displayName(String displayName) A string containing the user's name.
CreateUserRequest.Builder	emails(Collection<Email> emails) A list of Email objects containing email addresses associated with the user.
CreateUserRequest.Builder	emails(Consumer<Email.Builder>... emails) A list of Email objects containing email addresses associated with the user.
CreateUserRequest.Builder	emails(Email... emails) A list of Email objects containing email addresses associated with the user.
CreateUserRequest.Builder	identityStoreId(String identityStoreId) The globally unique identifier for the identity store.
CreateUserRequest.Builder	locale(String locale) A string containing the user's geographical region or location.
default CreateUserRequest.Builder	name(Consumer<Name.Builder> name) An object containing the user's name.
CreateUserRequest.Builder	name(Name name) An object containing the user's name.
CreateUserRequest.Builder	nickName(String nickName) A string containing an alternate name for the user.
CreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateUserRequest.Builder	phoneNumbers(Collection<PhoneNumber> phoneNumbers) A list of PhoneNumber objects containing phone numbers associated with the user.
CreateUserRequest.Builder	phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers) A list of PhoneNumber objects containing phone numbers associated with the user.
CreateUserRequest.Builder	phoneNumbers(PhoneNumber... phoneNumbers) A list of PhoneNumber objects containing phone numbers associated with the user.
CreateUserRequest.Builder	preferredLanguage(String preferredLanguage) A string containing the preferred language of the user.
CreateUserRequest.Builder	profileUrl(String profileUrl) A string containing a URL that may be associated with the user.
CreateUserRequest.Builder	timezone(String timezone) A string containing the user's time zone.
CreateUserRequest.Builder	title(String title) A string containing the user's title.
CreateUserRequest.Builder	userName(String userName) A unique string used to identify the user.
CreateUserRequest.Builder	userType(String userType) A string indicating the user's type.

Methods inherited from interface software.amazon.awssdk.services.identitystore.model.IdentitystoreRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

identityStoreId

CreateUserRequest.Builder identityStoreId(String identityStoreId)

The globally unique identifier for the identity store.

Parameters:

identityStoreId - The globally unique identifier for the identity store.

Returns:

Returns a reference to this object so that method calls can be chained together.

userName

CreateUserRequest.Builder userName(String userName)

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

Parameters:

userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateUserRequest.Builder name(Name name)

An object containing the user's name.

Parameters:

name - An object containing the user's name.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

default CreateUserRequest.Builder name(Consumer<Name.Builder> name)

An object containing the user's name.

This is a convenience method that creates an instance of the Name.Builder avoiding the need to create one manually via Name.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to name(Name).

Parameters:

name - a consumer that will call methods on Name.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

name(Name)

displayName

CreateUserRequest.Builder displayName(String displayName)

A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."

Parameters:

displayName - A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."

Returns:

Returns a reference to this object so that method calls can be chained together.

nickName

CreateUserRequest.Builder nickName(String nickName)

A string containing an alternate name for the user.

Parameters:

nickName - A string containing an alternate name for the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

profileUrl

CreateUserRequest.Builder profileUrl(String profileUrl)

A string containing a URL that may be associated with the user.

Parameters:

profileUrl - A string containing a URL that may be associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

CreateUserRequest.Builder emails(Collection<Email> emails)

A list of Email objects containing email addresses associated with the user.

Parameters:

emails - A list of Email objects containing email addresses associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

CreateUserRequest.Builder emails(Email... emails)

A list of Email objects containing email addresses associated with the user.

Parameters:

emails - A list of Email objects containing email addresses associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

CreateUserRequest.Builder emails(Consumer<Email.Builder>... emails)

A list of Email objects containing email addresses associated with the user.

This is a convenience method that creates an instance of the Email.Builder avoiding the need to create one manually via Email.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #emails(List).

Parameters:

emails - a consumer that will call methods on Email.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#emails(java.util.Collection)

addresses

CreateUserRequest.Builder addresses(Collection<Address> addresses)

A list of Address objects containing addresses associated with the user.

Parameters:

addresses - A list of Address objects containing addresses associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

addresses

CreateUserRequest.Builder addresses(Address... addresses)

A list of Address objects containing addresses associated with the user.

Parameters:

addresses - A list of Address objects containing addresses associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

addresses

CreateUserRequest.Builder addresses(Consumer<Address.Builder>... addresses)

A list of Address objects containing addresses associated with the user.

This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #addresses(List

).

Parameters:

addresses - a consumer that will call methods on Address.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#addresses(java.util.Collection

)

phoneNumbers

CreateUserRequest.Builder phoneNumbers(Collection<PhoneNumber> phoneNumbers)

A list of PhoneNumber objects containing phone numbers associated with the user.

Parameters:

phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

phoneNumbers

CreateUserRequest.Builder phoneNumbers(PhoneNumber... phoneNumbers)

A list of PhoneNumber objects containing phone numbers associated with the user.

Parameters:

phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

phoneNumbers

CreateUserRequest.Builder phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers)

A list of PhoneNumber objects containing phone numbers associated with the user.

This is a convenience method that creates an instance of the PhoneNumber.Builder avoiding the need to create one manually via PhoneNumber.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #phoneNumbers(List).

Parameters:

phoneNumbers - a consumer that will call methods on PhoneNumber.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#phoneNumbers(java.util.Collection)

userType

CreateUserRequest.Builder userType(String userType)

A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

Parameters:

userType - A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

Returns:

Returns a reference to this object so that method calls can be chained together.

title

CreateUserRequest.Builder title(String title)

A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.

Parameters:

title - A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredLanguage

CreateUserRequest.Builder preferredLanguage(String preferredLanguage)

A string containing the preferred language of the user. For example, "American English" or "en-us."

Parameters:

preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."

Returns:

Returns a reference to this object so that method calls can be chained together.

locale

CreateUserRequest.Builder locale(String locale)

A string containing the user's geographical region or location.

Parameters:

locale - A string containing the user's geographical region or location.

Returns:

Returns a reference to this object so that method calls can be chained together.

timezone

CreateUserRequest.Builder timezone(String timezone)

A string containing the user's time zone.

Parameters:

timezone - A string containing the user's time zone.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder