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

GetKMSCryptoKey

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

A CryptoKey is an interface to key material which can be used to encrypt and decrypt data. A CryptoKey belongs to a Google Cloud KMS KeyRing.

Using GetKMSCryptoKey

function getKMSCryptoKey(args: GetKMSCryptoKeyArgs, opts?: InvokeOptions): Promise<GetKMSCryptoKeyResult>
function  get_kms_crypto_key(key_ring=None, name=None, opts=None)
func GetKMSCryptoKey(ctx *Context, args *GetKMSCryptoKeyArgs, opts ...InvokeOption) (*GetKMSCryptoKeyResult, error)
public static class GetKMSCryptoKey {
    public static Task<GetKMSCryptoKeyResult> InvokeAsync(GetKMSCryptoKeyArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

KeyRing string

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

Name string

The CryptoKey’s name. A CryptoKey’s name belonging to the specified Google Cloud Platform KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

KeyRing string

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

Name string

The CryptoKey’s name. A CryptoKey’s name belonging to the specified Google Cloud Platform KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

keyRing string

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

name string

The CryptoKey’s name. A CryptoKey’s name belonging to the specified Google Cloud Platform KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

key_ring str

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

name str

The CryptoKey’s name. A CryptoKey’s name belonging to the specified Google Cloud Platform KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

GetKMSCryptoKey Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

KeyRing string
Labels Dictionary<string, string>
Name string
Purpose string

Defines the cryptographic capabilities of the key.

RotationPeriod string

Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter s (seconds).

SelfLink string

The self link of the created CryptoKey. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}/cryptoKeys/{cryptoKeyName}.

VersionTemplates List<GetKMSCryptoKeyVersionTemplate>
Id string

The provider-assigned unique ID for this managed resource.

KeyRing string
Labels map[string]string
Name string
Purpose string

Defines the cryptographic capabilities of the key.

RotationPeriod string

Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter s (seconds).

SelfLink string

The self link of the created CryptoKey. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}/cryptoKeys/{cryptoKeyName}.

VersionTemplates []GetKMSCryptoKeyVersionTemplate
id string

The provider-assigned unique ID for this managed resource.

keyRing string
labels {[key: string]: string}
name string
purpose string

Defines the cryptographic capabilities of the key.

rotationPeriod string

Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter s (seconds).

selfLink string

The self link of the created CryptoKey. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}/cryptoKeys/{cryptoKeyName}.

versionTemplates GetKMSCryptoKeyVersionTemplate[]
id str

The provider-assigned unique ID for this managed resource.

key_ring str
labels Dict[str, str]
name str
purpose str

Defines the cryptographic capabilities of the key.

rotation_period str

Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter s (seconds).

self_link str

The self link of the created CryptoKey. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}/cryptoKeys/{cryptoKeyName}.

version_templates List[GetKMSCryptoKeyVersionTemplate]

Supporting Types

GetKMSCryptoKeyVersionTemplate

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
ProtectionLevel string
Algorithm string
ProtectionLevel string
algorithm string
protectionLevel string
algorithm str
protection_level str

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.