DataCatalogTaxonomy

Property Value
Google Cloud Service Name Data Catalog
Google Cloud Service Documentation /data-catalog/docs/
Google Cloud REST Resource Name v1.projects.locations.taxonomies
Google Cloud REST Resource Documentation /data-catalog/docs/reference/rest/v1/projects.locations.taxonomies
Config Connector Resource Short Names gcpdatacatalogtaxonomy
gcpdatacatalogtaxonomies
datacatalogtaxonomy
Config Connector Service Name datacatalog.googleapis.com
Config Connector Resource Fully Qualified Name datacatalogtaxonomies.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

activatedPolicyTypes:
- string
description: string
displayName: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
region: string
resourceID: string
Fields

activatedPolicyTypes

Optional

list (string)

A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. Possible values: ["POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL"].

activatedPolicyTypes[]

Optional

string

description

Optional

string

Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.

displayName

Required

string

User defined name of this taxonomy. It must: 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.

projectRef

Required

object

The project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

region

Optional

string

Immutable. Taxonomy location region.

resourceID

Optional

string

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

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
name: string
observedGeneration: integer
observedState:
  policyTagCount: integer
  service:
    identity: string
    name: string
  taxonomyTimestamps:
    createTime: string
    expiredTime: string
    updateTime: string
Fields
conditions

list (object)

Conditions represent the latest available observations of the DataCatalogTaxonomy'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 DataCatalogTaxonomy resource in Google Cloud.
name

string

Resource name of this taxonomy, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}".
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.
observedState.policyTagCount

integer

Output only. Number of policy tags in this taxonomy.
observedState.service

object

Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Only 'DATAPLEX' is supported.
observedState.service.identity

string

The service agent for the service.
observedState.service.name

string

The Google Cloud service name.
observedState.taxonomyTimestamps

object

Output only. Creation and modification timestamps of this taxonomy.
observedState.taxonomyTimestamps.createTime

string

Creation timestamp of the resource within the given system.
observedState.taxonomyTimestamps.expiredTime

string

Output only. Expiration timestamp of the resource within the given system. Only applicable to BigQuery resources.
observedState.taxonomyTimestamps.updateTime

string

Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.

Sample YAML(s)

Typical Use Case

apiVersion: datacatalog.cnrm.cloud.google.com/v1beta1
kind: DataCatalogTaxonomy
metadata:
  name: datacatalogtaxonomy-${uniqueId}
spec:
  activatedPolicyTypes:
  - FINE_GRAINED_ACCESS_CONTROL
  description: A collection of policy tags
  displayName: my_taxonomy
  projectRef:
    external: ${projectId}
  region: us