@pulumi/databricks/sqlDashboard.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * > 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.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and [more](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html).
 *
 * ## Import
 *
 * You can import a `databricks_sql_dashboard` resource with ID like the following:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/sqlDashboard:SqlDashboard this <dashboard-id>
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: SqlDashboardState, opts?: pulumi.CustomResourceOptions): SqlDashboard;
    /**
     * 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: any): obj is SqlDashboard;
    readonly createdAt: pulumi.Output<string>;
    readonly dashboardFiltersEnabled: pulumi.Output<boolean | undefined>;
    readonly name: pulumi.Output<string>;
    readonly parent: pulumi.Output<string | undefined>;
    readonly runAsRole: pulumi.Output<string | undefined>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly updatedAt: pulumi.Output<string>;
    /**
     * Create a SqlDashboard 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?: SqlDashboardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SqlDashboard resources.
 */
export interface SqlDashboardState {
    createdAt?: pulumi.Input<string>;
    dashboardFiltersEnabled?: pulumi.Input<boolean>;
    name?: pulumi.Input<string>;
    parent?: pulumi.Input<string>;
    runAsRole?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    updatedAt?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SqlDashboard resource.
 */
export interface SqlDashboardArgs {
    createdAt?: pulumi.Input<string>;
    dashboardFiltersEnabled?: pulumi.Input<boolean>;
    name?: pulumi.Input<string>;
    parent?: pulumi.Input<string>;
    runAsRole?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    updatedAt?: pulumi.Input<string>;
}