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 identifier of the user account in the directory used for identity management.
CreateUserRequest.Builder	hierarchyGroupId(String hierarchyGroupId) The identifier of the hierarchy group for the user.
default CreateUserRequest.Builder	identityInfo(Consumer<UserIdentityInfo.Builder> identityInfo) The information about the identity of the user.
CreateUserRequest.Builder	identityInfo(UserIdentityInfo identityInfo) The information about the identity of the user.
CreateUserRequest.Builder	instanceId(String instanceId) The identifier of the Amazon Connect instance.
CreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateUserRequest.Builder	password(String password) The password for the user account.
default CreateUserRequest.Builder	phoneConfig(Consumer<UserPhoneConfig.Builder> phoneConfig) The phone settings for the user.
CreateUserRequest.Builder	phoneConfig(UserPhoneConfig phoneConfig) The phone settings for the user.
CreateUserRequest.Builder	routingProfileId(String routingProfileId) The identifier of the routing profile for the user.
CreateUserRequest.Builder	securityProfileIds(Collection<String> securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest.Builder	securityProfileIds(String... securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest.Builder	tags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.
CreateUserRequest.Builder	username(String username) The user name for the account.

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

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

username

CreateUserRequest.Builder username(String username)

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Parameters:

username - The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

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. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Parameters:

password - The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Returns:

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

identityInfo

CreateUserRequest.Builder identityInfo(UserIdentityInfo identityInfo)

The information about the identity of the user.

Parameters:

identityInfo - The information about the identity of the user.

Returns:

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

identityInfo

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

The information about the identity of the user.

This is a convenience method 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)

The phone settings for the user.

Parameters:

phoneConfig - The phone settings for the user.

Returns:

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

phoneConfig

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

The phone settings for the user.

This is a convenience method 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 identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your 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 error is returned.

Parameters:

directoryUserId - The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your 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 error 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 identifier of the security profile for the user.

Parameters:

securityProfileIds - The identifier of the security profile for the user.

Returns:

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

securityProfileIds

CreateUserRequest.Builder securityProfileIds(String... securityProfileIds)

The identifier of the security profile for the user.

Parameters:

securityProfileIds - The identifier of the security profile for the user.

Returns:

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

routingProfileId

CreateUserRequest.Builder routingProfileId(String routingProfileId)

The identifier of the routing profile for the user.

Parameters:

routingProfileId - The identifier of the routing profile for the user.

Returns:

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

hierarchyGroupId

CreateUserRequest.Builder hierarchyGroupId(String hierarchyGroupId)

The identifier of the hierarchy group for the user.

Parameters:

hierarchyGroupId - The identifier of the hierarchy group for the user.

Returns:

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

instanceId

CreateUserRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

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

tags

CreateUserRequest.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Parameters:

tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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