@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
105 lines (104 loc) • 4.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This is a resource that lets you manage relatively small files on [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html). The best use cases are libraries for databricks.Cluster or databricks_job. You can also use databricks.DbfsFile and databricks.getDbfsFilePaths data sources.
*
* ## Import
*
* The resource dbfs file can be imported using the path of the file:
*
* bash
*
* ```sh
* $ pulumi import databricks:index/dbfsFile:DbfsFile this <path>
* ```
*/
export declare class DbfsFile extends pulumi.CustomResource {
/**
* Get an existing DbfsFile 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?: DbfsFileState, opts?: pulumi.CustomResourceOptions): DbfsFile;
/**
* Returns true if the given object is an instance of DbfsFile. 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 DbfsFile;
/**
* Encoded file contents. 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 data pipeline configuration file.
*/
readonly contentBase64: pulumi.Output<string | undefined>;
/**
* Path, but with `dbfs:` prefix.
*/
readonly dbfsPath: pulumi.Output<string>;
/**
* The file size of the file that is being tracked by this resource in bytes.
*/
readonly fileSize: pulumi.Output<number>;
readonly md5: pulumi.Output<string | undefined>;
/**
* The path of the file in which you wish to save.
*/
readonly path: pulumi.Output<string>;
/**
* The full absolute path to the file. Conflicts with `contentBase64`.
*/
readonly source: pulumi.Output<string | undefined>;
/**
* Create a DbfsFile 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: DbfsFileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DbfsFile resources.
*/
export interface DbfsFileState {
/**
* Encoded file contents. 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 data pipeline configuration file.
*/
contentBase64?: pulumi.Input<string>;
/**
* Path, but with `dbfs:` prefix.
*/
dbfsPath?: pulumi.Input<string>;
/**
* The file size of the file that is being tracked by this resource in bytes.
*/
fileSize?: pulumi.Input<number>;
md5?: pulumi.Input<string>;
/**
* The path of the file in which you wish to save.
*/
path?: pulumi.Input<string>;
/**
* The full absolute path to the file. Conflicts with `contentBase64`.
*/
source?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DbfsFile resource.
*/
export interface DbfsFileArgs {
/**
* Encoded file contents. 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 data pipeline configuration file.
*/
contentBase64?: pulumi.Input<string>;
md5?: pulumi.Input<string>;
/**
* The path of the file in which you wish to save.
*/
path: pulumi.Input<string>;
/**
* The full absolute path to the file. Conflicts with `contentBase64`.
*/
source?: pulumi.Input<string>;
}