Skip to content

GCP.DataCatalog reference

Source: packages/gcp/src/DataCatalog/TaxonomiesPolicyTag.ts

A Data Catalog policy tag inside a taxonomy.

Policy tag ids are assigned by Policy Tag Manager. Taxonomy and parent tag are immutable. Display name and description update in place. Policy tags have no labels; Alchemy stamps ownership into the description so list / nuke can find them.

TaxonomiesPolicyTag: Creating a Policy Tag

Section titled “TaxonomiesPolicyTag: Creating a Policy Tag”
const tag = yield* GCP.DataCatalog.TaxonomiesPolicyTag("Email", {
taxonomy: taxonomy.name,
displayName: "email",
description: "email addresses",
});

TaxonomiesPolicyTag: Looking up an existing taxonomies policy tag

Section titled “TaxonomiesPolicyTag: Looking up an existing taxonomies policy tag”

TaxonomiesPolicyTag.lookup references a taxonomies policy tag Alchemy doesn’t manage (created in the console or by another stack). It is read during plan/deploy, never created, updated or deleted, and binds like a declared taxonomies policy tag.

const taxonomiesPolicyTag = GCP.DataCatalog.TaxonomiesPolicyTag.lookup({
name: "projects/my-project/locations/us/taxonomies/123/policyTags/456",
});

Source: packages/gcp/src/DataCatalog/Taxonomy.ts

A Data Catalog taxonomy — a hierarchy of policy tags used to classify data (for example PII vs financials).

Taxonomy ids are assigned by Policy Tag Manager. Location is immutable. Display name, description, and activated policy types update in place. Taxonomies have no labels; Alchemy stamps alchemy-stack / alchemy-stage / alchemy-id into the description so list and pnpm nuke:gcp can identify owned taxonomies.

Generated display name

const taxonomy = yield* GCP.DataCatalog.Taxonomy("Pii", {
description: "sensitivity classes",
});

Fine-grained access control

const taxonomy = yield* GCP.DataCatalog.Taxonomy("Pii", {
displayName: "PII",
activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
});
// Same logical id, changed props: the engine updates it in place.
const taxonomy = yield* GCP.DataCatalog.Taxonomy("Pii", {
displayName: "PII",
description: "sensitivity classes v2",
activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
});

Taxonomy.lookup references a taxonomy Alchemy doesn’t manage (created in the console or by another stack). It is read during plan/deploy, never created, updated or deleted, and binds like a declared taxonomy.

const taxonomy = GCP.DataCatalog.Taxonomy.lookup({
name: "projects/my-project/locations/us/taxonomies/1234567890",
});