Skip to content

googleKmsKeyRing

A keyRing is a toplevel logical grouping of cryptoKeys.

\~> Note: KeyRings cannot be deleted from Google Cloud Platform. Destroying a Terraform-managed KeyRing will remove it from state but will not delete the resource from the project.

To get more information about KeyRing, see:

Example Usage - Kms Key Ring Basic

/*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.kmsKeyRing.KmsKeyRing(this, "example-keyring", {
  location: "global",
  name: "keyring-example",
});

Argument Reference

The following arguments are supported:

  • name - (Required) The resource name for the KeyRing.

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

  • project - (Optional) The ID of 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 - an identifier for the resource with format projects/{{project}}/locations/{{location}}/keyRings/{{name}}

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

KeyRing can be imported using any of these accepted formats:

$ terraform import google_kms_key_ring.default projects/{{project}}/locations/{{location}}/keyRings/{{name}}
$ terraform import google_kms_key_ring.default {{project}}/{{location}}/{{name}}
$ terraform import google_kms_key_ring.default {{location}}/{{name}}

User Project Overrides

This resource supports User Project Overrides.