@pulumi/databricks/sqlDashboard.js

A Pulumi package for creating and managing databricks cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.SqlDashboard = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * !> This resource is deprecated! Please switch to databricks.Dashboard to author new AI/BI dashboards using the latest tooling.
 *
 * This resource is used to manage [Legacy dashboards](https://docs.databricks.com/sql/user/dashboards/index.html). To manage [SQL resources](https://docs.databricks.com/sql/get-started/concepts.html) you must have `databricksSqlAccess` on your databricks.Group or databricks_user.
 *
 * > documentation for this resource is a work in progress.
 *
 * A dashboard may have one or more widgets.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const sharedDir = new databricks.Directory("shared_dir", {path: "/Shared/Dashboards"});
 * const d1 = new databricks.SqlDashboard("d1", {
 *     name: "My Dashboard Name",
 *     parent: pulumi.interpolate`folders/${sharedDir.objectId}`,
 *     tags: [
 *         "some-tag",
 *         "another-tag",
 *     ],
 * });
 * ```
 *
 * Example permission to share dashboard with all users:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const d1 = new databricks.Permissions("d1", {
 *     sqlDashboardId: d1DatabricksSqlDashboard.id,
 *     accessControls: [{
 *         groupName: users.displayName,
 *         permissionLevel: "CAN_RUN",
 *     }],
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are often used in the same context:
 *
 * * End to end workspace management guide.
 * * databricks.SqlEndpoint to manage Databricks SQL [Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).
 * * databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and [data access properties](https://docs.databricks.com/sql/admin/data-access-configuration.html) for all databricks.SqlEndpoint of workspace.
 * * databricks.Grants to manage data access in Unity Catalog.
 *
 * ## Import
 *
 * You can import a `databricks_sql_dashboard` resource with ID like the following:
 *
 * hcl
 *
 * import {
 *
 *   to = databricks_sql_dashboard.this
 *
 *   id = "<dashboard-id>"
 *
 * }
 *
 * Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/sqlDashboard:SqlDashboard this "<dashboard-id>"
 * ```
 */
class SqlDashboard extends pulumi.CustomResource {
    /**
     * Get an existing SqlDashboard 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, id, state, opts) {
        return new SqlDashboard(name, state, { ...opts, id: id });
    }
    /**
     * Returns true if the given object is an instance of SqlDashboard.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj) {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === SqlDashboard.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["createdAt"] = state?.createdAt;
            resourceInputs["dashboardFiltersEnabled"] = state?.dashboardFiltersEnabled;
            resourceInputs["name"] = state?.name;
            resourceInputs["parent"] = state?.parent;
            resourceInputs["runAsRole"] = state?.runAsRole;
            resourceInputs["tags"] = state?.tags;
            resourceInputs["updatedAt"] = state?.updatedAt;
        }
        else {
            const args = argsOrState;
            resourceInputs["createdAt"] = args?.createdAt;
            resourceInputs["dashboardFiltersEnabled"] = args?.dashboardFiltersEnabled;
            resourceInputs["name"] = args?.name;
            resourceInputs["parent"] = args?.parent;
            resourceInputs["runAsRole"] = args?.runAsRole;
            resourceInputs["tags"] = args?.tags;
            resourceInputs["updatedAt"] = args?.updatedAt;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(SqlDashboard.__pulumiType, name, resourceInputs, opts);
    }
}
exports.SqlDashboard = SqlDashboard;
/** @internal */
SqlDashboard.__pulumiType = 'databricks:index/sqlDashboard:SqlDashboard';
//# sourceMappingURL=sqlDashboard.js.map