Skip to content

googleKmsKeyRing

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

A KeyRing is a grouping of CryptoKeys for organizational purposes. A KeyRing belongs to a Google Cloud Platform Project and resides in a specific location.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.dataGoogleKmsKeyRing.DataGoogleKmsKeyRing(this, "my_key_ring", {
  location: "us-central1",
  name: "my-key-ring",
});

Argument Reference

The following arguments are supported:

  • name - (Required) The KeyRing's name. A KeyRing name must exist within the provided location and match the regular expression [aZAZ09_-]{1,63}

  • location - (Required) The Google Cloud Platform location for the KeyRing. A full list of valid locations can be found by running gcloudKmsLocationsList.

  • project - (Optional) The project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - The identifier of the created KeyRing. Its format is projects/{projectId}/locations/{location}/keyRings/{keyRingName}.