1. Docs
  2. Reference
  3. API
  4. GCP
  5. kms
  6. GetKMSCryptoKeyVersion

GetKMSCryptoKeyVersion

Provides access to a Google Cloud Platform KMS CryptoKeyVersion. For more information see the official documentation and API.

A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.

Using GetKMSCryptoKeyVersion

function getKMSCryptoKeyVersion(args: GetKMSCryptoKeyVersionArgs, opts?: InvokeOptions): Promise<GetKMSCryptoKeyVersionResult>
function  get_kms_crypto_key_version(crypto_key=None, version=None, opts=None)
func GetKMSCryptoKeyVersion(ctx *Context, args *GetKMSCryptoKeyVersionArgs, opts ...InvokeOption) (*GetKMSCryptoKeyVersionResult, error)
public static class GetKMSCryptoKeyVersion {
    public static Task<GetKMSCryptoKeyVersionResult> InvokeAsync(GetKMSCryptoKeyVersionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

CryptoKey string

The self_link of the Google Cloud Platform CryptoKey to which the key version belongs.

Version int

The version number for this CryptoKeyVersion. Defaults to 1.

CryptoKey string

The self_link of the Google Cloud Platform CryptoKey to which the key version belongs.

Version int

The version number for this CryptoKeyVersion. Defaults to 1.

cryptoKey string

The self_link of the Google Cloud Platform CryptoKey to which the key version belongs.

version number

The version number for this CryptoKeyVersion. Defaults to 1.

crypto_key str

The self_link of the Google Cloud Platform CryptoKey to which the key version belongs.

version float

The version number for this CryptoKeyVersion. Defaults to 1.

GetKMSCryptoKeyVersion Result

The following output properties are available:

Algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

CryptoKey string
Id string

The provider-assigned unique ID for this managed resource.

ProtectionLevel string

The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. See the protection_level reference for possible outputs.

PublicKey GetKMSCryptoKeyVersionPublicKey

If the enclosing CryptoKey has purpose ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT, this block contains details about the public key associated to this CryptoKeyVersion. Structure is documented below.

State string

The current state of the CryptoKeyVersion. See the state reference for possible outputs.

Version int
Algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

CryptoKey string
Id string

The provider-assigned unique ID for this managed resource.

ProtectionLevel string

The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. See the protection_level reference for possible outputs.

PublicKey GetKMSCryptoKeyVersionPublicKey

If the enclosing CryptoKey has purpose ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT, this block contains details about the public key associated to this CryptoKeyVersion. Structure is documented below.

State string

The current state of the CryptoKeyVersion. See the state reference for possible outputs.

Version int
algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

cryptoKey string
id string

The provider-assigned unique ID for this managed resource.

protectionLevel string

The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. See the protection_level reference for possible outputs.

publicKey GetKMSCryptoKeyVersionPublicKey

If the enclosing CryptoKey has purpose ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT, this block contains details about the public key associated to this CryptoKeyVersion. Structure is documented below.

state string

The current state of the CryptoKeyVersion. See the state reference for possible outputs.

version number
algorithm str

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

crypto_key str
id str

The provider-assigned unique ID for this managed resource.

protection_level str

The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. See the protection_level reference for possible outputs.

public_key Dict[GetKMSCryptoKeyVersionPublicKey]

If the enclosing CryptoKey has purpose ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT, this block contains details about the public key associated to this CryptoKeyVersion. Structure is documented below.

state str

The current state of the CryptoKeyVersion. See the state reference for possible outputs.

version float

Supporting Types

GetKMSCryptoKeyVersionPublicKey

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

Pem string

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

Algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

Pem string

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

algorithm string

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

pem string

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

algorithm str

The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

pem str

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.