com.amazonaws.services.identitymanagement.model

Class AccessKey

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.

NOTE: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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AccessKey() Default constructor for a new AccessKey object.
AccessKey(String userName, String accessKeyId, StatusType status, String secretAccessKey) Constructs a new AccessKey object.
AccessKey(String userName, String accessKeyId, String status, String secretAccessKey) Constructs a new AccessKey object.

Method Summary

Methods

Modifier and Type	Method and Description
AccessKey	clone()
boolean	equals(Object obj)
String	getAccessKeyId() The ID for this access key.
Date	getCreateDate() The date when the access key was created.
String	getSecretAccessKey() The secret key used to sign requests.
String	getStatus() The status of the access key.
String	getUserName() 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	setStatus(String status) The status of the access key.
void	setUserName(String userName) The name of the IAM user that the access key is associated with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AccessKey	withAccessKeyId(String accessKeyId) The ID for this access key.
AccessKey	withCreateDate(Date createDate) The date when the access key was created.
AccessKey	withSecretAccessKey(String secretAccessKey) The secret key used to sign requests.
AccessKey	withStatus(StatusType status) The status of the access key.
AccessKey	withStatus(String status) The status of the access key.
AccessKey	withUserName(String userName) The name of the IAM user that the access key is associated with.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessKey

public AccessKey()

Default constructor for a new AccessKey object. Callers should use the setter or fluent setter (with...) methods to initialize this 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 Detail

getUserName

public String getUserName()

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

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Returns:

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

setUserName

public void setUserName(String userName)

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

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Parameters:

userName - 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAccessKeyId

public String getAccessKeyId()

The ID for this access key.

Constraints:
Length: 16 - 32
Pattern: [\w]+

Returns:

The ID for this access key.

setAccessKeyId

public void setAccessKeyId(String accessKeyId)

The ID for this access key.

Constraints:
Length: 16 - 32
Pattern: [\w]+

Parameters:

accessKeyId - The ID for this access key.

withAccessKeyId

public AccessKey withAccessKeyId(String accessKeyId)

The ID for this access key.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 16 - 32
Pattern: [\w]+

Parameters:

accessKeyId - The ID for this access key.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Allowed Values: Active, Inactive

Returns:

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

See Also:

StatusType

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.

Constraints:
Allowed Values: Active, Inactive

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:

StatusType

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

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.

Constraints:
Allowed Values: Active, Inactive

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:

StatusType

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

getSecretAccessKey

public String getSecretAccessKey()

The secret key used to sign requests.

Returns:

The secret key used to sign requests.

setSecretAccessKey

public void setSecretAccessKey(String secretAccessKey)

The secret key used to sign requests.

Parameters:

secretAccessKey - The secret key used to sign requests.

withSecretAccessKey

public AccessKey withSecretAccessKey(String secretAccessKey)

The secret key used to sign requests.

Returns a reference to this object so that method calls can be chained together.

Parameters:

secretAccessKey - The secret key used to sign requests.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreateDate

public Date getCreateDate()

The date when the access key was created.

Returns:

The date when the access key was created.

setCreateDate

public void setCreateDate(Date createDate)

The date when the access key was created.

Parameters:

createDate - The date when the access key was created.

withCreateDate

public AccessKey withCreateDate(Date createDate)

The date when the access key was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

createDate - The date when the access key was created.

Returns:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public AccessKey clone()

Overrides:

clone in class Object