Cloud Key Management Service (KMS) V1 API - Module Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState (v0.23.0)

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API module Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState.

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

Constants

CRYPTO_KEY_VERSION_STATE_UNSPECIFIED

value: 0
Not specified.

PENDING_GENERATION

value: 5
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.

ENABLED

value: 1
This version may be used for cryptographic operations.

DISABLED

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

DESTROYED

value: 3
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.

DESTROY_SCHEDULED

value: 4
This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.

PENDING_IMPORT

value: 6
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.

IMPORT_FAILED

value: 7
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.

GENERATION_FAILED

value: 8
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.

PENDING_EXTERNAL_DESTRUCTION

value: 9
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.

EXTERNAL_DESTRUCTION_FAILED

value: 10
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.