Class User

java.lang.Object
software.amazon.awssdk.services.iam.model.User
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>
@Generated("software.amazon.awssdk:codegen") public final class User extends Object implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>

Contains information about an IAM user entity.

This data type is used as a response element in the following operations:

See Also:

  • Method Details

    • path

      public final String path()

      The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

      The ARN of the policy used to set the permissions boundary for the user.

      Returns:
      The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

      The ARN of the policy used to set the permissions boundary for the user.

    • userName

      public final String userName()

      The friendly name identifying the user.

      Returns:
      The friendly name identifying the user.

    • userId

      public final String userId()

      The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

      Returns:
      The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

      Returns:
      The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

    • createDate

      public final Instant createDate()

      The date and time, in ISO 8601 date-time format, when the user was created.

      Returns:
      The date and time, in ISO 8601 date-time format, when the user was created.

    • passwordLastUsed

      public final Instant passwordLastUsed()

      The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

      • The user never had a password.

      • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

      A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

      This value is returned only in the GetUser and ListUsers operations.

      Returns:
      The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

      • The user never had a password.

      • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

      A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

      This value is returned only in the GetUser and ListUsers operations.

    • permissionsBoundary

      public final AttachedPermissionsBoundary permissionsBoundary()

      For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

      Returns:
      For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

    • toBuilder

      public User.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<User.Builder,User>
      Returns:
      a builder for type T

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

      public static Class<? extends User.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.