KeyMetadata (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KeyMetadata
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains metadata about a KMS key.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyMetadata()

Constructors
Constructor and Description
`KeyMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`KeyMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the KMS key.
`String`	`getAWSAccountId()` The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
`String`	`getCloudHsmClusterId()` The cluster ID of the CloudHSM cluster that contains the key material for the KMS key.
`Date`	`getCreationDate()` The date and time when the KMS key was created.
`String`	`getCustomerMasterKeySpec()` Deprecated.
`String`	`getCustomKeyStoreId()` A unique identifier for the custom key store that contains the KMS key.
`Date`	`getDeletionDate()` The date and time after which KMS deletes this KMS key.
`String`	`getDescription()` The description of the KMS key.
`Boolean`	`getEnabled()` Specifies whether the KMS key is enabled.
`List<String>`	`getEncryptionAlgorithms()` The encryption algorithms that the KMS key supports.
`String`	`getExpirationModel()` Specifies whether the KMS key's key material expires.
`List<String>`	`getKeyAgreementAlgorithms()` The key agreement algorithm used to derive a shared secret.
`String`	`getKeyId()` The globally unique identifier for the KMS key.
`String`	`getKeyManager()` The manager of the KMS key.
`String`	`getKeySpec()` Describes the type of key material in the KMS key.
`String`	`getKeyState()` The current status of the KMS key.
`String`	`getKeyUsage()` The cryptographic operations for which you can use the KMS key.
`List<String>`	`getMacAlgorithms()` The message authentication code (MAC) algorithm that the HMAC KMS key supports.
`Boolean`	`getMultiRegion()` Indicates whether the KMS key is a multi-Region (`True`) or regional (`False`) key.
`MultiRegionConfiguration`	`getMultiRegionConfiguration()` Lists the primary and replica keys in same multi-Region key.
`String`	`getOrigin()` The source of the key material for the KMS key.
`Integer`	`getPendingDeletionWindowInDays()` The waiting period before the primary key in a multi-Region key is deleted.
`List<String>`	`getSigningAlgorithms()` The signing algorithms that the KMS key supports.
`Date`	`getValidTo()` The time at which the imported key material expires.
`XksKeyConfigurationType`	`getXksKeyConfiguration()` Information about the external key that is associated with a KMS key in an external key store.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies whether the KMS key is enabled.
`Boolean`	`isMultiRegion()` Indicates whether the KMS key is a multi-Region (`True`) or regional (`False`) key.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the KMS key.
`void`	`setAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
`void`	`setCloudHsmClusterId(String cloudHsmClusterId)` The cluster ID of the CloudHSM cluster that contains the key material for the KMS key.
`void`	`setCreationDate(Date creationDate)` The date and time when the KMS key was created.
`void`	`setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Deprecated.
`void`	`setCustomerMasterKeySpec(String customerMasterKeySpec)` Deprecated.
`void`	`setCustomKeyStoreId(String customKeyStoreId)` A unique identifier for the custom key store that contains the KMS key.
`void`	`setDeletionDate(Date deletionDate)` The date and time after which KMS deletes this KMS key.
`void`	`setDescription(String description)` The description of the KMS key.
`void`	`setEnabled(Boolean enabled)` Specifies whether the KMS key is enabled.
`void`	`setEncryptionAlgorithms(Collection<String> encryptionAlgorithms)` The encryption algorithms that the KMS key supports.
`void`	`setExpirationModel(ExpirationModelType expirationModel)` Specifies whether the KMS key's key material expires.
`void`	`setExpirationModel(String expirationModel)` Specifies whether the KMS key's key material expires.
`void`	`setKeyAgreementAlgorithms(Collection<String> keyAgreementAlgorithms)` The key agreement algorithm used to derive a shared secret.
`void`	`setKeyId(String keyId)` The globally unique identifier for the KMS key.
`void`	`setKeyManager(KeyManagerType keyManager)` The manager of the KMS key.
`void`	`setKeyManager(String keyManager)` The manager of the KMS key.
`void`	`setKeySpec(KeySpec keySpec)` Describes the type of key material in the KMS key.
`void`	`setKeySpec(String keySpec)` Describes the type of key material in the KMS key.
`void`	`setKeyState(KeyState keyState)` The current status of the KMS key.
`void`	`setKeyState(String keyState)` The current status of the KMS key.
`void`	`setKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the KMS key.
`void`	`setKeyUsage(String keyUsage)` The cryptographic operations for which you can use the KMS key.
`void`	`setMacAlgorithms(Collection<String> macAlgorithms)` The message authentication code (MAC) algorithm that the HMAC KMS key supports.
`void`	`setMultiRegion(Boolean multiRegion)` Indicates whether the KMS key is a multi-Region (`True`) or regional (`False`) key.
`void`	`setMultiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)` Lists the primary and replica keys in same multi-Region key.
`void`	`setOrigin(OriginType origin)` The source of the key material for the KMS key.
`void`	`setOrigin(String origin)` The source of the key material for the KMS key.
`void`	`setPendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)` The waiting period before the primary key in a multi-Region key is deleted.
`void`	`setSigningAlgorithms(Collection<String> signingAlgorithms)` The signing algorithms that the KMS key supports.
`void`	`setValidTo(Date validTo)` The time at which the imported key material expires.
`void`	`setXksKeyConfiguration(XksKeyConfigurationType xksKeyConfiguration)` Information about the external key that is associated with a KMS key in an external key store.
`String`	`toString()` Returns a string representation of this object.
`KeyMetadata`	`withArn(String arn)` The Amazon Resource Name (ARN) of the KMS key.
`KeyMetadata`	`withAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
`KeyMetadata`	`withCloudHsmClusterId(String cloudHsmClusterId)` The cluster ID of the CloudHSM cluster that contains the key material for the KMS key.
`KeyMetadata`	`withCreationDate(Date creationDate)` The date and time when the KMS key was created.
`KeyMetadata`	`withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Deprecated.
`KeyMetadata`	`withCustomerMasterKeySpec(String customerMasterKeySpec)` Deprecated.
`KeyMetadata`	`withCustomKeyStoreId(String customKeyStoreId)` A unique identifier for the custom key store that contains the KMS key.
`KeyMetadata`	`withDeletionDate(Date deletionDate)` The date and time after which KMS deletes this KMS key.
`KeyMetadata`	`withDescription(String description)` The description of the KMS key.
`KeyMetadata`	`withEnabled(Boolean enabled)` Specifies whether the KMS key is enabled.
`KeyMetadata`	`withEncryptionAlgorithms(Collection<String> encryptionAlgorithms)` The encryption algorithms that the KMS key supports.
`KeyMetadata`	`withEncryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)` The encryption algorithms that the KMS key supports.
`KeyMetadata`	`withEncryptionAlgorithms(String... encryptionAlgorithms)` The encryption algorithms that the KMS key supports.
`KeyMetadata`	`withExpirationModel(ExpirationModelType expirationModel)` Specifies whether the KMS key's key material expires.
`KeyMetadata`	`withExpirationModel(String expirationModel)` Specifies whether the KMS key's key material expires.
`KeyMetadata`	`withKeyAgreementAlgorithms(Collection<String> keyAgreementAlgorithms)` The key agreement algorithm used to derive a shared secret.
`KeyMetadata`	`withKeyAgreementAlgorithms(KeyAgreementAlgorithmSpec... keyAgreementAlgorithms)` The key agreement algorithm used to derive a shared secret.
`KeyMetadata`	`withKeyAgreementAlgorithms(String... keyAgreementAlgorithms)` The key agreement algorithm used to derive a shared secret.
`KeyMetadata`	`withKeyId(String keyId)` The globally unique identifier for the KMS key.
`KeyMetadata`	`withKeyManager(KeyManagerType keyManager)` The manager of the KMS key.
`KeyMetadata`	`withKeyManager(String keyManager)` The manager of the KMS key.
`KeyMetadata`	`withKeySpec(KeySpec keySpec)` Describes the type of key material in the KMS key.
`KeyMetadata`	`withKeySpec(String keySpec)` Describes the type of key material in the KMS key.
`KeyMetadata`	`withKeyState(KeyState keyState)` The current status of the KMS key.
`KeyMetadata`	`withKeyState(String keyState)` The current status of the KMS key.
`KeyMetadata`	`withKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the KMS key.
`KeyMetadata`	`withKeyUsage(String keyUsage)` The cryptographic operations for which you can use the KMS key.
`KeyMetadata`	`withMacAlgorithms(Collection<String> macAlgorithms)` The message authentication code (MAC) algorithm that the HMAC KMS key supports.
`KeyMetadata`	`withMacAlgorithms(MacAlgorithmSpec... macAlgorithms)` The message authentication code (MAC) algorithm that the HMAC KMS key supports.
`KeyMetadata`	`withMacAlgorithms(String... macAlgorithms)` The message authentication code (MAC) algorithm that the HMAC KMS key supports.
`KeyMetadata`	`withMultiRegion(Boolean multiRegion)` Indicates whether the KMS key is a multi-Region (`True`) or regional (`False`) key.
`KeyMetadata`	`withMultiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)` Lists the primary and replica keys in same multi-Region key.
`KeyMetadata`	`withOrigin(OriginType origin)` The source of the key material for the KMS key.
`KeyMetadata`	`withOrigin(String origin)` The source of the key material for the KMS key.
`KeyMetadata`	`withPendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)` The waiting period before the primary key in a multi-Region key is deleted.
`KeyMetadata`	`withSigningAlgorithms(Collection<String> signingAlgorithms)` The signing algorithms that the KMS key supports.
`KeyMetadata`	`withSigningAlgorithms(SigningAlgorithmSpec... signingAlgorithms)` The signing algorithms that the KMS key supports.
`KeyMetadata`	`withSigningAlgorithms(String... signingAlgorithms)` The signing algorithms that the KMS key supports.
`KeyMetadata`	`withValidTo(Date validTo)` The time at which the imported key material expires.
`KeyMetadata`	`withXksKeyConfiguration(XksKeyConfigurationType xksKeyConfiguration)` Information about the external key that is associated with a KMS key in an external key store.

Methods inherited from class java.lang.Object
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 Amazon Web Services account that owns the KMS key.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
  - getAWSAccountId
```
public String getAWSAccountId()
```
    The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
    
    Returns:
    
    The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
  - withAWSAccountId
```
public KeyMetadata withAWSAccountId(String aWSAccountId)
```
    The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
    
    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 KMS key.
    
    Parameters:
    
    keyId - The globally unique identifier for the KMS key.
  - getKeyId
```
public String getKeyId()
```
    The globally unique identifier for the KMS key.
    
    Returns:
    
    The globally unique identifier for the KMS key.
  - withKeyId
```
public KeyMetadata withKeyId(String keyId)
```
    The globally unique identifier for the KMS key.
    
    Parameters:
    
    keyId - The globally unique identifier for the KMS key.
    
    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 KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
  - withArn
```
public KeyMetadata withArn(String arn)
```
    The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services 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 KMS key was created.
    
    Parameters:
    
    creationDate - The date and time when the KMS key was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time when the KMS key was created.
    
    Returns:
    
    The date and time when the KMS key was created.
  - withCreationDate
```
public KeyMetadata withCreationDate(Date creationDate)
```
    The date and time when the KMS key was created.
    
    Parameters:
    
    creationDate - The date and time when the KMS key 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 KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Parameters:
    
    enabled - Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - withEnabled
```
public KeyMetadata withEnabled(Boolean enabled)
```
    Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Parameters:
    
    enabled - Specifies whether the KMS key 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 KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - setDescription
```
public void setDescription(String description)
```
    The description of the KMS key.
    
    Parameters:
    
    description - The description of the KMS key.
  - getDescription
```
public String getDescription()
```
    The description of the KMS key.
    
    Returns:
    
    The description of the KMS key.
  - withDescription
```
public KeyMetadata withDescription(String description)
```
    The description of the KMS key.
    
    Parameters:
    
    description - The description of the KMS key.
    
    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 KMS key.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the KMS key.
    
    See Also:
    
    KeyUsageType
  - getKeyUsage
```
public String getKeyUsage()
```
    The cryptographic operations for which you can use the KMS key.
    
    Returns:
    
    The cryptographic operations for which you can use the KMS key.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(String keyUsage)
```
    The cryptographic operations for which you can use the KMS key.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the KMS key.
    
    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 KMS key.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the KMS key.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the KMS key.
    
    Parameters:
    
    keyUsage - The cryptographic operations for which you can use the KMS key.
    
    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 current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - getKeyState
```
public String getKeyState()
```
    The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    Returns:
    
    The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(String keyState)
```
    The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the 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 current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(KeyState keyState)
```
    The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyState - The current status of the KMS key.
    
    For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the 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 KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
    
    Parameters:
    
    deletionDate - The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
  - getDeletionDate
```
public Date getDeletionDate()
```
    The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
    
    Returns:
    
    The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
  - withDeletionDate
```
public KeyMetadata withDeletionDate(Date deletionDate)
```
    The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
    
    Parameters:
    
    deletionDate - The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.
    
    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.
    
    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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys 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 key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    See Also:
    
    OriginType
  - getOrigin
```
public String getOrigin()
```
    The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    See Also:
    
    OriginType
  - withOrigin
```
public KeyMetadata withOrigin(String origin)
```
    The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    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 key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    See Also:
    
    OriginType
  - withOrigin
```
public KeyMetadata withOrigin(OriginType origin)
```
    The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setCustomKeyStoreId
```
public void setCustomKeyStoreId(String customKeyStoreId)
```
    A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
    
    Parameters:
    
    customKeyStoreId - A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
    
    Returns:
    
    A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
  - withCustomKeyStoreId
```
public KeyMetadata withCustomKeyStoreId(String customKeyStoreId)
```
    A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
    
    Parameters:
    
    customKeyStoreId - A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudHsmClusterId
```
public void setCloudHsmClusterId(String cloudHsmClusterId)
```
    The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
    
    Parameters:
    
    cloudHsmClusterId - The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
  - getCloudHsmClusterId
```
public String getCloudHsmClusterId()
```
    The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
    
    Returns:
    
    The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
  - withCloudHsmClusterId
```
public KeyMetadata withCloudHsmClusterId(String cloudHsmClusterId)
```
    The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
    
    Parameters:
    
    cloudHsmClusterId - The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationModel
```
public void setExpirationModel(String expirationModel)
```
    Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the KMS key'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 KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Returns:
    
    Specifies whether the KMS key'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 KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the KMS key'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 KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the KMS key'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 KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Parameters:
    
    expirationModel - Specifies whether the KMS key'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
  - setKeyManager
```
public void setKeyManager(String keyManager)
```
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - getKeyManager
```
public String getKeyManager()
```
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Returns:
    
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - withKeyManager
```
public KeyMetadata withKeyManager(String keyManager)
```
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyManagerType
  - setKeyManager
```
public void setKeyManager(KeyManagerType keyManager)
```
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - withKeyManager
```
public KeyMetadata withKeyManager(KeyManagerType keyManager)
```
    The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Parameters:
    
    keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyManagerType
  - setCustomerMasterKeySpec
```
@Deprecated
public void setCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Deprecated.
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Parameters:
    
    customerMasterKeySpec - Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    See Also:
    
    CustomerMasterKeySpec
  - getCustomerMasterKeySpec
```
@Deprecated
public String getCustomerMasterKeySpec()
```
    Deprecated.
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Returns:
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
@Deprecated
public KeyMetadata withCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Deprecated.
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Parameters:
    
    customerMasterKeySpec - Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
@Deprecated
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Deprecated.
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Parameters:
    
    customerMasterKeySpec - Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
@Deprecated
public KeyMetadata withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Deprecated.
    
    Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Parameters:
    
    customerMasterKeySpec - Instead, use the KeySpec field.
    
    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setKeySpec
```
public void setKeySpec(String keySpec)
```
    Describes the type of key material in the KMS key.
    
    Parameters:
    
    keySpec - Describes the type of key material in the KMS key.
    
    See Also:
    
    KeySpec
  - getKeySpec
```
public String getKeySpec()
```
    Describes the type of key material in the KMS key.
    
    Returns:
    
    Describes the type of key material in the KMS key.
    
    See Also:
    
    KeySpec
  - withKeySpec
```
public KeyMetadata withKeySpec(String keySpec)
```
    Describes the type of key material in the KMS key.
    
    Parameters:
    
    keySpec - Describes the type of key material in the KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeySpec
  - setKeySpec
```
public void setKeySpec(KeySpec keySpec)
```
    Describes the type of key material in the KMS key.
    
    Parameters:
    
    keySpec - Describes the type of key material in the KMS key.
    
    See Also:
    
    KeySpec
  - withKeySpec
```
public KeyMetadata withKeySpec(KeySpec keySpec)
```
    Describes the type of key material in the KMS key.
    
    Parameters:
    
    keySpec - Describes the type of key material in the KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeySpec
  - getEncryptionAlgorithms
```
public List<String> getEncryptionAlgorithms()
```
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Returns:
    
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - setEncryptionAlgorithms
```
public void setEncryptionAlgorithms(Collection<String> encryptionAlgorithms)
```
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Parameters:
    
    encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithms
```
public KeyMetadata withEncryptionAlgorithms(String... encryptionAlgorithms)
```
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    NOTE: This method appends the values to the existing list (if any). Use setEncryptionAlgorithms(java.util.Collection) or withEncryptionAlgorithms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithms
```
public KeyMetadata withEncryptionAlgorithms(Collection<String> encryptionAlgorithms)
```
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Parameters:
    
    encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithms
```
public KeyMetadata withEncryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)
```
    The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Parameters:
    
    encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
    
    This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - getSigningAlgorithms
```
public List<String> getSigningAlgorithms()
```
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Returns:
    
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    See Also:
    
    SigningAlgorithmSpec
  - setSigningAlgorithms
```
public void setSigningAlgorithms(Collection<String> signingAlgorithms)
```
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Parameters:
    
    signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithms
```
public KeyMetadata withSigningAlgorithms(String... signingAlgorithms)
```
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    NOTE: This method appends the values to the existing list (if any). Use setSigningAlgorithms(java.util.Collection) or withSigningAlgorithms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithms
```
public KeyMetadata withSigningAlgorithms(Collection<String> signingAlgorithms)
```
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Parameters:
    
    signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithms
```
public KeyMetadata withSigningAlgorithms(SigningAlgorithmSpec... signingAlgorithms)
```
    The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Parameters:
    
    signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
    
    This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - getKeyAgreementAlgorithms
```
public List<String> getKeyAgreementAlgorithms()
```
    The key agreement algorithm used to derive a shared secret.
    
    Returns:
    
    The key agreement algorithm used to derive a shared secret.
    
    See Also:
    
    KeyAgreementAlgorithmSpec
  - setKeyAgreementAlgorithms
```
public void setKeyAgreementAlgorithms(Collection<String> keyAgreementAlgorithms)
```
    The key agreement algorithm used to derive a shared secret.
    
    Parameters:
    
    keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret.
    
    See Also:
    
    KeyAgreementAlgorithmSpec
  - withKeyAgreementAlgorithms
```
public KeyMetadata withKeyAgreementAlgorithms(String... keyAgreementAlgorithms)
```
    The key agreement algorithm used to derive a shared secret.
    
    NOTE: This method appends the values to the existing list (if any). Use setKeyAgreementAlgorithms(java.util.Collection) or withKeyAgreementAlgorithms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyAgreementAlgorithmSpec
  - withKeyAgreementAlgorithms
```
public KeyMetadata withKeyAgreementAlgorithms(Collection<String> keyAgreementAlgorithms)
```
    The key agreement algorithm used to derive a shared secret.
    
    Parameters:
    
    keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyAgreementAlgorithmSpec
  - withKeyAgreementAlgorithms
```
public KeyMetadata withKeyAgreementAlgorithms(KeyAgreementAlgorithmSpec... keyAgreementAlgorithms)
```
    The key agreement algorithm used to derive a shared secret.
    
    Parameters:
    
    keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyAgreementAlgorithmSpec
  - setMultiRegion
```
public void setMultiRegion(Boolean multiRegion)
```
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    Parameters:
    
    multiRegion - Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
  - getMultiRegion
```
public Boolean getMultiRegion()
```
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    Returns:
    
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
  - withMultiRegion
```
public KeyMetadata withMultiRegion(Boolean multiRegion)
```
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    Parameters:
    
    multiRegion - Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isMultiRegion
```
public Boolean isMultiRegion()
```
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    Returns:
    
    Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.
    
    For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
  - setMultiRegionConfiguration
```
public void setMultiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)
```
    Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    - MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    - PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    - ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
    Parameters:
    multiRegionConfiguration - Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    
    MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    
    PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    
    ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
  - getMultiRegionConfiguration
```
public MultiRegionConfiguration getMultiRegionConfiguration()
```
    Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    - MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    - PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    - ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
    Returns:
    Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    
    MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    
    PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    
    ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
  - withMultiRegionConfiguration
```
public KeyMetadata withMultiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)
```
    Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    - MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    - PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    - ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
    Parameters:
    multiRegionConfiguration - Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.
    
    For more information about any listed KMS key, use the DescribeKey operation.
    
    MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
    
    PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
    
    ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingDeletionWindowInDays
```
public void setPendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)
```
    The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
    
    Parameters:
    
    pendingDeletionWindowInDays - The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
  - getPendingDeletionWindowInDays
```
public Integer getPendingDeletionWindowInDays()
```
    The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
    
    Returns:
    
    The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
  - withPendingDeletionWindowInDays
```
public KeyMetadata withPendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)
```
    The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
    
    Parameters:
    
    pendingDeletionWindowInDays - The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
    
    When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMacAlgorithms
```
public List<String> getMacAlgorithms()
```
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Returns:
    
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    See Also:
    
    MacAlgorithmSpec
  - setMacAlgorithms
```
public void setMacAlgorithms(Collection<String> macAlgorithms)
```
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Parameters:
    
    macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    See Also:
    
    MacAlgorithmSpec
  - withMacAlgorithms
```
public KeyMetadata withMacAlgorithms(String... macAlgorithms)
```
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    NOTE: This method appends the values to the existing list (if any). Use setMacAlgorithms(java.util.Collection) or withMacAlgorithms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MacAlgorithmSpec
  - withMacAlgorithms
```
public KeyMetadata withMacAlgorithms(Collection<String> macAlgorithms)
```
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Parameters:
    
    macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MacAlgorithmSpec
  - withMacAlgorithms
```
public KeyMetadata withMacAlgorithms(MacAlgorithmSpec... macAlgorithms)
```
    The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Parameters:
    
    macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key supports.
    
    This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MacAlgorithmSpec
  - setXksKeyConfiguration
```
public void setXksKeyConfiguration(XksKeyConfigurationType xksKeyConfiguration)
```
    Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
    
    Parameters:
    
    xksKeyConfiguration - Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
  - getXksKeyConfiguration
```
public XksKeyConfigurationType getXksKeyConfiguration()
```
    Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
    
    Returns:
    
    Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
  - withXksKeyConfiguration
```
public KeyMetadata withXksKeyConfiguration(XksKeyConfigurationType xksKeyConfiguration)
```
    Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
    
    Parameters:
    
    xksKeyConfiguration - Information about the external key that is associated with a KMS key in an external key store.
    
    For more information, see External key in the Key Management Service Developer Guide.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

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

setCustomKeyStoreId

getCustomKeyStoreId

withCustomKeyStoreId

setCloudHsmClusterId

getCloudHsmClusterId

withCloudHsmClusterId

setExpirationModel

getExpirationModel

withExpirationModel

setExpirationModel

withExpirationModel

setKeyManager

getKeyManager

withKeyManager

setKeyManager

withKeyManager

setCustomerMasterKeySpec

getCustomerMasterKeySpec

withCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

setKeySpec

getKeySpec

withKeySpec

setKeySpec

withKeySpec

getEncryptionAlgorithms

setEncryptionAlgorithms

withEncryptionAlgorithms

withEncryptionAlgorithms

withEncryptionAlgorithms

getSigningAlgorithms