KeyMetadata (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class KeyMetadata
extends java.lang.Object
implements java.io.Serializable
```
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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getArn()` The Amazon Resource Name (ARN) of the CMK.
`java.lang.String`	`getAWSAccountId()` The twelve-digit account ID of the AWS account that owns the CMK.
`java.lang.String`	`getCloudHsmClusterId()` The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK.
`java.util.Date`	`getCreationDate()` The date and time when the CMK was created.
`java.lang.String`	`getCustomerMasterKeySpec()` Describes the type of key material in the CMK.
`java.lang.String`	`getCustomKeyStoreId()` A unique identifier for the custom key store that contains the CMK.
`java.util.Date`	`getDeletionDate()` The date and time after which AWS KMS deletes the CMK.
`java.lang.String`	`getDescription()` The description of the CMK.
`java.lang.Boolean`	`getEnabled()` Specifies whether the CMK is enabled.
`java.util.List<java.lang.String>`	`getEncryptionAlgorithms()` The encryption algorithms that the CMK supports.
`java.lang.String`	`getExpirationModel()` Specifies whether the CMK's key material expires.
`java.lang.String`	`getKeyId()` The globally unique identifier for the CMK.
`java.lang.String`	`getKeyManager()` The manager of the CMK.
`java.lang.String`	`getKeyState()` The current status of the CMK.
`java.lang.String`	`getKeyUsage()` The cryptographic operations for which you can use the CMK.
`java.lang.String`	`getOrigin()` The source of the CMK's key material.
`java.util.List<java.lang.String>`	`getSigningAlgorithms()` The signing algorithms that the CMK supports.
`java.util.Date`	`getValidTo()` The time at which the imported key material expires.
`int`	`hashCode()`
`java.lang.Boolean`	`isEnabled()` Specifies whether the CMK is enabled.
`void`	`setArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the CMK.
`void`	`setAWSAccountId(java.lang.String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`void`	`setCloudHsmClusterId(java.lang.String cloudHsmClusterId)` The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK.
`void`	`setCreationDate(java.util.Date creationDate)` The date and time when the CMK was created.
`void`	`setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Describes the type of key material in the CMK.
`void`	`setCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)` Describes the type of key material in the CMK.
`void`	`setCustomKeyStoreId(java.lang.String customKeyStoreId)` A unique identifier for the custom key store that contains the CMK.
`void`	`setDeletionDate(java.util.Date deletionDate)` The date and time after which AWS KMS deletes the CMK.
`void`	`setDescription(java.lang.String description)` The description of the CMK.
`void`	`setEnabled(java.lang.Boolean enabled)` Specifies whether the CMK is enabled.
`void`	`setEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)` The encryption algorithms that the CMK supports.
`void`	`setExpirationModel(ExpirationModelType expirationModel)` Specifies whether the CMK's key material expires.
`void`	`setExpirationModel(java.lang.String expirationModel)` Specifies whether the CMK's key material expires.
`void`	`setKeyId(java.lang.String keyId)` The globally unique identifier for the CMK.
`void`	`setKeyManager(KeyManagerType keyManager)` The manager of the CMK.
`void`	`setKeyManager(java.lang.String keyManager)` The manager of the CMK.
`void`	`setKeyState(KeyState keyState)` The current status of the CMK.
`void`	`setKeyState(java.lang.String keyState)` The current status of the CMK.
`void`	`setKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`void`	`setKeyUsage(java.lang.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(java.lang.String origin)` The source of the CMK's key material.
`void`	`setSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)` The signing algorithms that the CMK supports.
`void`	`setValidTo(java.util.Date validTo)` The time at which the imported key material expires.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`KeyMetadata`	`withArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the CMK.
`KeyMetadata`	`withAWSAccountId(java.lang.String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`KeyMetadata`	`withCloudHsmClusterId(java.lang.String cloudHsmClusterId)` The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK.
`KeyMetadata`	`withCreationDate(java.util.Date creationDate)` The date and time when the CMK was created.
`KeyMetadata`	`withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Describes the type of key material in the CMK.
`KeyMetadata`	`withCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)` Describes the type of key material in the CMK.
`KeyMetadata`	`withCustomKeyStoreId(java.lang.String customKeyStoreId)` A unique identifier for the custom key store that contains the CMK.
`KeyMetadata`	`withDeletionDate(java.util.Date deletionDate)` The date and time after which AWS KMS deletes the CMK.
`KeyMetadata`	`withDescription(java.lang.String description)` The description of the CMK.
`KeyMetadata`	`withEnabled(java.lang.Boolean enabled)` Specifies whether the CMK is enabled.
`KeyMetadata`	`withEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)` The encryption algorithms that the CMK supports.
`KeyMetadata`	`withEncryptionAlgorithms(java.lang.String... encryptionAlgorithms)` The encryption algorithms that the CMK supports.
`KeyMetadata`	`withExpirationModel(ExpirationModelType expirationModel)` Specifies whether the CMK's key material expires.
`KeyMetadata`	`withExpirationModel(java.lang.String expirationModel)` Specifies whether the CMK's key material expires.
`KeyMetadata`	`withKeyId(java.lang.String keyId)` The globally unique identifier for the CMK.
`KeyMetadata`	`withKeyManager(KeyManagerType keyManager)` The manager of the CMK.
`KeyMetadata`	`withKeyManager(java.lang.String keyManager)` The manager of the CMK.
`KeyMetadata`	`withKeyState(KeyState keyState)` The current status of the CMK.
`KeyMetadata`	`withKeyState(java.lang.String keyState)` The current status of the CMK.
`KeyMetadata`	`withKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`KeyMetadata`	`withKeyUsage(java.lang.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(java.lang.String origin)` The source of the CMK's key material.
`KeyMetadata`	`withSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)` The signing algorithms that the CMK supports.
`KeyMetadata`	`withSigningAlgorithms(java.lang.String... signingAlgorithms)` The signing algorithms that the CMK supports.
`KeyMetadata`	`withValidTo(java.util.Date validTo)` The time at which the imported key material expires.

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

- Constructor Detail
  - KeyMetadata
```
public KeyMetadata()
```
- Method Detail
  - getAWSAccountId
```
public java.lang.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.
  - setAWSAccountId
```
public void setAWSAccountId(java.lang.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.
  - withAWSAccountId
```
public KeyMetadata withAWSAccountId(java.lang.String aWSAccountId)
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    aWSAccountId -
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyId
```
public java.lang.String getKeyId()
```
    The globally unique identifier for the CMK.
    
    Constraints:
    Length: 1 - 2048
    
    Returns:
    
    The globally unique identifier for the CMK.
  - setKeyId
```
public void setKeyId(java.lang.String keyId)
```
    The globally unique identifier for the CMK.
    
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The globally unique identifier for the CMK.
  - withKeyId
```
public KeyMetadata withKeyId(java.lang.String keyId)
```
    The globally unique identifier for the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The globally unique identifier for the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getArn
```
public java.lang.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.
    
    Constraints:
    Length: 20 - 2048
    
    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.
  - setArn
```
public void setArn(java.lang.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.
    
    Constraints:
    Length: 20 - 2048
    
    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.
  - withArn
```
public KeyMetadata withArn(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreationDate
```
public java.util.Date getCreationDate()
```
    The date and time when the CMK was created.
    
    Returns:
    
    The date and time when the CMK was created.
  - setCreationDate
```
public void setCreationDate(java.util.Date creationDate)
```
    The date and time when the CMK was created.
    
    Parameters:
    
    creationDate -
    The date and time when the CMK was created.
  - withCreationDate
```
public KeyMetadata withCreationDate(java.util.Date creationDate)
```
    The date and time when the CMK was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    creationDate -
    The date and time when the CMK was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isEnabled
```
public java.lang.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.
  - getEnabled
```
public java.lang.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.
  - setEnabled
```
public void setEnabled(java.lang.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.
  - withEnabled
```
public KeyMetadata withEnabled(java.lang.Boolean enabled)
```
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    enabled -
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the CMK.
    
    Constraints:
    Length: 0 - 8192
    
    Returns:
    
    The description of the CMK.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    The description of the CMK.
    
    Constraints:
    Length: 0 - 8192
    
    Parameters:
    
    description -
    The description of the CMK.
  - withDescription
```
public KeyMetadata withDescription(java.lang.String description)
```
    The description of the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 8192
    
    Parameters:
    
    description -
    The description of the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyUsage
```
public java.lang.String getKeyUsage()
```
    The cryptographic operations for which you can use the CMK.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Returns:
    
    The cryptographic operations for which you can use the CMK.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(java.lang.String keyUsage)
```
    The cryptographic operations for which you can use the CMK.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(java.lang.String keyUsage)
```
    The cryptographic operations for which you can use the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK.
    
    Returns:
    
    A reference to this updated 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.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public KeyMetadata withKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - getKeyState
```
public java.lang.String getKeyState()
```
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport, Unavailable
    
    Returns:
    
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - setKeyState
```
public void setKeyState(java.lang.String keyState)
```
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport, Unavailable
    
    Parameters:
    
    keyState -
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(java.lang.String keyState)
```
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport, Unavailable
    
    Parameters:
    
    keyState -
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyState
  - setKeyState
```
public void setKeyState(KeyState keyState)
```
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport, Unavailable
    
    Parameters:
    
    keyState -
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyState
  - withKeyState
```
public KeyMetadata withKeyState(KeyState keyState)
```
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport, Unavailable
    
    Parameters:
    
    keyState -
    The current status of the CMK.
    
    For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyState
  - getDeletionDate
```
public java.util.Date getDeletionDate()
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
    
    Returns:
    
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
  - setDeletionDate
```
public void setDeletionDate(java.util.Date deletionDate)
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
    
    Parameters:
    
    deletionDate -
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
  - withDeletionDate
```
public KeyMetadata withDeletionDate(java.util.Date deletionDate)
```
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deletionDate -
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getValidTo
```
public java.util.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.
  - setValidTo
```
public void setValidTo(java.util.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.
  - withValidTo
```
public KeyMetadata withValidTo(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getOrigin
```
public java.lang.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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    See Also:
    
    OriginType
  - setOrigin
```
public void setOrigin(java.lang.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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    See Also:
    
    OriginType
  - withOrigin
```
public KeyMetadata withOrigin(java.lang.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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    A reference to this updated 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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - getCustomKeyStoreId
```
public java.lang.String getCustomKeyStoreId()
```
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
    
    Constraints:
    Length: 1 - 64
    
    Returns:
    
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
  - setCustomKeyStoreId
```
public void setCustomKeyStoreId(java.lang.String customKeyStoreId)
```
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
    
    Constraints:
    Length: 1 - 64
    
    Parameters:
    
    customKeyStoreId -
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
  - withCustomKeyStoreId
```
public KeyMetadata withCustomKeyStoreId(java.lang.String customKeyStoreId)
```
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    
    customKeyStoreId -
    A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCloudHsmClusterId
```
public java.lang.String getCloudHsmClusterId()
```
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
    
    Constraints:
    Length: 19 - 24
    
    Returns:
    
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
  - setCloudHsmClusterId
```
public void setCloudHsmClusterId(java.lang.String cloudHsmClusterId)
```
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
    
    Constraints:
    Length: 19 - 24
    
    Parameters:
    
    cloudHsmClusterId -
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
  - withCloudHsmClusterId
```
public KeyMetadata withCloudHsmClusterId(java.lang.String cloudHsmClusterId)
```
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 19 - 24
    
    Parameters:
    
    cloudHsmClusterId -
    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExpirationModel
```
public java.lang.String getExpirationModel()
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Constraints:
    Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
    
    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
  - setExpirationModel
```
public void setExpirationModel(java.lang.String expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Constraints:
    Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
    
    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(java.lang.String expirationModel)
```
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
    
    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:
    
    A reference to this updated 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.
    
    Constraints:
    Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
    
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ExpirationModelType
  - getKeyManager
```
public java.lang.String getKeyManager()
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: AWS, CUSTOMER
    
    Returns:
    
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - setKeyManager
```
public void setKeyManager(java.lang.String keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: AWS, CUSTOMER
    
    Parameters:
    
    keyManager -
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - withKeyManager
```
public KeyMetadata withKeyManager(java.lang.String keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS, CUSTOMER
    
    Parameters:
    
    keyManager -
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyManagerType
  - setKeyManager
```
public void setKeyManager(KeyManagerType keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Allowed Values: AWS, CUSTOMER
    
    Parameters:
    
    keyManager -
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    KeyManagerType
  - withKeyManager
```
public KeyMetadata withKeyManager(KeyManagerType keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS, CUSTOMER
    
    Parameters:
    
    keyManager -
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyManagerType
  - getCustomerMasterKeySpec
```
public java.lang.String getCustomerMasterKeySpec()
```
    Describes the type of key material in the CMK.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Returns:
    
    Describes the type of key material in the CMK.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
```
    Describes the type of key material in the CMK.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    Describes the type of key material in the CMK.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public KeyMetadata withCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
```
    Describes the type of key material in the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    Describes the type of key material in the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Describes the type of key material in the CMK.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    Describes the type of key material in the CMK.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public KeyMetadata withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Describes the type of key material in the CMK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    Describes the type of key material in the CMK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - getEncryptionAlgorithms
```
public java.util.List<java.lang.String> getEncryptionAlgorithms()
```
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Returns:
    
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
  - setEncryptionAlgorithms
```
public void setEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
```
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Parameters:
    
    encryptionAlgorithms -
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
  - withEncryptionAlgorithms
```
public KeyMetadata withEncryptionAlgorithms(java.lang.String... encryptionAlgorithms)
```
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encryptionAlgorithms -
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withEncryptionAlgorithms
```
public KeyMetadata withEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
```
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encryptionAlgorithms -
    The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSigningAlgorithms
```
public java.util.List<java.lang.String> getSigningAlgorithms()
```
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Returns:
    
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
  - setSigningAlgorithms
```
public void setSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
```
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Parameters:
    
    signingAlgorithms -
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
  - withSigningAlgorithms
```
public KeyMetadata withSigningAlgorithms(java.lang.String... signingAlgorithms)
```
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    signingAlgorithms -
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSigningAlgorithms
```
public KeyMetadata withSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
```
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    signingAlgorithms -
    The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
    
    This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class KeyMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyMetadata

Method Detail

getAWSAccountId

setAWSAccountId

withAWSAccountId

getKeyId

setKeyId

withKeyId

getArn

setArn

withArn

getCreationDate

setCreationDate

withCreationDate

isEnabled

getEnabled

setEnabled

withEnabled

getDescription

setDescription

withDescription

getKeyUsage

setKeyUsage

withKeyUsage

setKeyUsage

withKeyUsage

getKeyState

setKeyState

withKeyState

setKeyState

withKeyState

getDeletionDate

setDeletionDate

withDeletionDate

getValidTo

setValidTo

withValidTo

getOrigin

setOrigin

withOrigin

setOrigin

withOrigin

getCustomKeyStoreId

setCustomKeyStoreId

withCustomKeyStoreId

getCloudHsmClusterId

setCloudHsmClusterId

withCloudHsmClusterId

getExpirationModel

setExpirationModel

withExpirationModel

setExpirationModel

withExpirationModel

getKeyManager

setKeyManager

withKeyManager

setKeyManager

withKeyManager

getCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

getEncryptionAlgorithms

setEncryptionAlgorithms

withEncryptionAlgorithms

withEncryptionAlgorithms

getSigningAlgorithms

setSigningAlgorithms

withSigningAlgorithms

withSigningAlgorithms

toString

hashCode

equals