Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks
  3. API Docs
  4. getSqlWarehouse
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.getSqlWarehouse

Explore with Pulumi AI

databricks logo
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

    Note If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add depends_on attribute in order to prevent default auth: cannot configure default credentials errors.

    Retrieves information about a databricks.getSqlWarehouse using its id. This could be retrieved programmatically using databricks.getSqlWarehouses data source.

    Example Usage

    • Retrieve attributes of each SQL warehouses in a workspace:
    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const all = databricks.getSqlWarehouses({});
const this = all.then(all => .reduce((__obj, [, ]) => ({ ...__obj, [__key]: databricks.getSqlWarehouse({
    id: __value,
}) })));

    import pulumi
import pulumi_databricks as databricks

all = databricks.get_sql_warehouses()
this = {__key: databricks.get_sql_warehouse(id=__value) for __key, __value in all.ids}

    Coming soon!

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetSqlWarehouses.Invoke();

    var @this = ;

});

    Coming soon!

    Coming soon!
    • Search for a specific SQL Warehouse by name:
    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const all = databricks.getSqlWarehouse({
    name: "Starter Warehouse",
});

    import pulumi
import pulumi_databricks as databricks

all = databricks.get_sql_warehouse(name="Starter Warehouse")

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.GetSqlWarehouse(ctx, &databricks.GetSqlWarehouseArgs{
			Name: pulumi.StringRef("Starter Warehouse"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetSqlWarehouse.Invoke(new()
    {
        Name = "Starter Warehouse",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetSqlWarehouseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var all = DatabricksFunctions.getSqlWarehouse(GetSqlWarehouseArgs.builder()
            .name("Starter Warehouse")
            .build());

    }
}

    variables:
  all:
    fn::invoke:
      Function: databricks:getSqlWarehouse
      Arguments:
        name: Starter Warehouse

    The following resources are often used in the same context:

    • End to end workspace management guide.
    • databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
    • databricks.SqlDashboard to manage Databricks SQL Dashboards.
    • databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and data access properties for all databricks.getSqlWarehouse of workspace.
    • databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

    Using getSqlWarehouse

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSqlWarehouse(args: GetSqlWarehouseArgs, opts?: InvokeOptions): Promise<GetSqlWarehouseResult>
function getSqlWarehouseOutput(args: GetSqlWarehouseOutputArgs, opts?: InvokeOptions): Output<GetSqlWarehouseResult>
    def get_sql_warehouse(auto_stop_mins: Optional[int] = None,
                      channel: Optional[GetSqlWarehouseChannel] = None,
                      cluster_size: Optional[str] = None,
                      creator_name: Optional[str] = None,
                      data_source_id: Optional[str] = None,
                      enable_photon: Optional[bool] = None,
                      enable_serverless_compute: Optional[bool] = None,
                      health: Optional[GetSqlWarehouseHealth] = None,
                      id: Optional[str] = None,
                      instance_profile_arn: Optional[str] = None,
                      jdbc_url: Optional[str] = None,
                      max_num_clusters: Optional[int] = None,
                      min_num_clusters: Optional[int] = None,
                      name: Optional[str] = None,
                      num_active_sessions: Optional[int] = None,
                      num_clusters: Optional[int] = None,
                      odbc_params: Optional[GetSqlWarehouseOdbcParams] = None,
                      spot_instance_policy: Optional[str] = None,
                      state: Optional[str] = None,
                      tags: Optional[GetSqlWarehouseTags] = None,
                      warehouse_type: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSqlWarehouseResult
def get_sql_warehouse_output(auto_stop_mins: Optional[pulumi.Input[int]] = None,
                      channel: Optional[pulumi.Input[GetSqlWarehouseChannelArgs]] = None,
                      cluster_size: Optional[pulumi.Input[str]] = None,
                      creator_name: Optional[pulumi.Input[str]] = None,
                      data_source_id: Optional[pulumi.Input[str]] = None,
                      enable_photon: Optional[pulumi.Input[bool]] = None,
                      enable_serverless_compute: Optional[pulumi.Input[bool]] = None,
                      health: Optional[pulumi.Input[GetSqlWarehouseHealthArgs]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      instance_profile_arn: Optional[pulumi.Input[str]] = None,
                      jdbc_url: Optional[pulumi.Input[str]] = None,
                      max_num_clusters: Optional[pulumi.Input[int]] = None,
                      min_num_clusters: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      num_active_sessions: Optional[pulumi.Input[int]] = None,
                      num_clusters: Optional[pulumi.Input[int]] = None,
                      odbc_params: Optional[pulumi.Input[GetSqlWarehouseOdbcParamsArgs]] = None,
                      spot_instance_policy: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[GetSqlWarehouseTagsArgs]] = None,
                      warehouse_type: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSqlWarehouseResult]
    func GetSqlWarehouse(ctx *Context, args *GetSqlWarehouseArgs, opts ...InvokeOption) (*GetSqlWarehouseResult, error)
func GetSqlWarehouseOutput(ctx *Context, args *GetSqlWarehouseOutputArgs, opts ...InvokeOption) GetSqlWarehouseResultOutput

    > Note: This function is named GetSqlWarehouse in the Go SDK.

    public static class GetSqlWarehouse 
{
    public static Task<GetSqlWarehouseResult> InvokeAsync(GetSqlWarehouseArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlWarehouseResult> Invoke(GetSqlWarehouseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSqlWarehouseResult> getSqlWarehouse(GetSqlWarehouseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: databricks:index/getSqlWarehouse:getSqlWarehouse
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AutoStopMins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    Channel GetSqlWarehouseChannel
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    CreatorName string
    The username of the user who created the endpoint.
    DataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    EnablePhoton bool
    Whether Photon is enabled.
    EnableServerlessCompute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    Health GetSqlWarehouseHealth
    Health status of the endpoint.
    Id string
    The ID of the SQL warehouse.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL warehouse is running.
    MinNumClusters int
    Minimum number of clusters available when a SQL warehouse is running.
    Name string
    Name of the SQL warehouse to search (case-sensitive).
    NumActiveSessions int
    The current number of clusters used by the endpoint.
    NumClusters int
    The current number of clusters used by the endpoint.
    OdbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    SpotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    State string
    The current state of the endpoint.
    Tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    WarehouseType string
    SQL warehouse type. See for AWS or Azure.
    AutoStopMins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    Channel GetSqlWarehouseChannel
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    CreatorName string
    The username of the user who created the endpoint.
    DataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    EnablePhoton bool
    Whether Photon is enabled.
    EnableServerlessCompute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    Health GetSqlWarehouseHealth
    Health status of the endpoint.
    Id string
    The ID of the SQL warehouse.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL warehouse is running.
    MinNumClusters int
    Minimum number of clusters available when a SQL warehouse is running.
    Name string
    Name of the SQL warehouse to search (case-sensitive).
    NumActiveSessions int
    The current number of clusters used by the endpoint.
    NumClusters int
    The current number of clusters used by the endpoint.
    OdbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    SpotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    State string
    The current state of the endpoint.
    Tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    WarehouseType string
    SQL warehouse type. See for AWS or Azure.
    autoStopMins Integer
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName String
    The username of the user who created the endpoint.
    dataSourceId String
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton Boolean
    Whether Photon is enabled.
    enableServerlessCompute Boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id String
    The ID of the SQL warehouse.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Integer
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters Integer
    Minimum number of clusters available when a SQL warehouse is running.
    name String
    Name of the SQL warehouse to search (case-sensitive).
    numActiveSessions Integer
    The current number of clusters used by the endpoint.
    numClusters Integer
    The current number of clusters used by the endpoint.
    odbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy String
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state String
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouseType String
    SQL warehouse type. See for AWS or Azure.
    autoStopMins number
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    clusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName string
    The username of the user who created the endpoint.
    dataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton boolean
    Whether Photon is enabled.
    enableServerlessCompute boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id string
    The ID of the SQL warehouse.
    instanceProfileArn string
    jdbcUrl string
    JDBC connection string.
    maxNumClusters number
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters number
    Minimum number of clusters available when a SQL warehouse is running.
    name string
    Name of the SQL warehouse to search (case-sensitive).
    numActiveSessions number
    The current number of clusters used by the endpoint.
    numClusters number
    The current number of clusters used by the endpoint.
    odbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state string
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouseType string
    SQL warehouse type. See for AWS or Azure.
    auto_stop_mins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    cluster_size str
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creator_name str
    The username of the user who created the endpoint.
    data_source_id str
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enable_photon bool
    Whether Photon is enabled.
    enable_serverless_compute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id str
    The ID of the SQL warehouse.
    instance_profile_arn str
    jdbc_url str
    JDBC connection string.
    max_num_clusters int
    Maximum number of clusters available when a SQL warehouse is running.
    min_num_clusters int
    Minimum number of clusters available when a SQL warehouse is running.
    name str
    Name of the SQL warehouse to search (case-sensitive).
    num_active_sessions int
    The current number of clusters used by the endpoint.
    num_clusters int
    The current number of clusters used by the endpoint.
    odbc_params GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spot_instance_policy str
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state str
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouse_type str
    SQL warehouse type. See for AWS or Azure.
    autoStopMins Number
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel Property Map
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName String
    The username of the user who created the endpoint.
    dataSourceId String
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton Boolean
    Whether Photon is enabled.
    enableServerlessCompute Boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health Property Map
    Health status of the endpoint.
    id String
    The ID of the SQL warehouse.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Number
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters Number
    Minimum number of clusters available when a SQL warehouse is running.
    name String
    Name of the SQL warehouse to search (case-sensitive).
    numActiveSessions Number
    The current number of clusters used by the endpoint.
    numClusters Number
    The current number of clusters used by the endpoint.
    odbcParams Property Map
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy String
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state String
    The current state of the endpoint.
    tags Property Map
    tags used for SQL warehouse resources.
    warehouseType String
    SQL warehouse type. See for AWS or Azure.

    getSqlWarehouse Result

    The following output properties are available:

    AutoStopMins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    Channel GetSqlWarehouseChannel
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    CreatorName string
    The username of the user who created the endpoint.
    DataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    EnablePhoton bool
    Whether Photon is enabled.
    EnableServerlessCompute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    Health GetSqlWarehouseHealth
    Health status of the endpoint.
    Id string
    The ID of the SQL warehouse.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL warehouse is running.
    MinNumClusters int
    Minimum number of clusters available when a SQL warehouse is running.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumActiveSessions int
    The current number of clusters used by the endpoint.
    NumClusters int
    The current number of clusters used by the endpoint.
    OdbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    SpotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    State string
    The current state of the endpoint.
    Tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    WarehouseType string
    SQL warehouse type. See for AWS or Azure.
    AutoStopMins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    Channel GetSqlWarehouseChannel
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    CreatorName string
    The username of the user who created the endpoint.
    DataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    EnablePhoton bool
    Whether Photon is enabled.
    EnableServerlessCompute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    Health GetSqlWarehouseHealth
    Health status of the endpoint.
    Id string
    The ID of the SQL warehouse.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL warehouse is running.
    MinNumClusters int
    Minimum number of clusters available when a SQL warehouse is running.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumActiveSessions int
    The current number of clusters used by the endpoint.
    NumClusters int
    The current number of clusters used by the endpoint.
    OdbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    SpotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    State string
    The current state of the endpoint.
    Tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    WarehouseType string
    SQL warehouse type. See for AWS or Azure.
    autoStopMins Integer
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName String
    The username of the user who created the endpoint.
    dataSourceId String
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton Boolean
    Whether Photon is enabled.
    enableServerlessCompute Boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id String
    The ID of the SQL warehouse.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Integer
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters Integer
    Minimum number of clusters available when a SQL warehouse is running.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numActiveSessions Integer
    The current number of clusters used by the endpoint.
    numClusters Integer
    The current number of clusters used by the endpoint.
    odbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy String
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state String
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouseType String
    SQL warehouse type. See for AWS or Azure.
    autoStopMins number
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    clusterSize string
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName string
    The username of the user who created the endpoint.
    dataSourceId string
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton boolean
    Whether Photon is enabled.
    enableServerlessCompute boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id string
    The ID of the SQL warehouse.
    instanceProfileArn string
    jdbcUrl string
    JDBC connection string.
    maxNumClusters number
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters number
    Minimum number of clusters available when a SQL warehouse is running.
    name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numActiveSessions number
    The current number of clusters used by the endpoint.
    numClusters number
    The current number of clusters used by the endpoint.
    odbcParams GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy string
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state string
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouseType string
    SQL warehouse type. See for AWS or Azure.
    auto_stop_mins int
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel GetSqlWarehouseChannel
    block, consisting of following fields:
    cluster_size str
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creator_name str
    The username of the user who created the endpoint.
    data_source_id str
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enable_photon bool
    Whether Photon is enabled.
    enable_serverless_compute bool
    Whether this SQL warehouse is a serverless SQL warehouse.
    health GetSqlWarehouseHealth
    Health status of the endpoint.
    id str
    The ID of the SQL warehouse.
    instance_profile_arn str
    jdbc_url str
    JDBC connection string.
    max_num_clusters int
    Maximum number of clusters available when a SQL warehouse is running.
    min_num_clusters int
    Minimum number of clusters available when a SQL warehouse is running.
    name str
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    num_active_sessions int
    The current number of clusters used by the endpoint.
    num_clusters int
    The current number of clusters used by the endpoint.
    odbc_params GetSqlWarehouseOdbcParams
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spot_instance_policy str
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state str
    The current state of the endpoint.
    tags GetSqlWarehouseTags
    tags used for SQL warehouse resources.
    warehouse_type str
    SQL warehouse type. See for AWS or Azure.
    autoStopMins Number
    Time in minutes until an idle SQL warehouse terminates all clusters and stops.
    channel Property Map
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    creatorName String
    The username of the user who created the endpoint.
    dataSourceId String
    ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
    enablePhoton Boolean
    Whether Photon is enabled.
    enableServerlessCompute Boolean
    Whether this SQL warehouse is a serverless SQL warehouse.
    health Property Map
    Health status of the endpoint.
    id String
    The ID of the SQL warehouse.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Number
    Maximum number of clusters available when a SQL warehouse is running.
    minNumClusters Number
    Minimum number of clusters available when a SQL warehouse is running.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numActiveSessions Number
    The current number of clusters used by the endpoint.
    numClusters Number
    The current number of clusters used by the endpoint.
    odbcParams Property Map
    ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
    spotInstancePolicy String
    The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
    state String
    The current state of the endpoint.
    tags Property Map
    tags used for SQL warehouse resources.
    warehouseType String
    SQL warehouse type. See for AWS or Azure.

    Supporting Types

    GetSqlWarehouseChannel

    DbsqlVersion string
    Name string
    Name of the SQL warehouse to search (case-sensitive).
    DbsqlVersion string
    Name string
    Name of the SQL warehouse to search (case-sensitive).
    dbsqlVersion String
    name String
    Name of the SQL warehouse to search (case-sensitive).
    dbsqlVersion string
    name string
    Name of the SQL warehouse to search (case-sensitive).
    dbsql_version str
    name str
    Name of the SQL warehouse to search (case-sensitive).
    dbsqlVersion String
    name String
    Name of the SQL warehouse to search (case-sensitive).

    GetSqlWarehouseHealth

    GetSqlWarehouseHealthFailureReason

    Code string
    Parameters Dictionary<string, string>
    Type string
    Code string
    Parameters map[string]string
    Type string
    code String
    parameters Map<String,String>
    type String
    code string
    parameters {[key: string]: string}
    type string
    code str
    parameters Mapping[str, str]
    type str
    code String
    parameters Map<String>
    type String

    GetSqlWarehouseOdbcParams

    Hostname string
    Path string
    Port int
    Protocol string
    Hostname string
    Path string
    Port int
    Protocol string
    hostname String
    path String
    port Integer
    protocol String
    hostname string
    path string
    port number
    protocol string
    hostname str
    path str
    port int
    protocol str
    hostname String
    path String
    port Number
    protocol String

    GetSqlWarehouseTags

    GetSqlWarehouseTagsCustomTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-databricks