@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UserType extends Object implements Serializable, Cloneable, StructuredPojo
A user profile in a Amazon Cognito user pool.
Constructor and Description |
---|
UserType() |
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 date and time when the item was modified.
|
String |
getUsername()
The user name of the user you want 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 date and time when the item was modified.
|
void |
setUsername(String username)
The user name of the user you want 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.
|
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 date and time when the item was modified.
|
UserType |
withUsername(String username)
The user name of the user you want to describe.
|
UserType |
withUserStatus(String userStatus)
The user status.
|
UserType |
withUserStatus(UserStatusType userStatus)
The user status.
|
public void setUsername(String username)
The user name of the user you want to describe.
username
- The user name of the user you want to describe.public String getUsername()
The user name of the user you want to describe.
public UserType withUsername(String username)
The user name of the user you want to describe.
username
- The user name of the user you want to describe.public List<AttributeType> getAttributes()
A container with information about the user type attributes.
public void setAttributes(Collection<AttributeType> attributes)
A container with information about the user type attributes.
attributes
- A container with information about the user type attributes.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.
attributes
- A container with information about the user type attributes.public UserType withAttributes(Collection<AttributeType> attributes)
A container with information about the user type attributes.
attributes
- A container with information about the user type attributes.public void setUserCreateDate(Date userCreateDate)
The creation date of the user.
userCreateDate
- The creation date of the user.public Date getUserCreateDate()
The creation date of the user.
public UserType withUserCreateDate(Date userCreateDate)
The creation date of the user.
userCreateDate
- The creation date of the user.public void setUserLastModifiedDate(Date userLastModifiedDate)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
userLastModifiedDate
- The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public Date getUserLastModifiedDate()
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
Date
object.public UserType withUserLastModifiedDate(Date userLastModifiedDate)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
userLastModifiedDate
- The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public void setEnabled(Boolean enabled)
Specifies whether the user is enabled.
enabled
- Specifies whether the user is enabled.public Boolean getEnabled()
Specifies whether the user is enabled.
public UserType withEnabled(Boolean enabled)
Specifies whether the user is enabled.
enabled
- Specifies whether the user is enabled.public Boolean isEnabled()
Specifies whether the user is enabled.
public void setUserStatus(String userStatus)
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
userStatus
- The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UserStatusType
public String getUserStatus()
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UserStatusType
public UserType withUserStatus(String userStatus)
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
userStatus
- The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UserStatusType
public void setUserStatus(UserStatusType userStatus)
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
userStatus
- The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UserStatusType
public UserType withUserStatus(UserStatusType userStatus)
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
userStatus
- The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
UserStatusType
public List<MFAOptionType> getMFAOptions()
The MFA options for the user.
public void setMFAOptions(Collection<MFAOptionType> mFAOptions)
The MFA options for the user.
mFAOptions
- The MFA options for the user.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.
mFAOptions
- The MFA options for the user.public UserType withMFAOptions(Collection<MFAOptionType> mFAOptions)
The MFA options for the user.
mFAOptions
- The MFA options for the user.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.