1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. WorkspaceConf
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Import

    -> Note Importing this resource is not currently supported.

    Example Usage

    Allows specification of custom configuration properties for expert usage

    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var @this = new Databricks.WorkspaceConf("this", new Databricks.WorkspaceConfArgs
            {
                CustomConfig = 
                {
                    { "enableIpAccessLists", true },
                },
            });
        }
    
    }
    
    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 {
    		_, err := databricks.NewWorkspaceConf(ctx, "this", &databricks.WorkspaceConfArgs{
    			CustomConfig: pulumi.AnyMap{
    				"enableIpAccessLists": pulumi.Any(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = new databricks.WorkspaceConf("this", {customConfig: {
        enableIpAccessLists: true,
    }});
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.WorkspaceConf("this", custom_config={
        "enableIpAccessLists": True,
    })
    

    Example coming soon!

    Create WorkspaceConf Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkspaceConf(name: string, args?: WorkspaceConfArgs, opts?: CustomResourceOptions);
    @overload
    def WorkspaceConf(resource_name: str,
                      args: Optional[WorkspaceConfArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkspaceConf(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      custom_config: Optional[Mapping[str, Any]] = None)
    func NewWorkspaceConf(ctx *Context, name string, args *WorkspaceConfArgs, opts ...ResourceOption) (*WorkspaceConf, error)
    public WorkspaceConf(string name, WorkspaceConfArgs? args = null, CustomResourceOptions? opts = null)
    public WorkspaceConf(String name, WorkspaceConfArgs args)
    public WorkspaceConf(String name, WorkspaceConfArgs args, CustomResourceOptions options)
    
    type: databricks:WorkspaceConf
    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 WorkspaceConfArgs
    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 WorkspaceConfArgs
    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 WorkspaceConfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceConfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceConfArgs
    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 workspaceConfResource = new Databricks.WorkspaceConf("workspaceConfResource", new()
    {
        CustomConfig = 
        {
            { "string", "any" },
        },
    });
    
    example, err := databricks.NewWorkspaceConf(ctx, "workspaceConfResource", &databricks.WorkspaceConfArgs{
    	CustomConfig: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var workspaceConfResource = new WorkspaceConf("workspaceConfResource", WorkspaceConfArgs.builder()
        .customConfig(Map.of("string", "any"))
        .build());
    
    workspace_conf_resource = databricks.WorkspaceConf("workspaceConfResource", custom_config={
        "string": "any",
    })
    
    const workspaceConfResource = new databricks.WorkspaceConf("workspaceConfResource", {customConfig: {
        string: "any",
    }});
    
    type: databricks:WorkspaceConf
    properties:
        customConfig:
            string: any
    

    WorkspaceConf 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 WorkspaceConf resource accepts the following input properties:

    CustomConfig Dictionary<string, object>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    CustomConfig map[string]interface{}
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig Map<String,Object>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig {[key: string]: any}
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    custom_config Mapping[str, Any]
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig Map<Any>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspaceConf resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkspaceConf Resource

    Get an existing WorkspaceConf 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?: WorkspaceConfState, opts?: CustomResourceOptions): WorkspaceConf
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            custom_config: Optional[Mapping[str, Any]] = None) -> WorkspaceConf
    func GetWorkspaceConf(ctx *Context, name string, id IDInput, state *WorkspaceConfState, opts ...ResourceOption) (*WorkspaceConf, error)
    public static WorkspaceConf Get(string name, Input<string> id, WorkspaceConfState? state, CustomResourceOptions? opts = null)
    public static WorkspaceConf get(String name, Output<String> id, WorkspaceConfState state, CustomResourceOptions options)
    resources:  _:    type: databricks:WorkspaceConf    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.
    The following state arguments are supported:
    CustomConfig Dictionary<string, object>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    CustomConfig map[string]interface{}
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig Map<String,Object>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig {[key: string]: any}
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    custom_config Mapping[str, Any]
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.
    customConfig Map<Any>
    Key-value map of strings, that represent workspace configuration. Upon resource deletion, properties that start with enable or enforce will be reset to false value, regardless of initial default one.

    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 v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.