Docs Packages
  1. Pulumi Registry
  2. Databricks
  3. API Docs
  4. Notebook
databricks logo
Databricks v1.14.0, May 23 23

databricks.Notebook

Explore with Pulumi AI

Import

The resource notebook can be imported using notebook path bash

 $ pulumi import databricks:index/notebook:Notebook this /path/to/notebook

Create Notebook Resource

new Notebook(name: string, args: NotebookArgs, opts?: CustomResourceOptions);
@overload
def Notebook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             content_base64: Optional[str] = None,
             format: Optional[str] = None,
             language: Optional[str] = None,
             md5: Optional[str] = None,
             object_id: Optional[int] = None,
             object_type: Optional[str] = None,
             path: Optional[str] = None,
             source: Optional[str] = None)
@overload
def Notebook(resource_name: str,
             args: NotebookArgs,
             opts: Optional[ResourceOptions] = None)
func NewNotebook(ctx *Context, name string, args NotebookArgs, opts ...ResourceOption) (*Notebook, error)
public Notebook(string name, NotebookArgs args, CustomResourceOptions? opts = null)
public Notebook(String name, NotebookArgs args)
public Notebook(String name, NotebookArgs args, CustomResourceOptions options)

type: databricks:Notebook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NotebookArgs
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 NotebookArgs
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 NotebookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NotebookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args NotebookArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Notebook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Notebook resource accepts the following input properties:

Path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

ContentBase64 string
Format string
Language string

One of SCALA, PYTHON, SQL, R.

Md5 string
ObjectId int

Unique identifier for a NOTEBOOK

ObjectType string

Deprecated:

Always is a notebook

Source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

Path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

ContentBase64 string
Format string
Language string

One of SCALA, PYTHON, SQL, R.

Md5 string
ObjectId int

Unique identifier for a NOTEBOOK

ObjectType string

Deprecated:

Always is a notebook

Source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

path String

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

contentBase64 String
format String
language String

One of SCALA, PYTHON, SQL, R.

md5 String
objectId Integer

Unique identifier for a NOTEBOOK

objectType String

Deprecated:

Always is a notebook

source String

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

contentBase64 string
format string
language string

One of SCALA, PYTHON, SQL, R.

md5 string
objectId number

Unique identifier for a NOTEBOOK

objectType string

Deprecated:

Always is a notebook

source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

path str

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

content_base64 str
format str
language str

One of SCALA, PYTHON, SQL, R.

md5 str
object_id int

Unique identifier for a NOTEBOOK

object_type str

Deprecated:

Always is a notebook

source str

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

path String

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

contentBase64 String
format String
language String

One of SCALA, PYTHON, SQL, R.

md5 String
objectId Number

Unique identifier for a NOTEBOOK

objectType String

Deprecated:

Always is a notebook

source String

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Url string

Routable URL of the notebook

Id string

The provider-assigned unique ID for this managed resource.

Url string

Routable URL of the notebook

id String

The provider-assigned unique ID for this managed resource.

url String

Routable URL of the notebook

id string

The provider-assigned unique ID for this managed resource.

url string

Routable URL of the notebook

id str

The provider-assigned unique ID for this managed resource.

url str

Routable URL of the notebook

id String

The provider-assigned unique ID for this managed resource.

url String

Routable URL of the notebook

Look up Existing Notebook Resource

Get an existing Notebook 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?: NotebookState, opts?: CustomResourceOptions): Notebook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content_base64: Optional[str] = None,
        format: Optional[str] = None,
        language: Optional[str] = None,
        md5: Optional[str] = None,
        object_id: Optional[int] = None,
        object_type: Optional[str] = None,
        path: Optional[str] = None,
        source: Optional[str] = None,
        url: Optional[str] = None) -> Notebook
func GetNotebook(ctx *Context, name string, id IDInput, state *NotebookState, opts ...ResourceOption) (*Notebook, error)
public static Notebook Get(string name, Input<string> id, NotebookState? state, CustomResourceOptions? opts = null)
public static Notebook get(String name, Output<String> id, NotebookState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
ContentBase64 string
Format string
Language string

One of SCALA, PYTHON, SQL, R.

Md5 string
ObjectId int

Unique identifier for a NOTEBOOK

ObjectType string

Deprecated:

Always is a notebook

Path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

Source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

Url string

Routable URL of the notebook

ContentBase64 string
Format string
Language string

One of SCALA, PYTHON, SQL, R.

Md5 string
ObjectId int

Unique identifier for a NOTEBOOK

ObjectType string

Deprecated:

Always is a notebook

Path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

Source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

Url string

Routable URL of the notebook

contentBase64 String
format String
language String

One of SCALA, PYTHON, SQL, R.

md5 String
objectId Integer

Unique identifier for a NOTEBOOK

objectType String

Deprecated:

Always is a notebook

path String

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

source String

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

url String

Routable URL of the notebook

contentBase64 string
format string
language string

One of SCALA, PYTHON, SQL, R.

md5 string
objectId number

Unique identifier for a NOTEBOOK

objectType string

Deprecated:

Always is a notebook

path string

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

source string

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

url string

Routable URL of the notebook

content_base64 str
format str
language str

One of SCALA, PYTHON, SQL, R.

md5 str
object_id int

Unique identifier for a NOTEBOOK

object_type str

Deprecated:

Always is a notebook

path str

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

source str

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

url str

Routable URL of the notebook

contentBase64 String
format String
language String

One of SCALA, PYTHON, SQL, R.

md5 String
objectId Number

Unique identifier for a NOTEBOOK

objectType String

Deprecated:

Always is a notebook

path String

The absolute path of the notebook or directory, beginning with "/", e.g. "/Demo".

source String

Path to notebook in source code format on local filesystem. Conflicts with content_base64.

url String

Routable URL of the notebook

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.