Google Cloud Native v0.30.0, Apr 14 23

google-native.cloudkms/v1.getCryptoKeyVersion

Explore with Pulumi AI

Returns metadata for a given CryptoKeyVersion.

Using getCryptoKeyVersion

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCryptoKeyVersion(args: GetCryptoKeyVersionArgs, opts?: InvokeOptions): Promise<GetCryptoKeyVersionResult>
function getCryptoKeyVersionOutput(args: GetCryptoKeyVersionOutputArgs, opts?: InvokeOptions): Output<GetCryptoKeyVersionResult>

def get_crypto_key_version(crypto_key_id: Optional[str] = None,
                           crypto_key_version_id: Optional[str] = None,
                           key_ring_id: Optional[str] = None,
                           location: Optional[str] = None,
                           project: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCryptoKeyVersionResult
def get_crypto_key_version_output(crypto_key_id: Optional[pulumi.Input[str]] = None,
                           crypto_key_version_id: Optional[pulumi.Input[str]] = None,
                           key_ring_id: Optional[pulumi.Input[str]] = None,
                           location: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCryptoKeyVersionResult]

func LookupCryptoKeyVersion(ctx *Context, args *LookupCryptoKeyVersionArgs, opts ...InvokeOption) (*LookupCryptoKeyVersionResult, error)
func LookupCryptoKeyVersionOutput(ctx *Context, args *LookupCryptoKeyVersionOutputArgs, opts ...InvokeOption) LookupCryptoKeyVersionResultOutput

> Note: This function is named LookupCryptoKeyVersion in the Go SDK.

public static class GetCryptoKeyVersion 
{
    public static Task<GetCryptoKeyVersionResult> InvokeAsync(GetCryptoKeyVersionArgs args, InvokeOptions? opts = null)
    public static Output<GetCryptoKeyVersionResult> Invoke(GetCryptoKeyVersionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCryptoKeyVersionResult> getCryptoKeyVersion(GetCryptoKeyVersionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:cloudkms/v1:getCryptoKeyVersion
  arguments:
    # arguments dictionary

The following arguments are supported:

CryptoKeyId string
CryptoKeyVersionId string
KeyRingId string
Location string
Project string

CryptoKeyId string
CryptoKeyVersionId string
KeyRingId string
Location string
Project string

cryptoKeyId String
cryptoKeyVersionId String
keyRingId String
location String
project String

cryptoKeyId string
cryptoKeyVersionId string
keyRingId string
location string
project string

crypto_key_id str
crypto_key_version_id str
key_ring_id str
location str
project str

cryptoKeyId String
cryptoKeyVersionId String
keyRingId String
location String
project String

getCryptoKeyVersion Result

The following output properties are available:

Algorithm string: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
Attestation Pulumi.GoogleNative.Cloudkms.V1.Outputs.KeyOperationAttestationResponse: 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.
CreateTime string: The time at which this CryptoKeyVersion was created.
DestroyEventTime string: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
DestroyTime string: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
ExternalDestructionFailureReason string: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
ExternalProtectionLevelOptions Pulumi.GoogleNative.Cloudkms.V1.Outputs.ExternalProtectionLevelOptionsResponse: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
GenerateTime string: The time this CryptoKeyVersion's key material was generated.
GenerationFailureReason string: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
ImportFailureReason string: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
ImportJob string: The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
ImportTime string: The time at which this CryptoKeyVersion's key material was most recently imported.
Name string: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
ProtectionLevel string: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
ReimportEligible bool: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
State string: The current state of the CryptoKeyVersion.

Algorithm string: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
Attestation KeyOperationAttestationResponse: 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.
CreateTime string: The time at which this CryptoKeyVersion was created.
DestroyEventTime string: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
DestroyTime string: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
ExternalDestructionFailureReason string: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
ExternalProtectionLevelOptions ExternalProtectionLevelOptionsResponse: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
GenerateTime string: The time this CryptoKeyVersion's key material was generated.
GenerationFailureReason string: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
ImportFailureReason string: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
ImportJob string: The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
ImportTime string: The time at which this CryptoKeyVersion's key material was most recently imported.
Name string: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
ProtectionLevel string: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
ReimportEligible bool: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
State string: The current state of the CryptoKeyVersion.

algorithm String: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
attestation KeyOperationAttestationResponse: 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.
createTime String: The time at which this CryptoKeyVersion was created.
destroyEventTime String: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
destroyTime String: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
externalDestructionFailureReason String: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
externalProtectionLevelOptions ExternalProtectionLevelOptionsResponse: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
generateTime String: The time this CryptoKeyVersion's key material was generated.
generationFailureReason String: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
importFailureReason String: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
importJob String: The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
importTime String: The time at which this CryptoKeyVersion's key material was most recently imported.
name String: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
protectionLevel String: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
reimportEligible Boolean: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
state String: The current state of the CryptoKeyVersion.

algorithm string: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
attestation KeyOperationAttestationResponse: 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.
createTime string: The time at which this CryptoKeyVersion was created.
destroyEventTime string: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
destroyTime string: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
externalDestructionFailureReason string: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
externalProtectionLevelOptions ExternalProtectionLevelOptionsResponse: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
generateTime string: The time this CryptoKeyVersion's key material was generated.
generationFailureReason string: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
importFailureReason string: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
importJob string: The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
importTime string: The time at which this CryptoKeyVersion's key material was most recently imported.
name string: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
protectionLevel string: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
reimportEligible boolean: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
state string: The current state of the CryptoKeyVersion.

algorithm str: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
attestation KeyOperationAttestationResponse: 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 str: The time at which this CryptoKeyVersion was created.
destroy_event_time str: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
destroy_time str: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
external_destruction_failure_reason str: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
external_protection_level_options ExternalProtectionLevelOptionsResponse: 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 str: The time this CryptoKeyVersion's key material was generated.
generation_failure_reason str: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
import_failure_reason str: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
import_job str: 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 str: The time at which this CryptoKeyVersion's key material was most recently imported.
name str: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
protection_level str: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
reimport_eligible bool: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
state str: The current state of the CryptoKeyVersion.

algorithm String: The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
attestation Property Map: 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.
createTime String: The time at which this CryptoKeyVersion was created.
destroyEventTime String: The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
destroyTime String: The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
externalDestructionFailureReason String: The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
externalProtectionLevelOptions Property Map: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
generateTime String: The time this CryptoKeyVersion's key material was generated.
generationFailureReason String: The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
importFailureReason String: The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
importJob String: The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
importTime String: The time at which this CryptoKeyVersion's key material was most recently imported.
name String: The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
protectionLevel String: The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
reimportEligible Boolean: Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
state String: The current state of the CryptoKeyVersion.

Supporting Types

CertificateChainsResponse

CaviumCerts List<string>: Cavium certificate chain corresponding to the attestation.
GoogleCardCerts List<string>: Google card certificate chain corresponding to the attestation.
GooglePartitionCerts List<string>: Google partition certificate chain corresponding to the attestation.

CaviumCerts []string: Cavium certificate chain corresponding to the attestation.
GoogleCardCerts []string: Google card certificate chain corresponding to the attestation.
GooglePartitionCerts []string: Google partition certificate chain corresponding to the attestation.

caviumCerts List<String>: Cavium certificate chain corresponding to the attestation.
googleCardCerts List<String>: Google card certificate chain corresponding to the attestation.
googlePartitionCerts List<String>: Google partition certificate chain corresponding to the attestation.

caviumCerts string[]: Cavium certificate chain corresponding to the attestation.
googleCardCerts string[]: Google card certificate chain corresponding to the attestation.
googlePartitionCerts string[]: Google partition certificate chain corresponding to the attestation.

cavium_certs Sequence[str]: Cavium certificate chain corresponding to the attestation.
google_card_certs Sequence[str]: Google card certificate chain corresponding to the attestation.
google_partition_certs Sequence[str]: Google partition certificate chain corresponding to the attestation.

caviumCerts List<String>: Cavium certificate chain corresponding to the attestation.
googleCardCerts List<String>: Google card certificate chain corresponding to the attestation.
googlePartitionCerts List<String>: Google partition certificate chain corresponding to the attestation.

ExternalProtectionLevelOptionsResponse

EkmConnectionKeyPath string: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
ExternalKeyUri string: The URI for an external resource that this CryptoKeyVersion represents.

EkmConnectionKeyPath string: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
ExternalKeyUri string: The URI for an external resource that this CryptoKeyVersion represents.

ekmConnectionKeyPath String: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
externalKeyUri String: The URI for an external resource that this CryptoKeyVersion represents.

ekmConnectionKeyPath string: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
externalKeyUri string: The URI for an external resource that this CryptoKeyVersion represents.

ekm_connection_key_path str: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
external_key_uri str: The URI for an external resource that this CryptoKeyVersion represents.

ekmConnectionKeyPath String: The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
externalKeyUri String: The URI for an external resource that this CryptoKeyVersion represents.

KeyOperationAttestationResponse

CertChains Pulumi.GoogleNative.Cloudkms.V1.Inputs.CertificateChainsResponse: The certificate chains needed to validate the attestation
Content string: The attestation data provided by the HSM when the key operation was performed.
Format string: The format of the attestation data.

CertChains CertificateChainsResponse: The certificate chains needed to validate the attestation
Content string: The attestation data provided by the HSM when the key operation was performed.
Format string: The format of the attestation data.

certChains CertificateChainsResponse: The certificate chains needed to validate the attestation
content String: The attestation data provided by the HSM when the key operation was performed.
format String: The format of the attestation data.

certChains CertificateChainsResponse: The certificate chains needed to validate the attestation
content string: The attestation data provided by the HSM when the key operation was performed.
format string: The format of the attestation data.

cert_chains CertificateChainsResponse: The certificate chains needed to validate the attestation
content str: The attestation data provided by the HSM when the key operation was performed.
format str: The format of the attestation data.

certChains Property Map: The certificate chains needed to validate the attestation
content String: The attestation data provided by the HSM when the key operation was performed.
format String: The format of the attestation data.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0