DataCatalogPolicyTag

Property Value
Google Cloud Service Name Data Catalog
Google Cloud Service Documentation /data-catalog/docs/
Google Cloud REST Resource Name v1.projects.locations.taxonomies.policyTags
Google Cloud REST Resource Documentation /data-catalog/docs/reference/rest/v1/projects.locations.taxonomies.policyTags
Config Connector Resource Short Names gcpdatacatalogpolicytag
gcpdatacatalogpolicytags
datacatalogpolicytag
Config Connector Service Name datacatalog.googleapis.com
Config Connector Resource Fully Qualified Name datacatalogpolicytags.datacatalog.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id

Spec

Schema

description: string
displayName: string
parentPolicyTagRef:
  external: string
  name: string
  namespace: string
resourceID: string
taxonomyRef:
  external: string
  name: string
  namespace: string
Fields

description

Optional

string

displayName

Required

string

User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.

parentPolicyTagRef

Optional

object

PolicyTagRef defines the resource reference to DataCatalogPolicyTag, which "External" field holds the Google Cloud identifier for the KRM object.

parentPolicyTagRef.external

Optional

string

A reference to an externally managed DataCatalogPolicyTag resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/taxonomies/{{taxonomyID}}/policyTags/{{policytagID}}".

parentPolicyTagRef.name

Optional

string

The name of a DataCatalogPolicyTag resource.

parentPolicyTagRef.namespace

Optional

string

The namespace of a DataCatalogPolicyTag resource.

resourceID

Optional

string

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

taxonomyRef

Required

object

TaxonomyRef defines the resource reference to DataCatalogTaxonomy, which "External" field holds the Google Cloud identifier for the KRM object.

taxonomyRef.external

Optional

string

A reference to an externally managed DataCatalogTaxonomy resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/taxonomies/{{taxonomyID}}".

taxonomyRef.name

Optional

string

The name of a DataCatalogTaxonomy resource.

taxonomyRef.namespace

Optional

string

The namespace of a DataCatalogTaxonomy resource.

Status

Schema

childPolicyTags:
- string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
name: string
observedGeneration: integer
observedState: {}
Fields
childPolicyTags

list (string)

Resource names of child policy tags of this policy tag.
childPolicyTags[]

string
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.
externalRef

string

A unique specifier for the DataCatalogPolicyTag resource in Google Cloud.
name

string

Resource name of this policy tag, format: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}".
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.
observedState

object

ObservedState is the state of the resource as most recently observed in Google Cloud.

Sample YAML(s)

Typical Use Case

apiVersion: datacatalog.cnrm.cloud.google.com/v1beta1
kind: DataCatalogPolicyTag
metadata:
  name: datacatalogpolicytag-${uniqueId}
spec:
  description: A policy tag normally associated with low security items
  displayName: Low security
  taxonomyRef:
    name: datacatalogtaxonomy-${uniqueId}