Interface CreateUserRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateUserRequest.Builder,
,CreateUserRequest> SdkBuilder<CreateUserRequest.Builder,
,CreateUserRequest> SdkPojo
,SdkRequest.Builder
,WorkMailRequest.Builder
- Enclosing class:
CreateUserRequest
-
Method Summary
Modifier and TypeMethodDescriptiondisplayName
(String displayName) The display name for the new user.The first name of the new user.hiddenFromGlobalAddressList
(Boolean hiddenFromGlobalAddressList) If this parameter is enabled, the user will be hidden from the address book.The last name of the new user.The name for the new user.organizationId
(String organizationId) The identifier of the organization for which the user is created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The password for the new user.The role of the new user.The role of the new user.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailRequest.Builder
build
-
Method Details
-
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
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
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
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
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:
-
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:
-
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
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.
-
overrideConfiguration
CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-