KeyMetadata (AWS Java SDK for AWS KMS 1.11.30 API)

java.lang.Object
- com.amazonaws.services.kms.model.KeyMetadata

All Implemented Interfaces:

Serializable, Cloneable
```
public class KeyMetadata
extends Object
implements Serializable, Cloneable
```
Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyMetadata()

Constructors
Constructor and Description
`KeyMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the CMK.
`String`	`getAWSAccountId()` The twelve-digit account ID of the AWS account that owns the CMK.
`Date`	`getCreationDate()` The date and time when the CMK was created.
`Date`	`getDeletionDate()` The date and time after which AWS KMS deletes the CMK.
`String`	`getDescription()` The description of the CMK.
`Boolean`	`getEnabled()` Specifies whether the CMK is enabled.
`String`	`getExpirationModel()` Specifies whether the CMK's key material expires.
`String`	`getKeyId()` The globally unique identifier for the CMK.
`String`	`getKeyState()` The state of the CMK.
`String`	`getKeyUsage()` The cryptographic operations for which you can use the CMK.
`String`	`getOrigin()` The source of the CMK's key material.
`Date`	`getValidTo()` The time at which the imported key material expires.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies whether the CMK is enabled.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the CMK.
`void`	`setAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`void`	`setCreationDate(Date creationDate)` The date and time when the CMK was created.
`void`	`setDeletionDate(Date deletionDate)` The date and time after which AWS KMS deletes the CMK.
`void`	`setDescription(String description)` The description of the CMK.
`void`	`setEnabled(Boolean enabled)` Specifies whether the CMK is enabled.
`void`	`setExpirationModel(ExpirationModelType expirationModel)` Specifies whether the CMK's key material expires.
`void`	`setExpirationModel(String expirationModel)` Specifies whether the CMK's key material expires.
`void`	`setKeyId(String keyId)` The globally unique identifier for the CMK.
`void`	`setKeyState(KeyState keyState)` The state of the CMK.
`void`	`setKeyState(String keyState)` The state of the CMK.
`void`	`setKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`void`	`setKeyUsage(String keyUsage)` The cryptographic operations for which you can use the CMK.
`void`	`setOrigin(OriginType origin)` The source of the CMK's key material.
`void`	`setOrigin(String origin)` The source of the CMK's key material.
`void`	`setValidTo(Date validTo)` The time at which the imported key material expires.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`KeyMetadata`	`withArn(String arn)` The Amazon Resource Name (ARN) of the CMK.
`KeyMetadata`	`withAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`KeyMetadata`	`withCreationDate(Date creationDate)` The date and time when the CMK was created.
`KeyMetadata`	`withDeletionDate(Date deletionDate)` The date and time after which AWS KMS deletes the CMK.
`KeyMetadata`	`withDescription(String description)` The description of the CMK.
`KeyMetadata`	`withEnabled(Boolean enabled)` Specifies whether the CMK is enabled.
`KeyMetadata`	`withExpirationModel(ExpirationModelType expirationModel)` Specifies whether the CMK's key material expires.
`KeyMetadata`	`withExpirationModel(String expirationModel)` Specifies whether the CMK's key material expires.
`KeyMetadata`	`withKeyId(String keyId)` The globally unique identifier for the CMK.
`KeyMetadata`	`withKeyState(KeyState keyState)` The state of the CMK.
`KeyMetadata`	`withKeyState(String keyState)` The state of the CMK.
`KeyMetadata`	`withKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`KeyMetadata`	`withKeyUsage(String keyUsage)` The cryptographic operations for which you can use the CMK.
`KeyMetadata`	`withOrigin(OriginType origin)` The source of the CMK's key material.
`KeyMetadata`	`withOrigin(String origin)` The source of the CMK's key material.
`KeyMetadata`	`withValidTo(Date validTo)` The time at which the imported key material expires.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyMetadata
```
public KeyMetadata()
```
- Method Detail
  - setAWSAccountId
```
public void setAWSAccountId(String aWSAccountId)
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the AWS account that owns the CMK.
  - getAWSAccountId
```
public String getAWSAccountId()
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns:
    
    The twelve-digit account ID of the AWS account that owns the CMK.
  - withAWSAccountId
```
public KeyMetadata withAWSAccountId(String aWSAccountId)
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The globally unique identifier for the CMK.
    
    Parameters:
    
    keyId - The globally unique identifier for the CMK.
  - getKeyId
```
public String getKeyId()
```
    The globally unique identifier for the CMK.
    
    Returns:
    
    The globally unique identifier for the CMK.
  - withKeyId
```
public KeyMetadata withKeyId(String keyId)
```
    The globally unique identifier for the CMK.
    
    Parameters:
    
    keyId - The globally unique identifier for the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
  - withArn
```
public KeyMetadata withArn(String arn)
```
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date and time when the CMK was created.
    
    Parameters:
    
    creationDate - The date and time when the CMK was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time when the CMK was created.
    
    Returns:
    
    The date and time when the CMK was created.
  - withCreationDate
```
public KeyMetadata withCreationDate(Date creationDate)
```
    The date and time when the CMK was created.
    
    Parameters:
    
    creationDate - The date and time when the CMK was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Parameters:
    
    enabled - Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - withEnabled
```
public KeyMetadata withEnabled(Boolean enabled)
```
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Parameters:
    
    enabled - Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - setDescription
```
public void setDescription(String description)
```
    The description of the CMK.
    
    Parameters:
    
    description - The description of the CMK.
  - getDescription
```
public String getDescription()
```
    The description of the CMK.
    
    Returns:
    
    The description of the CMK.
  - withDescription
```
public KeyMetadata withDescription(String description)
```
    The description of the CMK.
    
    Parameters:
    
    description - The description of the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyUsage
```
public void setKeyUsage(String keyUsage)
```
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    See Also:
    
    KeyUsageType
  - getKeyUsage
```
public String getKeyUsage()
```
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Returns:
    
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(String keyUsage)
```
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setKeyState
```
public void setKeyState(String keyState)
```
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - getKeyState
```
public String getKeyState()
```
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(String keyState)
```
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyState
  - setKeyState
```
public void setKeyState(KeyState keyState)
```
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(KeyState keyState)
```
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyState
  - setDeletionDate
```
public void setDeletionDate(Date deletionDate)
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
    
    Parameters:
    
    deletionDate - The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
  - getDeletionDate
```
public Date getDeletionDate()
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
    
    Returns:
    
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
  - withDeletionDate
```
public KeyMetadata withDeletionDate(Date deletionDate)
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
    
    Parameters:
    
    deletionDate - The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValidTo
```
public void setValidTo(Date validTo)
```
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
    
    Parameters:
    
    validTo - The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
  - getValidTo
```
public Date getValidTo()
```
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
    
    Returns:
    
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.
  - withValidTo
```
public KeyMetadata withValidTo(Date validTo)
```
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
    
    Parameters:
    
    validTo - The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOrigin
```
public void setOrigin(String origin)
```
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Parameters:
    
    origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    See Also:
    
    OriginType
  - getOrigin
```
public String getOrigin()
```
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Returns:
    
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    See Also:
    
    OriginType
  - withOrigin
```
public KeyMetadata withOrigin(String origin)
```
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Parameters:
    
    origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setOrigin
```
public void setOrigin(OriginType origin)
```
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Parameters:
    
    origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    See Also:
    
    OriginType
  - withOrigin
```
public KeyMetadata withOrigin(OriginType origin)
```
    The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Parameters:
    
    origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setExpirationModel
```
public void setExpirationModel(String expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    See Also:
    
    ExpirationModelType
  - getExpirationModel
```
public String getExpirationModel()
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Returns:
    
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    See Also:
    
    ExpirationModelType
  - withExpirationModel
```
public KeyMetadata withExpirationModel(String expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExpirationModelType
  - setExpirationModel
```
public void setExpirationModel(ExpirationModelType expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    See Also:
    
    ExpirationModelType
  - withExpirationModel
```
public KeyMetadata withExpirationModel(ExpirationModelType expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExpirationModelType
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KeyMetadata clone()
```
    Overrides:
    
    clone in class Object

Class KeyMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyMetadata

Method Detail

setAWSAccountId

getAWSAccountId

withAWSAccountId

setKeyId

getKeyId

withKeyId

setArn

getArn

withArn

setCreationDate

getCreationDate

withCreationDate

setEnabled

getEnabled

withEnabled

isEnabled

setDescription

getDescription

withDescription

setKeyUsage

getKeyUsage

withKeyUsage

setKeyUsage

withKeyUsage

setKeyState

getKeyState

withKeyState

setKeyState

withKeyState

setDeletionDate

getDeletionDate

withDeletionDate

setValidTo

getValidTo

withValidTo

setOrigin

getOrigin

withOrigin

setOrigin

withOrigin

setExpirationModel

getExpirationModel

withExpirationModel

setExpirationModel

withExpirationModel

toString

equals

hashCode

clone