Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::CryptoKeyVersion.
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.
An ENABLED version can be used for cryptographic operations.
For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#algorithm
def algorithm() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm
Returns
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
#attestation
def attestation() -> ::Google::Cloud::Kms::V1::KeyOperationAttestation
Returns
- (::Google::Cloud::Kms::V1::KeyOperationAttestation) — Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CryptoKeyVersion was created.
#destroy_event_time
def destroy_event_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
#destroy_time
def destroy_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
#external_destruction_failure_reason
def external_destruction_failure_reason() -> ::String
Returns
- (::String) — Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
#external_protection_level_options
def external_protection_level_options() -> ::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions
Returns
- (::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions) — ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
#external_protection_level_options=
def external_protection_level_options=(value) -> ::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions
Parameter
- value (::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions) — ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
Returns
- (::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions) — ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
#generate_time
def generate_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time this CryptoKeyVersion's key material was generated.
#generation_failure_reason
def generation_failure_reason() -> ::String
Returns
- (::String) — Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
#import_failure_reason
def import_failure_reason() -> ::String
Returns
- (::String) — Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
#import_job
def import_job() -> ::String
Returns
- (::String) — Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
#import_time
def import_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name for this
CryptoKeyVersion in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
#protection_level
def protection_level() -> ::Google::Cloud::Kms::V1::ProtectionLevel
Returns
- (::Google::Cloud::Kms::V1::ProtectionLevel) — Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
#reimport_eligible
def reimport_eligible() -> ::Boolean
Returns
- (::Boolean) — Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
#state
def state() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState
Returns
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState) — The current state of the CryptoKeyVersion.
#state=
def state=(value) -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState
Parameter
- value (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState) — The current state of the CryptoKeyVersion.
Returns
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState) — The current state of the CryptoKeyVersion.