Module: Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState

Defined in:

proto_docs/google/cloud/kms/v1/resources.rb

Overview

The state of a CryptoKeyVersion, indicating if it can be used.

Constant Summary

CRYPTO_KEY_VERSION_STATE_UNSPECIFIED =

Not specified.

0

PENDING_GENERATION =

This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.

5

ENABLED =

This version may be used for cryptographic operations.

1

DISABLED =

This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.

2

DESTROYED =

This version is destroyed, and the key material is no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to [KeyManagementService.ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].

3

DESTROY_SCHEDULED =

This version is scheduled for destruction, and will be destroyed soon. Call [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to put it back into the DISABLED state.

4

PENDING_IMPORT =

This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.

6

IMPORT_FAILED =

This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.

7

GENERATION_FAILED =

This version was not generated successfully. It may not be used, enabled, disabled, or destroyed. Additional details can be found in CryptoKeyVersion.generation_failure_reason.

8

PENDING_EXTERNAL_DESTRUCTION =

This version was destroyed, and it may not be used or enabled again. Cloud KMS is waiting for the corresponding key material residing in an external key manager to be destroyed.

9

EXTERNAL_DESTRUCTION_FAILED =

This version was destroyed, and it may not be used or enabled again. However, Cloud KMS could not confirm that the corresponding key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason.

10