Notebook

Snowflake v2.10.0, Nov 22 25

Snowflake v2.10.0 published on Saturday, Nov 22, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Snowflake v2.10.0 published on Saturday, Nov 22, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/notebook:Notebook example '"<db_name>"."<schema_name>"."<notebook_name>"'

Create Notebook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Notebook(name: string, args: NotebookArgs, opts?: CustomResourceOptions);

@overload
def Notebook(resource_name: str,
             args: NotebookArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Notebook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             database: Optional[str] = None,
             schema: Optional[str] = None,
             comment: Optional[str] = None,
             froms: Optional[Sequence[NotebookFromArgs]] = None,
             idle_auto_shutdown_time_seconds: Optional[int] = None,
             main_file: Optional[str] = None,
             name: Optional[str] = None,
             query_warehouse: Optional[str] = None,
             warehouse: Optional[str] = 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: snowflake:Notebook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var notebookResource = new Snowflake.Notebook("notebookResource", new()
{
    Database = "string",
    Schema = "string",
    Comment = "string",
    Froms = new[]
    {
        new Snowflake.Inputs.NotebookFromArgs
        {
            Stage = "string",
            Path = "string",
        },
    },
    IdleAutoShutdownTimeSeconds = 0,
    MainFile = "string",
    Name = "string",
    QueryWarehouse = "string",
    Warehouse = "string",
});

example, err := snowflake.NewNotebook(ctx, "notebookResource", &snowflake.NotebookArgs{
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	Comment:  pulumi.String("string"),
	Froms: snowflake.NotebookFromArray{
		&snowflake.NotebookFromArgs{
			Stage: pulumi.String("string"),
			Path:  pulumi.String("string"),
		},
	},
	IdleAutoShutdownTimeSeconds: pulumi.Int(0),
	MainFile:                    pulumi.String("string"),
	Name:                        pulumi.String("string"),
	QueryWarehouse:              pulumi.String("string"),
	Warehouse:                   pulumi.String("string"),
})

var notebookResource = new Notebook("notebookResource", NotebookArgs.builder()
    .database("string")
    .schema("string")
    .comment("string")
    .froms(NotebookFromArgs.builder()
        .stage("string")
        .path("string")
        .build())
    .idleAutoShutdownTimeSeconds(0)
    .mainFile("string")
    .name("string")
    .queryWarehouse("string")
    .warehouse("string")
    .build());

notebook_resource = snowflake.Notebook("notebookResource",
    database="string",
    schema="string",
    comment="string",
    froms=[{
        "stage": "string",
        "path": "string",
    }],
    idle_auto_shutdown_time_seconds=0,
    main_file="string",
    name="string",
    query_warehouse="string",
    warehouse="string")

const notebookResource = new snowflake.Notebook("notebookResource", {
    database: "string",
    schema: "string",
    comment: "string",
    froms: [{
        stage: "string",
        path: "string",
    }],
    idleAutoShutdownTimeSeconds: 0,
    mainFile: "string",
    name: "string",
    queryWarehouse: "string",
    warehouse: "string",
});

type: snowflake:Notebook
properties:
    comment: string
    database: string
    froms:
        - path: string
          stage: string
    idleAutoShutdownTimeSeconds: 0
    mainFile: string
    name: string
    queryWarehouse: string
    schema: string
    warehouse: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Notebook resource accepts the following input properties:

Database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Comment string: Specifies a comment for the notebook.
Froms List<NotebookFrom>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
IdleAutoShutdownTimeSeconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
MainFile string: Specifies a user-specified identifier for the notebook file name.
Name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
QueryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
Warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

Database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Comment string: Specifies a comment for the notebook.
Froms []NotebookFromArgs: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
IdleAutoShutdownTimeSeconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
MainFile string: Specifies a user-specified identifier for the notebook file name.
Name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
QueryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
Warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

database String: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment String: Specifies a comment for the notebook.
froms List<NotebookFrom>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
idleAutoShutdownTimeSeconds Integer: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile String: Specifies a user-specified identifier for the notebook file name.
name String: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse String: Specifies the warehouse where SQL queries in the notebook are run.
warehouse String: Specifies the warehouse that runs the notebook kernel and python code.

database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment string: Specifies a comment for the notebook.
froms NotebookFrom[]: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
idleAutoShutdownTimeSeconds number: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile string: Specifies a user-specified identifier for the notebook file name.
name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

database str: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema str: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment str: Specifies a comment for the notebook.
froms Sequence[NotebookFromArgs]: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
idle_auto_shutdown_time_seconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
main_file str: Specifies a user-specified identifier for the notebook file name.
name str: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
query_warehouse str: Specifies the warehouse where SQL queries in the notebook are run.
warehouse str: Specifies the warehouse that runs the notebook kernel and python code.

database String: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment String: Specifies a comment for the notebook.
froms List<Property Map>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
idleAutoShutdownTimeSeconds Number: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile String: Specifies a user-specified identifier for the notebook file name.
name String: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse String: Specifies the warehouse where SQL queries in the notebook are run.
warehouse String: Specifies the warehouse that runs the notebook kernel and python code.

Outputs

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

DescribeOutputs List<NotebookDescribeOutput>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs List<NotebookShowOutput>: Outputs the result of SHOW NOTEBOOKS for the given notebook

DescribeOutputs []NotebookDescribeOutput: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs []NotebookShowOutput: Outputs the result of SHOW NOTEBOOKS for the given notebook

describeOutputs List<NotebookDescribeOutput>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<NotebookShowOutput>: Outputs the result of SHOW NOTEBOOKS for the given notebook

describeOutputs NotebookDescribeOutput[]: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
id string: The provider-assigned unique ID for this managed resource.
showOutputs NotebookShowOutput[]: Outputs the result of SHOW NOTEBOOKS for the given notebook

describe_outputs Sequence[NotebookDescribeOutput]: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
id str: The provider-assigned unique ID for this managed resource.
show_outputs Sequence[NotebookShowOutput]: Outputs the result of SHOW NOTEBOOKS for the given notebook

describeOutputs List<Property Map>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>: Outputs the result of SHOW NOTEBOOKS for the given 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,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[NotebookDescribeOutputArgs]] = None,
        froms: Optional[Sequence[NotebookFromArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        idle_auto_shutdown_time_seconds: Optional[int] = None,
        main_file: Optional[str] = None,
        name: Optional[str] = None,
        query_warehouse: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[NotebookShowOutputArgs]] = None,
        warehouse: 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)

resources:  _:    type: snowflake:Notebook    get:      id: ${id}

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:

Comment string: Specifies a comment for the notebook.
Database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs List<NotebookDescribeOutput>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
Froms List<NotebookFrom>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IdleAutoShutdownTimeSeconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
MainFile string: Specifies a user-specified identifier for the notebook file name.
Name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
QueryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
Schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs List<NotebookShowOutput>: Outputs the result of SHOW NOTEBOOKS for the given notebook
Warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

Comment string: Specifies a comment for the notebook.
Database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs []NotebookDescribeOutputArgs: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
Froms []NotebookFromArgs: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IdleAutoShutdownTimeSeconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
MainFile string: Specifies a user-specified identifier for the notebook file name.
Name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
QueryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
Schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs []NotebookShowOutputArgs: Outputs the result of SHOW NOTEBOOKS for the given notebook
Warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

comment String: Specifies a comment for the notebook.
database String: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<NotebookDescribeOutput>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
froms List<NotebookFrom>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
idleAutoShutdownTimeSeconds Integer: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile String: Specifies a user-specified identifier for the notebook file name.
name String: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse String: Specifies the warehouse where SQL queries in the notebook are run.
schema String: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<NotebookShowOutput>: Outputs the result of SHOW NOTEBOOKS for the given notebook
warehouse String: Specifies the warehouse that runs the notebook kernel and python code.

comment string: Specifies a comment for the notebook.
database string: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs NotebookDescribeOutput[]: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
froms NotebookFrom[]: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
idleAutoShutdownTimeSeconds number: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile string: Specifies a user-specified identifier for the notebook file name.
name string: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse string: Specifies the warehouse where SQL queries in the notebook are run.
schema string: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs NotebookShowOutput[]: Outputs the result of SHOW NOTEBOOKS for the given notebook
warehouse string: Specifies the warehouse that runs the notebook kernel and python code.

comment str: Specifies a comment for the notebook.
database str: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describe_outputs Sequence[NotebookDescribeOutputArgs]: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
froms Sequence[NotebookFromArgs]: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
idle_auto_shutdown_time_seconds int: Specifies the number of seconds of idle time before the notebook is shut down automatically.
main_file str: Specifies a user-specified identifier for the notebook file name.
name str: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
query_warehouse str: Specifies the warehouse where SQL queries in the notebook are run.
schema str: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_outputs Sequence[NotebookShowOutputArgs]: Outputs the result of SHOW NOTEBOOKS for the given notebook
warehouse str: Specifies the warehouse that runs the notebook kernel and python code.

comment String: Specifies a comment for the notebook.
database String: The database in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<Property Map>: Outputs the result of DESCRIBE NOTEBOOK for the given notebook.
froms List<Property Map>: Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
idleAutoShutdownTimeSeconds Number: Specifies the number of seconds of idle time before the notebook is shut down automatically.
mainFile String: Specifies a user-specified identifier for the notebook file name.
name String: Specifies the identifier for the notebook; must be unique for the schema in which the notebook is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
queryWarehouse String: Specifies the warehouse where SQL queries in the notebook are run.
schema String: The schema in which to create the notebook. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<Property Map>: Outputs the result of SHOW NOTEBOOKS for the given notebook
warehouse String: Specifies the warehouse that runs the notebook kernel and python code.