com.amazonaws.services.kms.model

Class KeyMetadata

java.lang.Object

com.amazonaws.services.kms.model.KeyMetadata

All Implemented Interfaces:

Serializable, Cloneable

public class KeyMetadata
extends Object
implements Serializable, Cloneable

Contains metadata associated with a specific key.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
KeyMetadata	clone()
boolean	equals(Object obj)
String	getArn() Key ARN (Amazon Resource Name).
String	getAWSAccountId() Account ID number.
Date	getCreationDate() Date the key was created.
String	getDescription() The description of the key.
Boolean	getEnabled() Value that specifies whether the key is enabled.
String	getKeyId() Unique identifier for the key.
String	getKeyUsage() A value that specifies what operation(s) the key can perform.
int	hashCode()
Boolean	isEnabled() Value that specifies whether the key is enabled.
void	setArn(String arn) Key ARN (Amazon Resource Name).
void	setAWSAccountId(String aWSAccountId) Account ID number.
void	setCreationDate(Date creationDate) Date the key was created.
void	setDescription(String description) The description of the key.
void	setEnabled(Boolean enabled) Value that specifies whether the key is enabled.
void	setKeyId(String keyId) Unique identifier for the key.
void	setKeyUsage(KeyUsageType keyUsage) A value that specifies what operation(s) the key can perform.
void	setKeyUsage(String keyUsage) A value that specifies what operation(s) the key can perform.
String	toString() Returns a string representation of this object; useful for testing and debugging.
KeyMetadata	withArn(String arn) Key ARN (Amazon Resource Name).
KeyMetadata	withAWSAccountId(String aWSAccountId) Account ID number.
KeyMetadata	withCreationDate(Date creationDate) Date the key was created.
KeyMetadata	withDescription(String description) The description of the key.
KeyMetadata	withEnabled(Boolean enabled) Value that specifies whether the key is enabled.
KeyMetadata	withKeyId(String keyId) Unique identifier for the key.
KeyMetadata	withKeyUsage(KeyUsageType keyUsage) A value that specifies what operation(s) the key can perform.
KeyMetadata	withKeyUsage(String keyUsage) A value that specifies what operation(s) the key can perform.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMetadata

public KeyMetadata()

Method Detail

getAWSAccountId

public String getAWSAccountId()

Account ID number.

Returns:

Account ID number.

setAWSAccountId

public void setAWSAccountId(String aWSAccountId)

Account ID number.

Parameters:

aWSAccountId - Account ID number.

withAWSAccountId

public KeyMetadata withAWSAccountId(String aWSAccountId)

Account ID number.

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

Parameters:

aWSAccountId - Account ID number.

Returns:

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

getKeyId

public String getKeyId()

Unique identifier for the key.

Constraints:
Length: 1 - 256

Returns:

Unique identifier for the key.

setKeyId

public void setKeyId(String keyId)

Unique identifier for the key.

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier for the key.

withKeyId

public KeyMetadata withKeyId(String keyId)

Unique identifier for the key.

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

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier for the key.

Returns:

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

getArn

public String getArn()

Key ARN (Amazon Resource Name).

Constraints:
Length: 20 - 2048

Returns:

Key ARN (Amazon Resource Name).

setArn

public void setArn(String arn)

Key ARN (Amazon Resource Name).

Constraints:
Length: 20 - 2048

Parameters:

arn - Key ARN (Amazon Resource Name).

withArn

public KeyMetadata withArn(String arn)

Key ARN (Amazon Resource Name).

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

Constraints:
Length: 20 - 2048

Parameters:

arn - Key ARN (Amazon Resource Name).

Returns:

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

getCreationDate

public Date getCreationDate()

Date the key was created.

Returns:

Date the key was created.

setCreationDate

public void setCreationDate(Date creationDate)

Date the key was created.

Parameters:

creationDate - Date the key was created.

withCreationDate

public KeyMetadata withCreationDate(Date creationDate)

Date the key was created.

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

Parameters:

creationDate - Date the key was created.

Returns:

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

isEnabled

public Boolean isEnabled()

Value that specifies whether the key is enabled.

Returns:

Value that specifies whether the key is enabled.

setEnabled

public void setEnabled(Boolean enabled)

Value that specifies whether the key is enabled.

Parameters:

enabled - Value that specifies whether the key is enabled.

withEnabled

public KeyMetadata withEnabled(Boolean enabled)

Value that specifies whether the key is enabled.

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

Parameters:

enabled - Value that specifies whether the key is enabled.

Returns:

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

getEnabled

public Boolean getEnabled()

Value that specifies whether the key is enabled.

Returns:

Value that specifies whether the key is enabled.

getDescription

public String getDescription()

The description of the key.

Constraints:
Length: 0 - 8192

Returns:

The description of the key.

setDescription

public void setDescription(String description)

The description of the key.

Constraints:
Length: 0 - 8192

Parameters:

description - The description of the key.

withDescription

public KeyMetadata withDescription(String description)

The description of the key.

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

Constraints:
Length: 0 - 8192

Parameters:

description - The description of the key.

Returns:

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

getKeyUsage

public String getKeyUsage()

A value that specifies what operation(s) the key can perform.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Returns:

A value that specifies what operation(s) the key can perform.

See Also:

KeyUsageType

setKeyUsage

public void setKeyUsage(String keyUsage)

A value that specifies what operation(s) the key can perform.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - A value that specifies what operation(s) the key can perform.

See Also:

KeyUsageType

withKeyUsage

public KeyMetadata withKeyUsage(String keyUsage)

A value that specifies what operation(s) the key can perform.

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

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - A value that specifies what operation(s) the key can perform.

Returns:

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

See Also:

KeyUsageType

setKeyUsage

public void setKeyUsage(KeyUsageType keyUsage)

A value that specifies what operation(s) the key can perform.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - A value that specifies what operation(s) the key can perform.

See Also:

KeyUsageType

withKeyUsage

public KeyMetadata withKeyUsage(KeyUsageType keyUsage)

A value that specifies what operation(s) the key can perform.

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

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - A value that specifies what operation(s) the key can perform.

Returns:

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

See Also:

KeyUsageType

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 KeyMetadata clone()

Overrides:

clone in class Object