Skip to content

Dashboard

laktory.models.resources.databricks.Dashboard ¤

Bases: BaseModel, PulumiResource, TerraformResource

Databricks Lakeview Dashboard

Examples:

import io

from laktory import models

# Define job
job_yaml = '''
display_name: databricks-costs
file_path: ./dashboards/databricks_costs.json
parent_path: /.laktory/dashboards
warehouse_id: a7d9f2kl8mp3q6rt
access_controls:
    - group_name: account users
      permission_level: CAN_READ
    - group_name: account users
      permission_level: CAN_RUN
'''
dashboard = models.resources.databricks.Dashboard.model_validate_yaml(
    io.StringIO(job_yaml)
)
PARAMETER DESCRIPTION
access_controls

Access controls list

TYPE: list[AccessControl | VariableType] | VariableType DEFAULT: []

display_name

The display name of the dashboard.

TYPE: str | VariableType

embed_credentials

Whether to embed credentials in the dashboard. Default is true.

TYPE: bool | VariableType DEFAULT: None

file_path

The path to the dashboard JSON file. Conflicts with serialized_dashboard.

TYPE: str | VariableType DEFAULT: None

name_prefix

Prefix added to the dashboard display name

TYPE: str | VariableType DEFAULT: None

name_suffix

Suffix added to the dashboard display name

TYPE: str | VariableType DEFAULT: None

parent_path_

The path to a workspace folder (inside laktory root) containing the dashboard. If changed, the query will be recreated.

TYPE: str | None | VariableType DEFAULT: None

serialized_dashboard

The contents of the dashboard in serialized string form. Conflicts with file_path.

TYPE: str | VariableType DEFAULT: None

warehouse_id

The warehouse ID used to run the dashboard.

TYPE: str | VariableType

ATTRIBUTE DESCRIPTION
additional_core_resources
  • permissions

TYPE: list[PulumiResource]

additional_core_resources property ¤

  • permissions