published on Thursday, Mar 19, 2026 by Pulumi
published on Thursday, Mar 19, 2026 by Pulumi
This resource allows you to manage the Data Classification configuration for Unity Catalog catalogs.
Data Classification automatically identifies and tags sensitive data (personally identifiable information, or PII) in Unity Catalog tables. Creating this resource enables Data Classification for the specified catalog, while deleting it disables Data Classification.
To manage Data Classification configuration, you must either:
- be an owner of the catalog, OR
- have USE_CATALOG and MANAGE permissions on the catalog
Note This resource can only be used with a workspace-level provider.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
// Enable Data Classification for a set of schemas in a catalog
const example = new databricks.DataClassificationCatalogConfig("example", {
name: "catalogs/prod_catalog/config",
includedSchemas: {
names: [
"sales",
"marketing",
"customer_data",
],
},
autoTagConfigs: [
{
classificationTag: "class.credit_card",
autoTaggingMode: "AUTO_TAGGING_ENABLED",
},
{
classificationTag: "class.email",
autoTaggingMode: "AUTO_TAGGING_ENABLED",
},
],
});
// Enable Data Classification for the entire catalog (all current and future schemas)
const allSchemas = new databricks.DataClassificationCatalogConfig("all_schemas", {name: "catalogs/staging_catalog/config"});
import pulumi
import pulumi_databricks as databricks
# Enable Data Classification for a set of schemas in a catalog
example = databricks.DataClassificationCatalogConfig("example",
name="catalogs/prod_catalog/config",
included_schemas={
"names": [
"sales",
"marketing",
"customer_data",
],
},
auto_tag_configs=[
{
"classification_tag": "class.credit_card",
"auto_tagging_mode": "AUTO_TAGGING_ENABLED",
},
{
"classification_tag": "class.email",
"auto_tagging_mode": "AUTO_TAGGING_ENABLED",
},
])
# Enable Data Classification for the entire catalog (all current and future schemas)
all_schemas = databricks.DataClassificationCatalogConfig("all_schemas", name="catalogs/staging_catalog/config")
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Enable Data Classification for a set of schemas in a catalog
_, err := databricks.NewDataClassificationCatalogConfig(ctx, "example", &databricks.DataClassificationCatalogConfigArgs{
Name: "catalogs/prod_catalog/config",
IncludedSchemas: &databricks.DataClassificationCatalogConfigIncludedSchemasArgs{
Names: pulumi.StringArray{
pulumi.String("sales"),
pulumi.String("marketing"),
pulumi.String("customer_data"),
},
},
AutoTagConfigs: databricks.DataClassificationCatalogConfigAutoTagConfigArray{
&databricks.DataClassificationCatalogConfigAutoTagConfigArgs{
ClassificationTag: pulumi.String("class.credit_card"),
AutoTaggingMode: pulumi.String("AUTO_TAGGING_ENABLED"),
},
&databricks.DataClassificationCatalogConfigAutoTagConfigArgs{
ClassificationTag: pulumi.String("class.email"),
AutoTaggingMode: pulumi.String("AUTO_TAGGING_ENABLED"),
},
},
})
if err != nil {
return err
}
// Enable Data Classification for the entire catalog (all current and future schemas)
_, err = databricks.NewDataClassificationCatalogConfig(ctx, "all_schemas", &databricks.DataClassificationCatalogConfigArgs{
Name: "catalogs/staging_catalog/config",
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
// Enable Data Classification for a set of schemas in a catalog
var example = new Databricks.DataClassificationCatalogConfig("example", new()
{
Name = "catalogs/prod_catalog/config",
IncludedSchemas = new Databricks.Inputs.DataClassificationCatalogConfigIncludedSchemasArgs
{
Names = new[]
{
"sales",
"marketing",
"customer_data",
},
},
AutoTagConfigs = new[]
{
new Databricks.Inputs.DataClassificationCatalogConfigAutoTagConfigArgs
{
ClassificationTag = "class.credit_card",
AutoTaggingMode = "AUTO_TAGGING_ENABLED",
},
new Databricks.Inputs.DataClassificationCatalogConfigAutoTagConfigArgs
{
ClassificationTag = "class.email",
AutoTaggingMode = "AUTO_TAGGING_ENABLED",
},
},
});
// Enable Data Classification for the entire catalog (all current and future schemas)
var allSchemas = new Databricks.DataClassificationCatalogConfig("all_schemas", new()
{
Name = "catalogs/staging_catalog/config",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DataClassificationCatalogConfig;
import com.pulumi.databricks.DataClassificationCatalogConfigArgs;
import com.pulumi.databricks.inputs.DataClassificationCatalogConfigIncludedSchemasArgs;
import com.pulumi.databricks.inputs.DataClassificationCatalogConfigAutoTagConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Enable Data Classification for a set of schemas in a catalog
var example = new DataClassificationCatalogConfig("example", DataClassificationCatalogConfigArgs.builder()
.name("catalogs/prod_catalog/config")
.includedSchemas(DataClassificationCatalogConfigIncludedSchemasArgs.builder()
.names(
"sales",
"marketing",
"customer_data")
.build())
.autoTagConfigs(
DataClassificationCatalogConfigAutoTagConfigArgs.builder()
.classificationTag("class.credit_card")
.autoTaggingMode("AUTO_TAGGING_ENABLED")
.build(),
DataClassificationCatalogConfigAutoTagConfigArgs.builder()
.classificationTag("class.email")
.autoTaggingMode("AUTO_TAGGING_ENABLED")
.build())
.build());
// Enable Data Classification for the entire catalog (all current and future schemas)
var allSchemas = new DataClassificationCatalogConfig("allSchemas", DataClassificationCatalogConfigArgs.builder()
.name("catalogs/staging_catalog/config")
.build());
}
}
resources:
# Enable Data Classification for a set of schemas in a catalog
example:
type: databricks:DataClassificationCatalogConfig
properties:
name: catalogs/prod_catalog/config
includedSchemas:
names:
- sales
- marketing
- customer_data
autoTagConfigs:
- classificationTag: class.credit_card
autoTaggingMode: AUTO_TAGGING_ENABLED
- classificationTag: class.email
autoTaggingMode: AUTO_TAGGING_ENABLED
# Enable Data Classification for the entire catalog (all current and future schemas)
allSchemas:
type: databricks:DataClassificationCatalogConfig
name: all_schemas
properties:
name: catalogs/staging_catalog/config
Create DataClassificationCatalogConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataClassificationCatalogConfig(name: string, args: DataClassificationCatalogConfigArgs, opts?: CustomResourceOptions);@overload
def DataClassificationCatalogConfig(resource_name: str,
args: DataClassificationCatalogConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataClassificationCatalogConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
parent: Optional[str] = None,
auto_tag_configs: Optional[Sequence[DataClassificationCatalogConfigAutoTagConfigArgs]] = None,
included_schemas: Optional[DataClassificationCatalogConfigIncludedSchemasArgs] = None,
provider_config: Optional[DataClassificationCatalogConfigProviderConfigArgs] = None)func NewDataClassificationCatalogConfig(ctx *Context, name string, args DataClassificationCatalogConfigArgs, opts ...ResourceOption) (*DataClassificationCatalogConfig, error)public DataClassificationCatalogConfig(string name, DataClassificationCatalogConfigArgs args, CustomResourceOptions? opts = null)
public DataClassificationCatalogConfig(String name, DataClassificationCatalogConfigArgs args)
public DataClassificationCatalogConfig(String name, DataClassificationCatalogConfigArgs args, CustomResourceOptions options)
type: databricks:DataClassificationCatalogConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DataClassificationCatalogConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DataClassificationCatalogConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DataClassificationCatalogConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataClassificationCatalogConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataClassificationCatalogConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dataClassificationCatalogConfigResource = new Databricks.Index.DataClassificationCatalogConfig("dataClassificationCatalogConfigResource", new()
{
Parent = "string",
AutoTagConfigs = new[]
{
new Databricks.Inputs.DataClassificationCatalogConfigAutoTagConfigArgs
{
AutoTaggingMode = "string",
ClassificationTag = "string",
},
},
IncludedSchemas = new Databricks.Inputs.DataClassificationCatalogConfigIncludedSchemasArgs
{
Names = new[]
{
"string",
},
},
ProviderConfig = new Databricks.Inputs.DataClassificationCatalogConfigProviderConfigArgs
{
WorkspaceId = "string",
},
});
example, err := databricks.NewDataClassificationCatalogConfig(ctx, "dataClassificationCatalogConfigResource", &databricks.DataClassificationCatalogConfigArgs{
Parent: pulumi.String("string"),
AutoTagConfigs: databricks.DataClassificationCatalogConfigAutoTagConfigArray{
&databricks.DataClassificationCatalogConfigAutoTagConfigArgs{
AutoTaggingMode: pulumi.String("string"),
ClassificationTag: pulumi.String("string"),
},
},
IncludedSchemas: &databricks.DataClassificationCatalogConfigIncludedSchemasArgs{
Names: pulumi.StringArray{
pulumi.String("string"),
},
},
ProviderConfig: &databricks.DataClassificationCatalogConfigProviderConfigArgs{
WorkspaceId: pulumi.String("string"),
},
})
var dataClassificationCatalogConfigResource = new DataClassificationCatalogConfig("dataClassificationCatalogConfigResource", DataClassificationCatalogConfigArgs.builder()
.parent("string")
.autoTagConfigs(DataClassificationCatalogConfigAutoTagConfigArgs.builder()
.autoTaggingMode("string")
.classificationTag("string")
.build())
.includedSchemas(DataClassificationCatalogConfigIncludedSchemasArgs.builder()
.names("string")
.build())
.providerConfig(DataClassificationCatalogConfigProviderConfigArgs.builder()
.workspaceId("string")
.build())
.build());
data_classification_catalog_config_resource = databricks.DataClassificationCatalogConfig("dataClassificationCatalogConfigResource",
parent="string",
auto_tag_configs=[{
"auto_tagging_mode": "string",
"classification_tag": "string",
}],
included_schemas={
"names": ["string"],
},
provider_config={
"workspace_id": "string",
})
const dataClassificationCatalogConfigResource = new databricks.DataClassificationCatalogConfig("dataClassificationCatalogConfigResource", {
parent: "string",
autoTagConfigs: [{
autoTaggingMode: "string",
classificationTag: "string",
}],
includedSchemas: {
names: ["string"],
},
providerConfig: {
workspaceId: "string",
},
});
type: databricks:DataClassificationCatalogConfig
properties:
autoTagConfigs:
- autoTaggingMode: string
classificationTag: string
includedSchemas:
names:
- string
parent: string
providerConfig:
workspaceId: string
DataClassificationCatalogConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataClassificationCatalogConfig resource accepts the following input properties:
- Parent string
- Parent resource in the format: catalogs/{catalog_name}
- Auto
Tag List<DataConfigs Classification Catalog Config Auto Tag Config> - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- Included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - Provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- Parent string
- Parent resource in the format: catalogs/{catalog_name}
- Auto
Tag []DataConfigs Classification Catalog Config Auto Tag Config Args - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- Included
Schemas DataClassification Catalog Config Included Schemas Args - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - Provider
Config DataClassification Catalog Config Provider Config Args - Configure the provider for management through account provider.
- parent String
- Parent resource in the format: catalogs/{catalog_name}
- auto
Tag List<DataConfigs Classification Catalog Config Auto Tag Config> - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- parent string
- Parent resource in the format: catalogs/{catalog_name}
- auto
Tag DataConfigs Classification Catalog Config Auto Tag Config[] - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- parent str
- Parent resource in the format: catalogs/{catalog_name}
- auto_
tag_ Sequence[Dataconfigs Classification Catalog Config Auto Tag Config Args] - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included_
schemas DataClassification Catalog Config Included Schemas Args - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - provider_
config DataClassification Catalog Config Provider Config Args - Configure the provider for management through account provider.
- parent String
- Parent resource in the format: catalogs/{catalog_name}
- auto
Tag List<Property Map>Configs - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas Property Map - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - provider
Config Property Map - Configure the provider for management through account provider.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataClassificationCatalogConfig resource produces the following output properties:
Look up Existing DataClassificationCatalogConfig Resource
Get an existing DataClassificationCatalogConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DataClassificationCatalogConfigState, opts?: CustomResourceOptions): DataClassificationCatalogConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_tag_configs: Optional[Sequence[DataClassificationCatalogConfigAutoTagConfigArgs]] = None,
included_schemas: Optional[DataClassificationCatalogConfigIncludedSchemasArgs] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
provider_config: Optional[DataClassificationCatalogConfigProviderConfigArgs] = None) -> DataClassificationCatalogConfigfunc GetDataClassificationCatalogConfig(ctx *Context, name string, id IDInput, state *DataClassificationCatalogConfigState, opts ...ResourceOption) (*DataClassificationCatalogConfig, error)public static DataClassificationCatalogConfig Get(string name, Input<string> id, DataClassificationCatalogConfigState? state, CustomResourceOptions? opts = null)public static DataClassificationCatalogConfig get(String name, Output<String> id, DataClassificationCatalogConfigState state, CustomResourceOptions options)resources: _: type: databricks:DataClassificationCatalogConfig get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auto
Tag List<DataConfigs Classification Catalog Config Auto Tag Config> - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- Included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - Name string
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- Parent string
- Parent resource in the format: catalogs/{catalog_name}
- Provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- Auto
Tag []DataConfigs Classification Catalog Config Auto Tag Config Args - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- Included
Schemas DataClassification Catalog Config Included Schemas Args - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - Name string
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- Parent string
- Parent resource in the format: catalogs/{catalog_name}
- Provider
Config DataClassification Catalog Config Provider Config Args - Configure the provider for management through account provider.
- auto
Tag List<DataConfigs Classification Catalog Config Auto Tag Config> - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - name String
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- parent String
- Parent resource in the format: catalogs/{catalog_name}
- provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- auto
Tag DataConfigs Classification Catalog Config Auto Tag Config[] - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas DataClassification Catalog Config Included Schemas - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - name string
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- parent string
- Parent resource in the format: catalogs/{catalog_name}
- provider
Config DataClassification Catalog Config Provider Config - Configure the provider for management through account provider.
- auto_
tag_ Sequence[Dataconfigs Classification Catalog Config Auto Tag Config Args] - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included_
schemas DataClassification Catalog Config Included Schemas Args - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - name str
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- parent str
- Parent resource in the format: catalogs/{catalog_name}
- provider_
config DataClassification Catalog Config Provider Config Args - Configure the provider for management through account provider.
- auto
Tag List<Property Map>Configs - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
- included
Schemas Property Map - Schemas to include in the scan. Empty list is not supported as it results in a no-op
scan. If
included_schemasis not set, all schemas are scanned - name String
- (string) - Resource name in the format: catalogs/{catalog_name}/config
- parent String
- Parent resource in the format: catalogs/{catalog_name}
- provider
Config Property Map - Configure the provider for management through account provider.
Supporting Types
DataClassificationCatalogConfigAutoTagConfig, DataClassificationCatalogConfigAutoTagConfigArgs
- Auto
Tagging stringMode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - Classification
Tag string - The Classification Tag (e.g., "class.name", "class.location")
- Auto
Tagging stringMode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - Classification
Tag string - The Classification Tag (e.g., "class.name", "class.location")
- auto
Tagging StringMode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - classification
Tag String - The Classification Tag (e.g., "class.name", "class.location")
- auto
Tagging stringMode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - classification
Tag string - The Classification Tag (e.g., "class.name", "class.location")
- auto_
tagging_ strmode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - classification_
tag str - The Classification Tag (e.g., "class.name", "class.location")
- auto
Tagging StringMode - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are:
AUTO_TAGGING_DISABLED,AUTO_TAGGING_ENABLED - classification
Tag String - The Classification Tag (e.g., "class.name", "class.location")
DataClassificationCatalogConfigIncludedSchemas, DataClassificationCatalogConfigIncludedSchemasArgs
- Names List<string>
- Names []string
- names List<String>
- names string[]
- names Sequence[str]
- names List<String>
DataClassificationCatalogConfigProviderConfig, DataClassificationCatalogConfigProviderConfigArgs
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace_
id str - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
published on Thursday, Mar 19, 2026 by Pulumi
