@pulumi/databricks/directory.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * This resource allows you to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).
 *
 * ## Example Usage
 *
 * You can declare a Pulumi-managed directory by specifying the `path` attribute of the corresponding directory.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const myCustomDirectory = new databricks.Directory("my_custom_directory", {path: "/my_custom_directory"});
 * ```
 *
 * ## Access Control
 *
 * - databricks.Permissions can control which groups or individual users can access folders.
 *
 * ## Related Resources
 *
 * The following resources are often used in the same context:
 *
 * - End to end workspace management guide.
 * - databricks.Notebook to manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).
 * - databricks.Notebook data to export a notebook from Databricks Workspace.
 * - databricks.getNotebookPaths data to list notebooks in Databricks Workspace.
 * - databricks.Repo to manage [Databricks Repos](https://docs.databricks.com/repos.html).
 * - databricks.getSparkVersion data to get [Databricks Runtime (DBR)](https://docs.databricks.com/runtime/dbr.html) version that could be used for `sparkVersion` parameter in databricks.Cluster and other resources.
 * - databricks.WorkspaceConf to manage workspace configuration for expert usage.
 *
 * ## Import
 *
 * The resource directory can be imported using directory path:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/directory:Directory this /path/to/directory
 * ```
 */
export declare class Directory extends pulumi.CustomResource {
    /**
     * Get an existing Directory resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DirectoryState, opts?: pulumi.CustomResourceOptions): Directory;
    /**
     * Returns true if the given object is an instance of Directory.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Directory;
    /**
     * Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to `false`
     */
    readonly deleteRecursive: pulumi.Output<boolean | undefined>;
    /**
     * Unique identifier for a DIRECTORY
     */
    readonly objectId: pulumi.Output<number>;
    /**
     * The absolute path of the directory, beginning with "/", e.g. "/Demo".
     */
    readonly path: pulumi.Output<string>;
    /**
     * path on Workspace File System (WSFS) in form of `/Workspace` + `path`
     */
    readonly workspacePath: pulumi.Output<string>;
    /**
     * Create a Directory resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: DirectoryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Directory resources.
 */
export interface DirectoryState {
    /**
     * Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to `false`
     */
    deleteRecursive?: pulumi.Input<boolean>;
    /**
     * Unique identifier for a DIRECTORY
     */
    objectId?: pulumi.Input<number>;
    /**
     * The absolute path of the directory, beginning with "/", e.g. "/Demo".
     */
    path?: pulumi.Input<string>;
    /**
     * path on Workspace File System (WSFS) in form of `/Workspace` + `path`
     */
    workspacePath?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Directory resource.
 */
export interface DirectoryArgs {
    /**
     * Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to `false`
     */
    deleteRecursive?: pulumi.Input<boolean>;
    /**
     * Unique identifier for a DIRECTORY
     */
    objectId?: pulumi.Input<number>;
    /**
     * The absolute path of the directory, beginning with "/", e.g. "/Demo".
     */
    path: pulumi.Input<string>;
}