1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDataClassificationCatalogConfig
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

    Public Beta

    This data source can be used to fetch the Data Classification configuration for a Unity Catalog catalog.

    To read the Data Classification configuration, you must have browse permissions on the catalog.

    Note This data source can only be used with a workspace-level provider.

    Example Usage

    To get the Data Classification configuration for a catalog:

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const prod = databricks.getCatalog({
        name: "prod_catalog",
    });
    const prodConfig = prod.then(prod => databricks.getDataClassificationCatalogConfig({
        name: `catalogs/${prod.name}/config`,
    }));
    export const autoTagConfigs = prodConfig.then(prodConfig => prodConfig.autoTagConfigs);
    
    import pulumi
    import pulumi_databricks as databricks
    
    prod = databricks.get_catalog(name="prod_catalog")
    prod_config = databricks.get_data_classification_catalog_config(name=f"catalogs/{prod.name}/config")
    pulumi.export("autoTagConfigs", prod_config.auto_tag_configs)
    
    package main
    
    import (
    	"fmt"
    
    	"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 {
    		prod, err := databricks.LookupCatalog(ctx, &databricks.LookupCatalogArgs{
    			Name: "prod_catalog",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		prodConfig, err := databricks.LookupDataClassificationCatalogConfig(ctx, &databricks.LookupDataClassificationCatalogConfigArgs{
    			Name: fmt.Sprintf("catalogs/%v/config", prod.Name),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("autoTagConfigs", prodConfig.AutoTagConfigs)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var prod = Databricks.GetCatalog.Invoke(new()
        {
            Name = "prod_catalog",
        });
    
        var prodConfig = Databricks.GetDataClassificationCatalogConfig.Invoke(new()
        {
            Name = $"catalogs/{prod.Apply(getCatalogResult => getCatalogResult.Name)}/config",
        });
    
        return new Dictionary<string, object?>
        {
            ["autoTagConfigs"] = prodConfig.Apply(getDataClassificationCatalogConfigResult => getDataClassificationCatalogConfigResult.AutoTagConfigs),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.DatabricksFunctions;
    import com.pulumi.databricks.inputs.GetCatalogArgs;
    import com.pulumi.databricks.inputs.GetDataClassificationCatalogConfigArgs;
    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) {
            final var prod = DatabricksFunctions.getCatalog(GetCatalogArgs.builder()
                .name("prod_catalog")
                .build());
    
            final var prodConfig = DatabricksFunctions.getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs.builder()
                .name(String.format("catalogs/%s/config", prod.name()))
                .build());
    
            ctx.export("autoTagConfigs", prodConfig.autoTagConfigs());
        }
    }
    
    variables:
      prod:
        fn::invoke:
          function: databricks:getCatalog
          arguments:
            name: prod_catalog
      prodConfig:
        fn::invoke:
          function: databricks:getDataClassificationCatalogConfig
          arguments:
            name: catalogs/${prod.name}/config
    outputs:
      # Use the fetched configuration
      autoTagConfigs: ${prodConfig.autoTagConfigs}
    

    Using getDataClassificationCatalogConfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataClassificationCatalogConfig(args: GetDataClassificationCatalogConfigArgs, opts?: InvokeOptions): Promise<GetDataClassificationCatalogConfigResult>
    function getDataClassificationCatalogConfigOutput(args: GetDataClassificationCatalogConfigOutputArgs, opts?: InvokeOptions): Output<GetDataClassificationCatalogConfigResult>
    def get_data_classification_catalog_config(name: Optional[str] = None,
                                               provider_config: Optional[GetDataClassificationCatalogConfigProviderConfig] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetDataClassificationCatalogConfigResult
    def get_data_classification_catalog_config_output(name: Optional[pulumi.Input[str]] = None,
                                               provider_config: Optional[pulumi.Input[GetDataClassificationCatalogConfigProviderConfigArgs]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetDataClassificationCatalogConfigResult]
    func LookupDataClassificationCatalogConfig(ctx *Context, args *LookupDataClassificationCatalogConfigArgs, opts ...InvokeOption) (*LookupDataClassificationCatalogConfigResult, error)
    func LookupDataClassificationCatalogConfigOutput(ctx *Context, args *LookupDataClassificationCatalogConfigOutputArgs, opts ...InvokeOption) LookupDataClassificationCatalogConfigResultOutput

    > Note: This function is named LookupDataClassificationCatalogConfig in the Go SDK.

    public static class GetDataClassificationCatalogConfig 
    {
        public static Task<GetDataClassificationCatalogConfigResult> InvokeAsync(GetDataClassificationCatalogConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetDataClassificationCatalogConfigResult> Invoke(GetDataClassificationCatalogConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDataClassificationCatalogConfigResult> getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs args, InvokeOptions options)
    public static Output<GetDataClassificationCatalogConfigResult> getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getDataClassificationCatalogConfig:getDataClassificationCatalogConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    Name string
    Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name String
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name string
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name str
    Resource name in the format: catalogs/{catalog_name}/config
    provider_config GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name String
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig Property Map
    Configure the provider for management through account provider.

    getDataClassificationCatalogConfig Result

    The following output properties are available:

    AutoTagConfigs List<GetDataClassificationCatalogConfigAutoTagConfig>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    Name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    AutoTagConfigs []GetDataClassificationCatalogConfigAutoTagConfig
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    Name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    autoTagConfigs List<GetDataClassificationCatalogConfigAutoTagConfig>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    id String
    The provider-assigned unique ID for this managed resource.
    includedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    name String
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    autoTagConfigs GetDataClassificationCatalogConfigAutoTagConfig[]
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    id string
    The provider-assigned unique ID for this managed resource.
    includedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    auto_tag_configs Sequence[GetDataClassificationCatalogConfigAutoTagConfig]
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    id str
    The provider-assigned unique ID for this managed resource.
    included_schemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    name str
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    provider_config GetDataClassificationCatalogConfigProviderConfig
    autoTagConfigs List<Property Map>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    id String
    The provider-assigned unique ID for this managed resource.
    includedSchemas Property Map
    (CatalogConfigSchemaNames) - Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned
    name String
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig Property Map

    Supporting Types

    GetDataClassificationCatalogConfigAutoTagConfig

    AutoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    ClassificationTag string
    (string) - The Classification Tag (e.g., "class.name", "class.location")
    AutoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    ClassificationTag string
    (string) - The Classification Tag (e.g., "class.name", "class.location")
    autoTaggingMode String
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag String
    (string) - The Classification Tag (e.g., "class.name", "class.location")
    autoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag string
    (string) - The Classification Tag (e.g., "class.name", "class.location")
    auto_tagging_mode str
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classification_tag str
    (string) - The Classification Tag (e.g., "class.name", "class.location")
    autoTaggingMode String
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag String
    (string) - The Classification Tag (e.g., "class.name", "class.location")

    GetDataClassificationCatalogConfigIncludedSchemas

    Names List<string>
    (list of string)
    Names []string
    (list of string)
    names List<String>
    (list of string)
    names string[]
    (list of string)
    names Sequence[str]
    (list of string)
    names List<String>
    (list of string)

    GetDataClassificationCatalogConfigProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId 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.
    workspaceId 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 databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.