@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
168 lines (167 loc) • 6.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to manage Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html). To manage [Dashboards](https://docs.databricks.com/en/dashboards/index.html) you must have a warehouse access on your databricks workspace.
*
* ## Example Usage
*
* Dashboard using `serializedDashboard` attribute:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const starter = databricks.getSqlWarehouse({
* name: "Starter Warehouse",
* });
* const dashboard = new databricks.Dashboard("dashboard", {
* displayName: "New Dashboard",
* warehouseId: starter.then(starter => starter.id),
* serializedDashboard: "{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page\"}]}",
* embedCredentials: false,
* parentPath: "/Shared/provider-test",
* });
* ```
*
* Dashboard using `filePath` attribute:
*
* ## Import
*
* You can import a `databricks_dashboard` resource with ID like the following:
*
* bash
*
* ```sh
* $ pulumi import databricks:index/dashboard:Dashboard this <dashboard-id>
* ```
*/
export declare class Dashboard extends pulumi.CustomResource {
/**
* Get an existing Dashboard 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?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard;
/**
* Returns true if the given object is an instance of Dashboard. 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 Dashboard;
readonly createTime: pulumi.Output<string>;
readonly dashboardChangeDetected: pulumi.Output<boolean | undefined>;
readonly dashboardId: pulumi.Output<string>;
/**
* The display name of the dashboard.
*/
readonly displayName: pulumi.Output<string>;
/**
* Whether to embed credentials in the dashboard. Default is `true`.
*/
readonly embedCredentials: pulumi.Output<boolean | undefined>;
readonly etag: pulumi.Output<string>;
/**
* The path to the dashboard JSON file. Conflicts with `serializedDashboard`.
*/
readonly filePath: pulumi.Output<string | undefined>;
readonly lifecycleState: pulumi.Output<string>;
readonly md5: pulumi.Output<string>;
/**
* 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.
*/
readonly parentPath: pulumi.Output<string>;
readonly path: pulumi.Output<string>;
/**
* The contents of the dashboard in serialized string form. Conflicts with `filePath`.
*/
readonly serializedDashboard: pulumi.Output<string | undefined>;
readonly updateTime: pulumi.Output<string>;
/**
* The warehouse ID used to run the dashboard.
*/
readonly warehouseId: pulumi.Output<string>;
/**
* Create a Dashboard 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: DashboardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Dashboard resources.
*/
export interface DashboardState {
createTime?: pulumi.Input<string>;
dashboardChangeDetected?: pulumi.Input<boolean>;
dashboardId?: pulumi.Input<string>;
/**
* The display name of the dashboard.
*/
displayName?: pulumi.Input<string>;
/**
* Whether to embed credentials in the dashboard. Default is `true`.
*/
embedCredentials?: pulumi.Input<boolean>;
etag?: pulumi.Input<string>;
/**
* The path to the dashboard JSON file. Conflicts with `serializedDashboard`.
*/
filePath?: pulumi.Input<string>;
lifecycleState?: pulumi.Input<string>;
md5?: pulumi.Input<string>;
/**
* 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.
*/
parentPath?: pulumi.Input<string>;
path?: pulumi.Input<string>;
/**
* The contents of the dashboard in serialized string form. Conflicts with `filePath`.
*/
serializedDashboard?: pulumi.Input<string>;
updateTime?: pulumi.Input<string>;
/**
* The warehouse ID used to run the dashboard.
*/
warehouseId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Dashboard resource.
*/
export interface DashboardArgs {
createTime?: pulumi.Input<string>;
dashboardChangeDetected?: pulumi.Input<boolean>;
dashboardId?: pulumi.Input<string>;
/**
* The display name of the dashboard.
*/
displayName: pulumi.Input<string>;
/**
* Whether to embed credentials in the dashboard. Default is `true`.
*/
embedCredentials?: pulumi.Input<boolean>;
etag?: pulumi.Input<string>;
/**
* The path to the dashboard JSON file. Conflicts with `serializedDashboard`.
*/
filePath?: pulumi.Input<string>;
lifecycleState?: pulumi.Input<string>;
md5?: pulumi.Input<string>;
/**
* 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.
*/
parentPath: pulumi.Input<string>;
path?: pulumi.Input<string>;
/**
* The contents of the dashboard in serialized string form. Conflicts with `filePath`.
*/
serializedDashboard?: pulumi.Input<string>;
updateTime?: pulumi.Input<string>;
/**
* The warehouse ID used to run the dashboard.
*/
warehouseId: pulumi.Input<string>;
}