UNPKG

@pulumi/databricks

Version:

A Pulumi package for creating and managing databricks cloud resources.

117 lines (116 loc) 4.7 kB
import * as pulumi from "@pulumi/pulumi"; /** * This resource allows you to manage [Databricks Workspace Files](https://docs.databricks.com/files/workspace.html). * * ## Import * * The workspace file resource can be imported using workspace file path * * bash * * ```sh * $ pulumi import databricks:index/workspaceFile:WorkspaceFile this /path/to/file * ``` */ export declare class WorkspaceFile extends pulumi.CustomResource { /** * Get an existing WorkspaceFile 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?: WorkspaceFileState, opts?: pulumi.CustomResourceOptions): WorkspaceFile; /** * Returns true if the given object is an instance of WorkspaceFile. 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 WorkspaceFile; /** * The base64-encoded file content. Conflicts with `source`. Use of `contentBase64` is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a workspace file with configuration properties for a data pipeline. */ readonly contentBase64: pulumi.Output<string | undefined>; readonly md5: pulumi.Output<string | undefined>; /** * Unique identifier for a workspace file */ readonly objectId: pulumi.Output<number>; /** * The absolute path of the workspace file, beginning with "/", e.g. "/Demo". */ readonly path: pulumi.Output<string>; /** * Path to file on local filesystem. Conflicts with `contentBase64`. */ readonly source: pulumi.Output<string | undefined>; /** * Routable URL of the workspace file */ readonly url: pulumi.Output<string>; /** * path on Workspace File System (WSFS) in form of `/Workspace` + `path` */ readonly workspacePath: pulumi.Output<string>; /** * Create a WorkspaceFile 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: WorkspaceFileArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WorkspaceFile resources. */ export interface WorkspaceFileState { /** * The base64-encoded file content. Conflicts with `source`. Use of `contentBase64` is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a workspace file with configuration properties for a data pipeline. */ contentBase64?: pulumi.Input<string>; md5?: pulumi.Input<string>; /** * Unique identifier for a workspace file */ objectId?: pulumi.Input<number>; /** * The absolute path of the workspace file, beginning with "/", e.g. "/Demo". */ path?: pulumi.Input<string>; /** * Path to file on local filesystem. Conflicts with `contentBase64`. */ source?: pulumi.Input<string>; /** * Routable URL of the workspace file */ url?: 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 WorkspaceFile resource. */ export interface WorkspaceFileArgs { /** * The base64-encoded file content. Conflicts with `source`. Use of `contentBase64` is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a workspace file with configuration properties for a data pipeline. */ contentBase64?: pulumi.Input<string>; md5?: pulumi.Input<string>; /** * Unique identifier for a workspace file */ objectId?: pulumi.Input<number>; /** * The absolute path of the workspace file, beginning with "/", e.g. "/Demo". */ path: pulumi.Input<string>; /** * Path to file on local filesystem. Conflicts with `contentBase64`. */ source?: pulumi.Input<string>; }