software.amazon.awssdk.services.connect.model

Interface CreateUserRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateUserRequest

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

Method Summary

Modifier and Type	Method and Description
CreateUserRequest.Builder	directoryUserId(String directoryUserId) The unique identifier for the user account in the directory service directory used for identity management.
CreateUserRequest.Builder	hierarchyGroupId(String hierarchyGroupId) The unique identifier for the hierarchy group to assign to the user created.
default CreateUserRequest.Builder	identityInfo(Consumer<UserIdentityInfo.Builder> identityInfo) Information about the user, including email address, first name, and last name.
CreateUserRequest.Builder	identityInfo(UserIdentityInfo identityInfo) Information about the user, including email address, first name, and last name.
CreateUserRequest.Builder	instanceId(String instanceId) The identifier for your Amazon Connect instance.
CreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateUserRequest.Builder	password(String password) The password for the user account to create.
default CreateUserRequest.Builder	phoneConfig(Consumer<UserPhoneConfig.Builder> phoneConfig) Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
CreateUserRequest.Builder	phoneConfig(UserPhoneConfig phoneConfig) Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
CreateUserRequest.Builder	routingProfileId(String routingProfileId) The unique identifier for the routing profile to assign to the user created.
CreateUserRequest.Builder	securityProfileIds(Collection<String> securityProfileIds) The unique identifier of the security profile to assign to the user created.
CreateUserRequest.Builder	securityProfileIds(String... securityProfileIds) The unique identifier of the security profile to assign to the user created.
CreateUserRequest.Builder	username(String username) The user name in Amazon Connect for the account to create.

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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

overrideConfiguration

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

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

username

CreateUserRequest.Builder username(String username)

The user name in Amazon Connect for the account to create.

Parameters:

username - The user name in Amazon Connect for the account to create.

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 user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

Parameters:

password - The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

Returns:

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

identityInfo

CreateUserRequest.Builder identityInfo(UserIdentityInfo identityInfo)

Information about the user, including email address, first name, and last name.

Parameters:

identityInfo - Information about the user, including email address, first name, and last name.

Returns:

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

identityInfo

default CreateUserRequest.Builder identityInfo(Consumer<UserIdentityInfo.Builder> identityInfo)

Information about the user, including email address, first name, and last name.

This is a convenience that creates an instance of the UserIdentityInfo.Builder avoiding the need to create one manually via UserIdentityInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityInfo(UserIdentityInfo).

Parameters:

identityInfo - a consumer that will call methods on UserIdentityInfo.Builder

Returns:

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

See Also:

identityInfo(UserIdentityInfo)

phoneConfig

CreateUserRequest.Builder phoneConfig(UserPhoneConfig phoneConfig)

Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

Parameters:

phoneConfig - Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

Returns:

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

phoneConfig

default CreateUserRequest.Builder phoneConfig(Consumer<UserPhoneConfig.Builder> phoneConfig)

Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

This is a convenience that creates an instance of the UserPhoneConfig.Builder avoiding the need to create one manually via UserPhoneConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to phoneConfig(UserPhoneConfig).

Parameters:

phoneConfig - a consumer that will call methods on UserPhoneConfig.Builder

Returns:

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

See Also:

phoneConfig(UserPhoneConfig)

directoryUserId

CreateUserRequest.Builder directoryUserId(String directoryUserId)

The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

Parameters:

directoryUserId - The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

Returns:

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

securityProfileIds

CreateUserRequest.Builder securityProfileIds(Collection<String> securityProfileIds)

The unique identifier of the security profile to assign to the user created.

Parameters:

securityProfileIds - The unique identifier of the security profile to assign to the user created.

Returns:

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

securityProfileIds

CreateUserRequest.Builder securityProfileIds(String... securityProfileIds)

The unique identifier of the security profile to assign to the user created.

Parameters:

securityProfileIds - The unique identifier of the security profile to assign to the user created.

Returns:

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

routingProfileId

CreateUserRequest.Builder routingProfileId(String routingProfileId)

The unique identifier for the routing profile to assign to the user created.

Parameters:

routingProfileId - The unique identifier for the routing profile to assign to the user created.

Returns:

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

hierarchyGroupId

CreateUserRequest.Builder hierarchyGroupId(String hierarchyGroupId)

The unique identifier for the hierarchy group to assign to the user created.

Parameters:

hierarchyGroupId - The unique identifier for the hierarchy group to assign to the user created.

Returns:

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

instanceId

CreateUserRequest.Builder instanceId(String instanceId)

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Parameters:

instanceId - The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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 interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.