TagsTagKey

Property	Value
Google Cloud Service Name	Cloud Resource Manager
Google Cloud Service Documentation	/resource-manager/docs/tags/tags-overview
Google Cloud REST Resource Name	v3.tagKeys
Google Cloud REST Resource Documentation	/resource-manager/reference/rest/v3/tagKeys
Config Connector Resource Short Names	gcptagstagkey gcptagstagkeys tagstagkey
Config Connector Service Name	cloudresourcemanager.googleapis.com
Config Connector Resource Fully Qualified Name	tagstagkeys.tags.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

description: string
parent: string
purpose: string
purposeData:
  string: string
resourceID: string
shortName: string

Fields

Fields
`description` Optional	`string` Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
`parent` Required	`string` Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`.
`purpose` Optional	`string` Optional. 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. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
`purposeData` Optional	`map (key: string, value: string)` Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field: https://docs.cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey Purpose data cannot be changed once set.
`resourceID` Optional	`string` Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.
`shortName` Required	`string` Required. Immutable. 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

string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

parent

Required

string

Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`.

purpose

Optional

string

Optional. 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. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.

purposeData

Optional

map (key: string, value: string)

Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field: https://docs.cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey Purpose data cannot be changed once set.

resourceID

Optional

string

Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.

shortName

Required

string

Required. Immutable. 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.

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createTime: string
externalRef: string
name: string
namespacedName: string
observedGeneration: integer
updateTime: string

Fields
`conditions`	`list (object)` Conditions represent the latest available observations of the object's current state.
`conditions[]`	`object`
`conditions[].lastTransitionTime`	`string` Last time the condition transitioned from one status to another.
`conditions[].message`	`string` Human-readable message indicating details about last transition.
`conditions[].reason`	`string` Unique, one-word, CamelCase reason for the condition's last transition.
`conditions[].status`	`string` Status is the status of the condition. Can be True, False, Unknown.
`conditions[].type`	`string` Type is the type of the condition.
`createTime`	`string` Output only. Creation time.
`externalRef`	`string` A unique specifier for the TagsTagKey resource in Google Cloud.
`name`	`string` The generated numeric id for the TagKey.
`namespacedName`	`string` Output only. Immutable. Namespaced name of the TagKey.
`observedGeneration`	`integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
`updateTime`	`string` Output only. Update time.

Sample YAML(s)

Typical Use Case

apiVersion: tags.cnrm.cloud.google.com/v1beta1
kind: TagsTagKey
metadata:
  name: tagstagkey-${uniqueId}
spec:
  description: For keyname resources.
  parent: projects/${projectId}
  shortName: keyname${uniqueId}