Class AccessKey
- All Implemented Interfaces:
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 Summary
ConstructorsConstructorDescriptionDefault constructor for AccessKey object.AccessKey
(String userName, String accessKeyId, StatusType status, String secretAccessKey) Constructs a new AccessKey object.Constructs a new AccessKey object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The ID for this access key.The date when the access key was created.The secret key used to sign requests.The status of the access key.The name of the IAM user that the access key is associated with.int
hashCode()
void
setAccessKeyId
(String accessKeyId) The ID for this access key.void
setCreateDate
(Date createDate) The date when the access key was created.void
setSecretAccessKey
(String secretAccessKey) The secret key used to sign requests.void
setStatus
(StatusType status) The status of the access key.void
The status of the access key.void
setUserName
(String userName) The name of the IAM user that the access key is associated with.toString()
Returns a string representation of this object; useful for testing and debugging.withAccessKeyId
(String accessKeyId) The ID for this access key.withCreateDate
(Date createDate) The date when the access key was created.withSecretAccessKey
(String secretAccessKey) The secret key used to sign requests.withStatus
(StatusType status) The status of the access key.withStatus
(String status) The status of the access key.withUserName
(String userName) The name of the IAM user that the access key is associated with.
-
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
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, whileInactive
means it is not.secretAccessKey
- The secret key used to sign requests.
-
AccessKey
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, whileInactive
means it is not.secretAccessKey
- The secret key used to sign requests.
-
-
Method Details
-
setUserName
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
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
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
The ID for this access key.
- Parameters:
accessKeyId
- The ID for this access key.
-
getAccessKeyId
The ID for this access key.
- Returns:
- The ID for this access key.
-
withAccessKeyId
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
The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not.- Parameters:
status
- The status of the access key.Active
means the key is valid for API calls, whileInactive
means it is not.- See Also:
-
getStatus
The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not.- Returns:
- The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not. - See Also:
-
withStatus
The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not.- Parameters:
status
- The status of the access key.Active
means the key is valid for API calls, whileInactive
means it is not.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatus
The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not.- Parameters:
status
- The status of the access key.Active
means the key is valid for API calls, whileInactive
means it is not.- See Also:
-
withStatus
The status of the access key.
Active
means the key is valid for API calls, whileInactive
means it is not.- Parameters:
status
- The status of the access key.Active
means the key is valid for API calls, whileInactive
means it is not.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSecretAccessKey
The secret key used to sign requests.
- Parameters:
secretAccessKey
- The secret key used to sign requests.
-
getSecretAccessKey
The secret key used to sign requests.
- Returns:
- The secret key used to sign requests.
-
withSecretAccessKey
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
The date when the access key was created.
- Parameters:
createDate
- The date when the access key was created.
-
getCreateDate
The date when the access key was created.
- Returns:
- The date when the access key was created.
-
withCreateDate
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-