@pulumi/databricks/sqlWidget.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * !> This resource is deprecated and will be removed in future.
 *
 * > Please switch to databricks.Dashboard to author new AI/BI dashboards using the latest tooling
 *
 * 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 widget is always tied to a Legacy dashboard. Every dashboard may have one or more widgets.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const d1w1 = new databricks.SqlWidget("d1w1", {
 *     dashboardId: d1.id,
 *     text: "Hello! I'm a **text widget**!",
 *     position: {
 *         sizeX: 3,
 *         sizeY: 4,
 *         posX: 0,
 *         posY: 0,
 *     },
 * });
 * const d1w2 = new databricks.SqlWidget("d1w2", {
 *     dashboardId: d1.id,
 *     visualizationId: q1v1.id,
 *     position: {
 *         sizeX: 3,
 *         sizeY: 4,
 *         posX: 3,
 *         posY: 0,
 *     },
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are often used in the same context:
 *
 * * End to end workspace management guide.
 * * databricks.SqlDashboard to manage Databricks SQL [Dashboards](https://docs.databricks.com/sql/user/dashboards/index.html).
 * * 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_widget` resource with ID like the following:
 *
 * hcl
 *
 * import {
 *
 *   to = databricks_sql_widget.this
 *
 *   id = "<dashboard-id>/<widget-id>"
 *
 * }
 *
 * Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/sqlWidget:SqlWidget this <dashboard-id>/<widget-id>
 * ```
 */
export declare class SqlWidget extends pulumi.CustomResource {
    /**
     * Get an existing SqlWidget 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?: SqlWidgetState, opts?: pulumi.CustomResourceOptions): SqlWidget;
    /**
     * Returns true if the given object is an instance of SqlWidget.  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 SqlWidget;
    readonly dashboardId: pulumi.Output<string>;
    readonly description: pulumi.Output<string | undefined>;
    readonly parameters: pulumi.Output<outputs.SqlWidgetParameter[] | undefined>;
    readonly position: pulumi.Output<outputs.SqlWidgetPosition | undefined>;
    readonly text: pulumi.Output<string | undefined>;
    readonly title: pulumi.Output<string | undefined>;
    readonly visualizationId: pulumi.Output<string | undefined>;
    readonly widgetId: pulumi.Output<string>;
    /**
     * Create a SqlWidget 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: SqlWidgetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SqlWidget resources.
 */
export interface SqlWidgetState {
    dashboardId?: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    parameters?: pulumi.Input<pulumi.Input<inputs.SqlWidgetParameter>[]>;
    position?: pulumi.Input<inputs.SqlWidgetPosition>;
    text?: pulumi.Input<string>;
    title?: pulumi.Input<string>;
    visualizationId?: pulumi.Input<string>;
    widgetId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SqlWidget resource.
 */
export interface SqlWidgetArgs {
    dashboardId: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    parameters?: pulumi.Input<pulumi.Input<inputs.SqlWidgetParameter>[]>;
    position?: pulumi.Input<inputs.SqlWidgetPosition>;
    text?: pulumi.Input<string>;
    title?: pulumi.Input<string>;
    visualizationId?: pulumi.Input<string>;
    widgetId?: pulumi.Input<string>;
}