Skip to content

googleTagsTagKey

A TagKey, used to group a set of TagValues.

To get more information about TagKey, see:

Example Usage - Tag Key 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.tagsTagKey.TagsTagKey(this, "key", {
  description: "For keyname resources.",
  parent: "organizations/123456789",
  short_name: "keyname",
});

Argument Reference

The following arguments are supported:

  • parent - (Required) Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

  • shortName - (Required) Input only. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

  • description - (Optional) User-assigned description of the TagKey. Must not exceed 256 characters.

  • purpose - (Optional) Optional. A purpose cannot be changed once set. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values are gceFirewall.

  • purposeData - (Optional) Optional. Purpose data cannot be changed once set. Purpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: network = "<projectName>/<vpcName>".

Attributes Reference

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

  • id - an identifier for the resource with format tagKeys/{{name}}

  • name - The generated numeric id for the TagKey.

  • namespacedName - Output only. Namespaced name of the TagKey.

  • createTime - Output only. Creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

  • updateTime - Output only. Update time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Timeouts

This resource provides the following Timeouts configuration options:

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

Import

TagKey can be imported using any of these accepted formats:

$ terraform import google_tags_tag_key.default tagKeys/{{name}}
$ terraform import google_tags_tag_key.default {{name}}