com.amazonaws.services.cognitoidentityprovider.model

Class UserType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.UserType

All Implemented Interfaces:

Serializable

public class UserType
extends Object
implements Serializable

The user type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AttributeType>	getAttributes() A container with information about the user type attributes.
Boolean	getEnabled() Specifies whether the user is enabled.
List<MFAOptionType>	getMFAOptions() The MFA options for the user.
Date	getUserCreateDate() The creation date of the user.
Date	getUserLastModifiedDate() The last modified date of the user.
String	getUsername() The user name of the user you wish to describe.
String	getUserStatus() The user status.
int	hashCode()
Boolean	isEnabled() Specifies whether the user is enabled.
void	setAttributes(Collection<AttributeType> attributes) A container with information about the user type attributes.
void	setEnabled(Boolean enabled) Specifies whether the user is enabled.
void	setMFAOptions(Collection<MFAOptionType> mFAOptions) The MFA options for the user.
void	setUserCreateDate(Date userCreateDate) The creation date of the user.
void	setUserLastModifiedDate(Date userLastModifiedDate) The last modified date of the user.
void	setUsername(String username) The user name of the user you wish to describe.
void	setUserStatus(String userStatus) The user status.
void	setUserStatus(UserStatusType userStatus) The user status.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UserType	withAttributes(AttributeType... attributes) A container with information about the user type attributes.
UserType	withAttributes(Collection<AttributeType> attributes) A container with information about the user type attributes.
UserType	withEnabled(Boolean enabled) Specifies whether the user is enabled.
UserType	withMFAOptions(Collection<MFAOptionType> mFAOptions) The MFA options for the user.
UserType	withMFAOptions(MFAOptionType... mFAOptions) The MFA options for the user.
UserType	withUserCreateDate(Date userCreateDate) The creation date of the user.
UserType	withUserLastModifiedDate(Date userLastModifiedDate) The last modified date of the user.
UserType	withUsername(String username) The user name of the user you wish to describe.
UserType	withUserStatus(String userStatus) The user status.
UserType	withUserStatus(UserStatusType userStatus) The user status.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserType

public UserType()

Method Detail

getUsername

public String getUsername()

The user name of the user you wish to describe.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name of the user you wish to describe.

setUsername

public void setUsername(String username)

The user name of the user you wish to describe.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user you wish to describe.

withUsername

public UserType withUsername(String username)

The user name of the user you wish to describe.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user you wish to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributes

public List<AttributeType> getAttributes()

A container with information about the user type attributes.

Returns:

A container with information about the user type attributes.

setAttributes

public void setAttributes(Collection<AttributeType> attributes)

A container with information about the user type attributes.

Parameters:

attributes -

A container with information about the user type attributes.

withAttributes

public UserType withAttributes(AttributeType... attributes)

A container with information about the user type attributes.

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

Parameters:

attributes -

A container with information about the user type attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

withAttributes

public UserType withAttributes(Collection<AttributeType> attributes)

A container with information about the user type attributes.

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

Parameters:

attributes -

A container with information about the user type attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserCreateDate

public Date getUserCreateDate()

The creation date of the user.

Returns:

The creation date of the user.

setUserCreateDate

public void setUserCreateDate(Date userCreateDate)

The creation date of the user.

Parameters:

userCreateDate -

The creation date of the user.

withUserCreateDate

public UserType withUserCreateDate(Date userCreateDate)

The creation date of the user.

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

Parameters:

userCreateDate -

The creation date of the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserLastModifiedDate

public Date getUserLastModifiedDate()

The last modified date of the user.

Returns:

The last modified date of the user.

setUserLastModifiedDate

public void setUserLastModifiedDate(Date userLastModifiedDate)

The last modified date of the user.

Parameters:

userLastModifiedDate -

The last modified date of the user.

withUserLastModifiedDate

public UserType withUserLastModifiedDate(Date userLastModifiedDate)

The last modified date of the user.

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

Parameters:

userLastModifiedDate -

The last modified date of the user.

Returns:

A reference to this updated object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

Specifies whether the user is enabled.

Returns:

Specifies whether the user is enabled.

getEnabled

public Boolean getEnabled()

Specifies whether the user is enabled.

Returns:

Specifies whether the user is enabled.

setEnabled

public void setEnabled(Boolean enabled)

Specifies whether the user is enabled.

Parameters:

enabled -

Specifies whether the user is enabled.

withEnabled

public UserType withEnabled(Boolean enabled)

Specifies whether the user is enabled.

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

Parameters:

enabled -

Specifies whether the user is enabled.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserStatus

public String getUserStatus()

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Returns:

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

See Also:

UserStatusType

setUserStatus

public void setUserStatus(String userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Parameters:

userStatus -

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

See Also:

UserStatusType

withUserStatus

public UserType withUserStatus(String userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

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

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Parameters:

userStatus -

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

UserStatusType

setUserStatus

public void setUserStatus(UserStatusType userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Parameters:

userStatus -

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

See Also:

UserStatusType

withUserStatus

public UserType withUserStatus(UserStatusType userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

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

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Parameters:

userStatus -

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

UserStatusType

getMFAOptions

public List<MFAOptionType> getMFAOptions()

The MFA options for the user.

Returns:

The MFA options for the user.

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

The MFA options for the user.

Parameters:

mFAOptions -

The MFA options for the user.

withMFAOptions

public UserType withMFAOptions(MFAOptionType... mFAOptions)

The MFA options for the user.

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

Parameters:

mFAOptions -

The MFA options for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

withMFAOptions

public UserType withMFAOptions(Collection<MFAOptionType> mFAOptions)

The MFA options for the user.

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

Parameters:

mFAOptions -

The MFA options for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object