@Generated(value="software.amazon.awssdk:codegen") public final class UserType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserType.Builder,UserType>
The user type.
Modifier and Type | Class and Description |
---|---|
static interface |
UserType.Builder |
Modifier and Type | Method and Description |
---|---|
List<AttributeType> |
attributes()
A container with information about the user type attributes.
|
static UserType.Builder |
builder() |
Boolean |
enabled()
Specifies whether the user is enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasMfaOptions()
Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
List<MFAOptionType> |
mfaOptions()
The MFA options for the user.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UserType.Builder> |
serializableBuilderClass() |
UserType.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Instant |
userCreateDate()
The creation date of the user.
|
Instant |
userLastModifiedDate()
The last modified date of the user.
|
String |
username()
The user name of the user you wish to describe.
|
UserStatusType |
userStatus()
The user status.
|
String |
userStatusAsString()
The user status.
|
copy
public final String username()
The user name of the user you wish to describe.
public final boolean hasAttributes()
public final List<AttributeType> attributes()
A container with information about the user type attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final Instant userCreateDate()
The creation date of the user.
public final Instant userLastModifiedDate()
The last modified date of the user.
public final Boolean enabled()
Specifies whether the user is enabled.
public final 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.
If the service returns an enum value that is not available in the current SDK version, userStatus
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
userStatusAsString()
.
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.
UserStatusType
public final String userStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, userStatus
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
userStatusAsString()
.
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.
UserStatusType
public final boolean hasMfaOptions()
public final List<MFAOptionType> mfaOptions()
The MFA options for the user.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasMfaOptions()
to see if a value was sent in this field.
public UserType.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UserType.Builder,UserType>
public static UserType.Builder builder()
public static Class<? extends UserType.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.