@pulumi/databricks/notebook.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * This resource allows you to manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html). You can also work with databricks.Notebook and databricks.getNotebookPaths data sources.
 *
 * > This resource can only be used with a workspace-level provider!
 *
 * ## Import
 *
 * The resource notebook can be imported using notebook path
 *
 * hcl
 *
 * import {
 *
 *   to = databricks_notebook.this
 *
 *   id = "/path/to/notebook"
 *
 * }
 *
 * Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/notebook:Notebook this /path/to/notebook
 * ```
 */
export declare class Notebook extends pulumi.CustomResource {
    /**
     * Get an existing Notebook 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?: NotebookState, opts?: pulumi.CustomResourceOptions): Notebook;
    /**
     * Returns true if the given object is an instance of Notebook.  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 Notebook;
    /**
     * The base64-encoded notebook source code. 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 notebook with configuration properties for a data pipeline.
     */
    readonly contentBase64: pulumi.Output<string | undefined>;
    readonly format: pulumi.Output<string>;
    /**
     * One of `SCALA`, `PYTHON`, `SQL`, `R`.
     */
    readonly language: pulumi.Output<string>;
    readonly md5: pulumi.Output<string | undefined>;
    /**
     * Unique identifier for a NOTEBOOK
     */
    readonly objectId: pulumi.Output<number>;
    /**
     * @deprecated Always is a notebook
     */
    readonly objectType: pulumi.Output<string>;
    /**
     * The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".
     */
    readonly path: pulumi.Output<string>;
    /**
     * Path to notebook in source code format on local filesystem. Conflicts with `contentBase64`.
     */
    readonly source: pulumi.Output<string | undefined>;
    /**
     * Routable URL of the notebook
     */
    readonly url: pulumi.Output<string>;
    /**
     * path on Workspace File System (WSFS) in form of `/Workspace` + `path`
     */
    readonly workspacePath: pulumi.Output<string>;
    /**
     * Create a Notebook 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: NotebookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Notebook resources.
 */
export interface NotebookState {
    /**
     * The base64-encoded notebook source code. 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 notebook with configuration properties for a data pipeline.
     */
    contentBase64?: pulumi.Input<string>;
    format?: pulumi.Input<string>;
    /**
     * One of `SCALA`, `PYTHON`, `SQL`, `R`.
     */
    language?: pulumi.Input<string>;
    md5?: pulumi.Input<string>;
    /**
     * Unique identifier for a NOTEBOOK
     */
    objectId?: pulumi.Input<number>;
    /**
     * @deprecated Always is a notebook
     */
    objectType?: pulumi.Input<string>;
    /**
     * The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".
     */
    path?: pulumi.Input<string>;
    /**
     * Path to notebook in source code format on local filesystem. Conflicts with `contentBase64`.
     */
    source?: pulumi.Input<string>;
    /**
     * Routable URL of the notebook
     */
    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 Notebook resource.
 */
export interface NotebookArgs {
    /**
     * The base64-encoded notebook source code. 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 notebook with configuration properties for a data pipeline.
     */
    contentBase64?: pulumi.Input<string>;
    format?: pulumi.Input<string>;
    /**
     * One of `SCALA`, `PYTHON`, `SQL`, `R`.
     */
    language?: pulumi.Input<string>;
    md5?: pulumi.Input<string>;
    /**
     * Unique identifier for a NOTEBOOK
     */
    objectId?: pulumi.Input<number>;
    /**
     * @deprecated Always is a notebook
     */
    objectType?: pulumi.Input<string>;
    /**
     * The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".
     */
    path: pulumi.Input<string>;
    /**
     * Path to notebook in source code format on local filesystem. Conflicts with `contentBase64`.
     */
    source?: pulumi.Input<string>;
}