java.lang.Object
com.amazonaws.services.identitymanagement.model.AccessKey
All Implemented Interfaces:
Serializable, Cloneable

public class AccessKey extends Object implements Serializable, Cloneable

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

See Also:
  • Constructor Details

    • AccessKey

      public AccessKey()
      Default constructor for AccessKey object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
    • AccessKey

      public AccessKey(String userName, String accessKeyId, String status, String secretAccessKey)
      Constructs a new AccessKey object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      userName - The name of the IAM user that the access key is associated with.
      accessKeyId - The ID for this access key.
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      secretAccessKey - The secret key used to sign requests.
    • AccessKey

      public AccessKey(String userName, String accessKeyId, StatusType status, String secretAccessKey)
      Constructs a new AccessKey object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      userName - The name of the IAM user that the access key is associated with.
      accessKeyId - The ID for this access key.
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      secretAccessKey - The secret key used to sign requests.
  • Method Details

    • setUserName

      public void setUserName(String userName)

      The name of the IAM user that the access key is associated with.

      Parameters:
      userName - The name of the IAM user that the access key is associated with.
    • getUserName

      public String getUserName()

      The name of the IAM user that the access key is associated with.

      Returns:
      The name of the IAM user that the access key is associated with.
    • withUserName

      public AccessKey withUserName(String userName)

      The name of the IAM user that the access key is associated with.

      Parameters:
      userName - The name of the IAM user that the access key is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAccessKeyId

      public void setAccessKeyId(String accessKeyId)

      The ID for this access key.

      Parameters:
      accessKeyId - The ID for this access key.
    • getAccessKeyId

      public String getAccessKeyId()

      The ID for this access key.

      Returns:
      The ID for this access key.
    • withAccessKeyId

      public AccessKey withAccessKeyId(String accessKeyId)

      The ID for this access key.

      Parameters:
      accessKeyId - The ID for this access key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatus

      public void setStatus(String status)

      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

      Parameters:
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      See Also:
    • getStatus

      public String getStatus()

      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

      Returns:
      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      See Also:
    • withStatus

      public AccessKey withStatus(String status)

      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

      Parameters:
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setStatus

      public void setStatus(StatusType status)

      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

      Parameters:
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      See Also:
    • withStatus

      public AccessKey withStatus(StatusType status)

      The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

      Parameters:
      status - The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setSecretAccessKey

      public void setSecretAccessKey(String secretAccessKey)

      The secret key used to sign requests.

      Parameters:
      secretAccessKey - The secret key used to sign requests.
    • getSecretAccessKey

      public String getSecretAccessKey()

      The secret key used to sign requests.

      Returns:
      The secret key used to sign requests.
    • withSecretAccessKey

      public AccessKey withSecretAccessKey(String secretAccessKey)

      The secret key used to sign requests.

      Parameters:
      secretAccessKey - The secret key used to sign requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCreateDate

      public void setCreateDate(Date createDate)

      The date when the access key was created.

      Parameters:
      createDate - The date when the access key was created.
    • getCreateDate

      public Date getCreateDate()

      The date when the access key was created.

      Returns:
      The date when the access key was created.
    • withCreateDate

      public AccessKey withCreateDate(Date createDate)

      The date when the access key was created.

      Parameters:
      createDate - The date when the access key was created.
      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public AccessKey clone()
      Overrides:
      clone in class Object