databricks_dashboard Resource

API Documentation

This resource allows you to manage Databricks Dashboards. To manage Dashboards you must have a warehouse access on your databricks workspace.

-> This resource can only be used with a workspace-level provider!

Example Usage

Dashboard using serialized_dashboard attribute:

data "databricks_sql_warehouse" "starter" {
  name = "Starter Warehouse"
}

resource "databricks_dashboard" "dashboard" {
  display_name         = "New Dashboard"
  warehouse_id         = data.databricks_sql_warehouse.starter.id
  serialized_dashboard = "{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page\"}]}"
  embed_credentials    = false // Optional
  parent_path          = "/Shared/provider-test"
}

Dashboard using file_path attribute:

data "databricks_sql_warehouse" "starter" {
  name = "Starter Warehouse"
}

resource "databricks_dashboard" "dashboard" {
  display_name      = "New Dashboard"
  warehouse_id      = data.databricks_sql_warehouse.starter.id
  file_path         = "${path.module}/dashboard.json"
  embed_credentials = false // Optional
  parent_path       = "/Shared/provider-test"
}

Argument Reference

The following arguments are supported:

• display_name - (Required) The display name of the dashboard.
• warehouse_id - (Required) The warehouse ID used to run the dashboard.
• serialized_dashboard - (Optional) The contents of the dashboard in serialized string form. Conflicts with file_path.
• file_path - (Optional) The path to the dashboard JSON file. Conflicts with serialized_dashboard.
• embed_credentials - (Optional) Whether to embed credentials in the dashboard. Default is true.
• parent_path - (Required) The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. If folder doesn't exist, it will be created.
• dataset_catalog - (Optional) Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).
• dataset_schema - (Optional) Sets the default schema for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).
• provider_config - (Optional) Configure the provider for management through account provider. This block consists of the following fields:
  • workspace_id - (Required) Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

Attribute Reference

In addition to all arguments above, the following attributes are exported:

• id - The unique ID of the dashboard.

Access Control

databricks_permissions can control which groups or individual users can Manage, Edit, Read or Run individual dashboards.

Import

You can import a databricks_dashboard resource with ID like the following:

import {
  to = databricks_dashboard.this
  id = "<dashboard-id>"
}

Alternatively, when using terraform version 1.4 or earlier, import using the terraform import command:

terraform import databricks_dashboard.this <dashboard-id>

Notes

• Only one of serialized_dashboard or file_path can be used throughout the lifecycle of the dashboard. If you want to switch from one to the other, you must first destroy the dashboard resource and then recreate it with the new attribute.
• Dashboards managed by Terraform will be published automatically.