software.amazon.awssdk.services.connect.model

Class CreateUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.CreateUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends ConnectRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateUserRequest.Builder	builder()
String	directoryUserId() The unique identifier for the user account in the directory service directory used for identity management.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	hierarchyGroupId() The unique identifier for the hierarchy group to assign to the user created.
UserIdentityInfo	identityInfo() Information about the user, including email address, first name, and last name.
String	instanceId() The identifier for your Amazon Connect instance.
String	password() The password for the user account to create.
UserPhoneConfig	phoneConfig() Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
String	routingProfileId() The unique identifier for the routing profile to assign to the user created.
List<SdkField<?>>	sdkFields()
List<String>	securityProfileIds() The unique identifier of the security profile to assign to the user created.
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
CreateUserRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	username() The user name in Amazon Connect for the account to create.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

username

public String username()

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

Returns:

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

password

public 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.

Returns:

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.

identityInfo

public UserIdentityInfo identityInfo()

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

Returns:

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

phoneConfig

public UserPhoneConfig phoneConfig()

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

Returns:

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

directoryUserId

public 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.

Returns:

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.

securityProfileIds

public List<String> securityProfileIds()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

routingProfileId

public String routingProfileId()

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

Returns:

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

hierarchyGroupId

public String hierarchyGroupId()

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

Returns:

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

instanceId

public 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.

Returns:

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.

toBuilder

public CreateUserRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class ConnectRequest

Returns:

a builder for type T

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.