Package software.amazon.awssdk.services.connect.model

Class UserIdentityInfo

java.lang.Object

software.amazon.awssdk.services.connect.model.UserIdentityInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UserIdentityInfo.Builder,UserIdentityInfo>

@Generated("software.amazon.awssdk:codegen")
public final class UserIdentityInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserIdentityInfo.Builder,UserIdentityInfo>

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserIdentityInfo.Builder

Method Summary

Modifier and Type	Method	Description
static UserIdentityInfo.Builder	builder()
String	email()	The email address.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	The first name.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastName()	The last name.
String	mobile()	The user's mobile number.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secondaryEmail()	The user's secondary email address.
static Class<? extends UserIdentityInfo.Builder>	serializableBuilderClass()
UserIdentityInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

firstName

public final String firstName()

The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

Returns:

The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

lastName

public final String lastName()

The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

Returns:

The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

email

public final String email()

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

Returns:

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

secondaryEmail

public final String secondaryEmail()

The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

Returns:

The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

mobile

public final String mobile()

The user's mobile number.

Returns:

The user's mobile number.

toBuilder

public UserIdentityInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserIdentityInfo.Builder,UserIdentityInfo>

builder

public static UserIdentityInfo.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo