UserType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.UserType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserType
extends Object
implements Serializable, Cloneable, StructuredPojo

The user type.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserType()

Constructors
Constructor and Description
`UserType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserType`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserType
```
public UserType()
```
- Method Detail
  - setUsername
```
public void setUsername(String username)
```
    The user name of the user you wish to describe.
    
    Parameters:
    
    username - The user name of the user you wish to describe.
  - getUsername
```
public String getUsername()
```
    The user name of the user you wish to describe.
    
    Returns:
    
    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.
    
    Parameters:
    
    username - The user name of the user you wish to describe.
    
    Returns:
    
    Returns a reference to this 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attributes - A container with information about the user type attributes.
    
    Returns:
    
    Returns a reference to this 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.
    
    Parameters:
    
    attributes - A container with information about the user type attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserCreateDate
```
public void setUserCreateDate(Date userCreateDate)
```
    The creation date of the user.
    
    Parameters:
    
    userCreateDate - The creation date of the user.
  - getUserCreateDate
```
public Date getUserCreateDate()
```
    The creation date of the user.
    
    Returns:
    
    The creation date of the user.
  - withUserCreateDate
```
public UserType withUserCreateDate(Date userCreateDate)
```
    The creation date of the user.
    
    Parameters:
    
    userCreateDate - The creation date of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserLastModifiedDate
```
public void setUserLastModifiedDate(Date userLastModifiedDate)
```
    The last modified date of the user.
    
    Parameters:
    
    userLastModifiedDate - The last modified date of the user.
  - getUserLastModifiedDate
```
public Date getUserLastModifiedDate()
```
    The last modified date of the user.
    
    Returns:
    
    The last modified date of the user.
  - withUserLastModifiedDate
```
public UserType withUserLastModifiedDate(Date userLastModifiedDate)
```
    The last modified date of the user.
    
    Parameters:
    
    userLastModifiedDate - The last modified date of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies whether the user is enabled.
    
    Parameters:
    
    enabled - Specifies whether the user is enabled.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether the user is enabled.
    
    Returns:
    
    Specifies whether the user is enabled.
  - withEnabled
```
public UserType withEnabled(Boolean enabled)
```
    Specifies whether the user is enabled.
    
    Parameters:
    
    enabled - Specifies whether the user is enabled.
    
    Returns:
    
    Returns a reference to this 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.
  - 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.
    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.
    See Also:
    
    UserStatusType
  - 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.
    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.
    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.
    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.
    Returns:
    
    Returns a reference to this 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.
    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.
    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.
    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.
    Returns:
    
    Returns a reference to this 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    mFAOptions - The MFA options for the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMFAOptions
```
public UserType withMFAOptions(Collection<MFAOptionType> mFAOptions)
```
    The MFA options for the user.
    
    Parameters:
    
    mFAOptions - The MFA options for the user.
    
    Returns:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UserType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserType

Method Detail

setUsername

getUsername

withUsername

getAttributes

setAttributes

withAttributes

withAttributes

setUserCreateDate

getUserCreateDate

withUserCreateDate

setUserLastModifiedDate

getUserLastModifiedDate

withUserLastModifiedDate

setEnabled

getEnabled

withEnabled

isEnabled

setUserStatus

getUserStatus

withUserStatus

setUserStatus

withUserStatus

getMFAOptions

setMFAOptions

withMFAOptions

withMFAOptions

toString

equals

hashCode

clone

marshall