Skip to content

DataClassificationCatalogConfig

laktory.models.resources.databricks.DataClassificationCatalogConfig ¤

Bases: DataClassificationCatalogConfigBase

Databricks Data Classification catalog configuration

Enables Data Classification on a Unity Catalog catalog: sensitive data (PII) is automatically identified and, optionally, tagged. Combined with attribute-based access control (PolicyInfo), classified columns can be masked or filtered without listing them. Can also be declared directly on a Catalog with its data_classification field.

Examples:

import io

from laktory import models

config_yaml = '''
parent: catalogs/dev
auto_tag_configs:
- classification_tag: class.email_address
  auto_tagging_mode: AUTO_TAGGING_ENABLED
excluded_schemas:
  names:
  - sandbox
'''
config = (
    models.resources.databricks.DataClassificationCatalogConfig.model_validate_yaml(
        io.StringIO(config_yaml)
    )
)
References
BASE DESCRIPTION
auto_tag_configs

List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled

TYPE: list[DataClassificationCatalogConfigAutoTagConfigs] | None | VariableType DEFAULT: None

excluded_schemas

Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with included_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned

TYPE: DataClassificationCatalogConfigExcludedSchemas | None | VariableType DEFAULT: None

included_schemas

Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excluded_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned

TYPE: DataClassificationCatalogConfigIncludedSchemas | None | VariableType DEFAULT: None

parent

Parent catalog in the format catalogs/{catalog_name}. Set automatically when declared as the data_classification of a catalog.

TYPE: str | VariableType DEFAULT: None

provider_config

Configure the provider for management through account provider

TYPE: DataClassificationCatalogConfigProviderConfig | None | VariableType DEFAULT: None

laktory.models.resources.databricks.dataclassificationcatalogconfig.DataClassificationCatalogConfigAutoTagConfigs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
auto_tagging_mode

Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED

TYPE: str | VariableType

classification_tag

The Classification Tag. For built-in classes this is a system tag (e.g., 'class.name', 'class.location'); for custom classes it is a user-defined governance tag key

TYPE: str | VariableType

laktory.models.resources.databricks.dataclassificationcatalogconfig.DataClassificationCatalogConfigExcludedSchemas ¤

Bases: BaseModel

PARAMETER DESCRIPTION
names

Schema names, each relative to the parent catalog. Must not be empty

TYPE: list[str] | VariableType

laktory.models.resources.databricks.dataclassificationcatalogconfig.DataClassificationCatalogConfigIncludedSchemas ¤

Bases: BaseModel

PARAMETER DESCRIPTION
names

Schema names, each relative to the parent catalog. Must not be empty

TYPE: list[str] | VariableType

laktory.models.resources.databricks.dataclassificationcatalogconfig.DataClassificationCatalogConfigProviderConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
workspace_id

Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with

TYPE: str | None | VariableType DEFAULT: None