software.amazon.awssdk.services.workmail.model

Interface CreateUserRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateUserRequest

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

Method Summary

Modifier and Type	Method and Description
CreateUserRequest.Builder	displayName(String displayName) The display name for the new user.
CreateUserRequest.Builder	firstName(String firstName) The first name of the new user.
CreateUserRequest.Builder	hiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList) If this parameter is enabled, the user will be hidden from the address book.
CreateUserRequest.Builder	lastName(String lastName) The last name of the new user.
CreateUserRequest.Builder	name(String name) The name for the new user.
CreateUserRequest.Builder	organizationId(String organizationId) The identifier of the organization for which the user is created.
CreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateUserRequest.Builder	password(String password) The password for the new user.
CreateUserRequest.Builder	role(String role) The role of the new user.
CreateUserRequest.Builder	role(UserRole role) The role of the new user.

Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailRequest.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

organizationId

CreateUserRequest.Builder organizationId(String organizationId)

The identifier of the organization for which the user is created.

Parameters:

organizationId - The identifier of the organization for which the user is created.

Returns:

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

name

CreateUserRequest.Builder name(String name)

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

Parameters:

name - The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

Returns:

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

displayName

CreateUserRequest.Builder displayName(String displayName)

The display name for the new user.

Parameters:

displayName - The display name for the new user.

Returns:

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

password

CreateUserRequest.Builder password(String password)

The password for the new user.

Parameters:

password - The password for the new user.

Returns:

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

role

CreateUserRequest.Builder role(String role)

The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

Parameters:

role - The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

Returns:

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

See Also:

UserRole, UserRole

role

CreateUserRequest.Builder role(UserRole role)

The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

Parameters:

role - The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

Returns:

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

See Also:

UserRole, UserRole

firstName

CreateUserRequest.Builder firstName(String firstName)

The first name of the new user.

Parameters:

firstName - The first name of the new user.

Returns:

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

lastName

CreateUserRequest.Builder lastName(String lastName)

The last name of the new user.

Parameters:

lastName - The last name of the new user.

Returns:

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

hiddenFromGlobalAddressList

CreateUserRequest.Builder hiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList)

If this parameter is enabled, the user will be hidden from the address book.

Parameters:

hiddenFromGlobalAddressList - If this parameter is enabled, the user will be hidden from the address book.

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