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 identifier of the user account in the directory used for identity management.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityProfileIds() Returns true if the SecurityProfileIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	hierarchyGroupId() The identifier of the hierarchy group for the user.
UserIdentityInfo	identityInfo() The information about the identity of the user.
String	instanceId() The identifier of the Amazon Connect instance.
String	password() The password for the user account.
UserPhoneConfig	phoneConfig() The phone settings for the user.
String	routingProfileId() The identifier of the routing profile for the user.
List<SdkField<?>>	sdkFields()
List<String>	securityProfileIds() The identifier of the security profile for the user.
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() One or more tags.
CreateUserRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() The user name for the account.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

username

public final 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_-.\@]+.

Returns:

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_-.\@]+.

password

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

Returns:

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.

identityInfo

public final UserIdentityInfo identityInfo()

The information about the identity of the user.

Returns:

The information about the identity of the user.

phoneConfig

public final UserPhoneConfig phoneConfig()

The phone settings for the user.

Returns:

The phone settings for the user.

directoryUserId

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

Returns:

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.

hasSecurityProfileIds

public final boolean hasSecurityProfileIds()

Returns true if the SecurityProfileIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityProfileIds

public final List<String> securityProfileIds()

The identifier of the security profile for the user.

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

You can use hasSecurityProfileIds() to see if a value was sent in this field.

Returns:

The identifier of the security profile for the user.

routingProfileId

public final String routingProfileId()

The identifier of the routing profile for the user.

Returns:

The identifier of the routing profile for the user.

hierarchyGroupId

public final String hierarchyGroupId()

The identifier of the hierarchy group for the user.

Returns:

The identifier of the hierarchy group for the user.

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance.

Returns:

The identifier of the Amazon Connect instance.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

One or more tags.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

One or more tags.

toBuilder

public CreateUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo