1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. SqlEndpoint
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

databricks.SqlEndpoint

databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

    This resource is used to manage Databricks SQL Endpoints. To create SQL endpoints you must have databricks_sql_access on your databricks.Group or databricks_user.

    Access Control

    • databricks.Permissions can control which groups or individual users can Can Use or Can Manage SQL endpoints.
    • databricks_sql_access on databricks.Group or databricks_user.

    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.SqlEndpoint of workspace.
    • databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

    Example Usage

    using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var me = Output.Create(Databricks.GetCurrentUser.InvokeAsync());
        var @this = new Databricks.SqlEndpoint("this", new Databricks.SqlEndpointArgs
        {
            ClusterSize = "Small",
            MaxNumClusters = 1,
            Tags = new Databricks.Inputs.SqlEndpointTagsArgs
            {
                CustomTags = 
                {
                    new Databricks.Inputs.SqlEndpointTagsCustomTagArgs
                    {
                        Key = "City",
                        Value = "Amsterdam",
                    },
                },
            },
        });
    }

}

    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.GetCurrentUser(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = databricks.NewSqlEndpoint(ctx, "this", &databricks.SqlEndpointArgs{
			ClusterSize:    pulumi.String("Small"),
			MaxNumClusters: pulumi.Int(1),
			Tags: &SqlEndpointTagsArgs{
				CustomTags: SqlEndpointTagsCustomTagArray{
					&SqlEndpointTagsCustomTagArgs{
						Key:   pulumi.String("City"),
						Value: pulumi.String("Amsterdam"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const me = pulumi.output(databricks.getCurrentUser());
const thisSqlEndpoint = new databricks.SqlEndpoint("this", {
    clusterSize: "Small",
    maxNumClusters: 1,
    tags: {
        customTags: [{
            key: "City",
            value: "Amsterdam",
        }],
    },
});

    import pulumi
import pulumi_databricks as databricks

me = databricks.get_current_user()
this = databricks.SqlEndpoint("this",
    cluster_size="Small",
    max_num_clusters=1,
    tags=databricks.SqlEndpointTagsArgs(
        custom_tags=[databricks.SqlEndpointTagsCustomTagArgs(
            key="City",
            value="Amsterdam",
        )],
    ))

    Example coming soon!

    Create SqlEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SqlEndpoint(name: string, args: SqlEndpointArgs, opts?: CustomResourceOptions);
    @overload
def SqlEndpoint(resource_name: str,
                args: SqlEndpointArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SqlEndpoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_size: Optional[str] = None,
                max_num_clusters: Optional[int] = None,
                num_clusters: Optional[int] = None,
                data_source_id: Optional[str] = None,
                enable_photon: Optional[bool] = None,
                enable_serverless_compute: Optional[bool] = None,
                instance_profile_arn: Optional[str] = None,
                channel: Optional[SqlEndpointChannelArgs] = None,
                min_num_clusters: Optional[int] = None,
                jdbc_url: Optional[str] = None,
                name: Optional[str] = None,
                auto_stop_mins: Optional[int] = None,
                odbc_params: Optional[SqlEndpointOdbcParamsArgs] = None,
                spot_instance_policy: Optional[str] = None,
                state: Optional[str] = None,
                tags: Optional[SqlEndpointTagsArgs] = None)
    func NewSqlEndpoint(ctx *Context, name string, args SqlEndpointArgs, opts ...ResourceOption) (*SqlEndpoint, error)
    public SqlEndpoint(string name, SqlEndpointArgs args, CustomResourceOptions? opts = null)
    public SqlEndpoint(String name, SqlEndpointArgs args)
public SqlEndpoint(String name, SqlEndpointArgs args, CustomResourceOptions options)

    type: databricks:SqlEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sqlEndpointResource = new Databricks.SqlEndpoint("sqlEndpointResource", new()
{
    ClusterSize = "string",
    MaxNumClusters = 0,
    NumClusters = 0,
    DataSourceId = "string",
    EnablePhoton = false,
    EnableServerlessCompute = false,
    InstanceProfileArn = "string",
    Channel = new Databricks.Inputs.SqlEndpointChannelArgs
    {
        Name = "string",
    },
    MinNumClusters = 0,
    JdbcUrl = "string",
    Name = "string",
    AutoStopMins = 0,
    OdbcParams = new Databricks.Inputs.SqlEndpointOdbcParamsArgs
    {
        Path = "string",
        Port = 0,
        Protocol = "string",
        Host = "string",
        Hostname = "string",
    },
    SpotInstancePolicy = "string",
    State = "string",
    Tags = new Databricks.Inputs.SqlEndpointTagsArgs
    {
        CustomTags = new[]
        {
            new Databricks.Inputs.SqlEndpointTagsCustomTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    },
});

    example, err := databricks.NewSqlEndpoint(ctx, "sqlEndpointResource", &databricks.SqlEndpointArgs{
	ClusterSize:             pulumi.String("string"),
	MaxNumClusters:          pulumi.Int(0),
	NumClusters:             pulumi.Int(0),
	DataSourceId:            pulumi.String("string"),
	EnablePhoton:            pulumi.Bool(false),
	EnableServerlessCompute: pulumi.Bool(false),
	InstanceProfileArn:      pulumi.String("string"),
	Channel: &databricks.SqlEndpointChannelArgs{
		Name: pulumi.String("string"),
	},
	MinNumClusters: pulumi.Int(0),
	JdbcUrl:        pulumi.String("string"),
	Name:           pulumi.String("string"),
	AutoStopMins:   pulumi.Int(0),
	OdbcParams: &databricks.SqlEndpointOdbcParamsArgs{
		Path:     pulumi.String("string"),
		Port:     pulumi.Int(0),
		Protocol: pulumi.String("string"),
		Host:     pulumi.String("string"),
		Hostname: pulumi.String("string"),
	},
	SpotInstancePolicy: pulumi.String("string"),
	State:              pulumi.String("string"),
	Tags: &databricks.SqlEndpointTagsArgs{
		CustomTags: databricks.SqlEndpointTagsCustomTagArray{
			&databricks.SqlEndpointTagsCustomTagArgs{
				Key:   pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
	},
})

    var sqlEndpointResource = new SqlEndpoint("sqlEndpointResource", SqlEndpointArgs.builder()
    .clusterSize("string")
    .maxNumClusters(0)
    .numClusters(0)
    .dataSourceId("string")
    .enablePhoton(false)
    .enableServerlessCompute(false)
    .instanceProfileArn("string")
    .channel(SqlEndpointChannelArgs.builder()
        .name("string")
        .build())
    .minNumClusters(0)
    .jdbcUrl("string")
    .name("string")
    .autoStopMins(0)
    .odbcParams(SqlEndpointOdbcParamsArgs.builder()
        .path("string")
        .port(0)
        .protocol("string")
        .host("string")
        .hostname("string")
        .build())
    .spotInstancePolicy("string")
    .state("string")
    .tags(SqlEndpointTagsArgs.builder()
        .customTags(SqlEndpointTagsCustomTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build())
    .build());

    sql_endpoint_resource = databricks.SqlEndpoint("sqlEndpointResource",
    cluster_size="string",
    max_num_clusters=0,
    num_clusters=0,
    data_source_id="string",
    enable_photon=False,
    enable_serverless_compute=False,
    instance_profile_arn="string",
    channel={
        "name": "string",
    },
    min_num_clusters=0,
    jdbc_url="string",
    name="string",
    auto_stop_mins=0,
    odbc_params={
        "path": "string",
        "port": 0,
        "protocol": "string",
        "host": "string",
        "hostname": "string",
    },
    spot_instance_policy="string",
    state="string",
    tags={
        "custom_tags": [{
            "key": "string",
            "value": "string",
        }],
    })

    const sqlEndpointResource = new databricks.SqlEndpoint("sqlEndpointResource", {
    clusterSize: "string",
    maxNumClusters: 0,
    numClusters: 0,
    dataSourceId: "string",
    enablePhoton: false,
    enableServerlessCompute: false,
    instanceProfileArn: "string",
    channel: {
        name: "string",
    },
    minNumClusters: 0,
    jdbcUrl: "string",
    name: "string",
    autoStopMins: 0,
    odbcParams: {
        path: "string",
        port: 0,
        protocol: "string",
        host: "string",
        hostname: "string",
    },
    spotInstancePolicy: "string",
    state: "string",
    tags: {
        customTags: [{
            key: "string",
            value: "string",
        }],
    },
});

    type: databricks:SqlEndpoint
properties:
    autoStopMins: 0
    channel:
        name: string
    clusterSize: string
    dataSourceId: string
    enablePhoton: false
    enableServerlessCompute: false
    instanceProfileArn: string
    jdbcUrl: string
    maxNumClusters: 0
    minNumClusters: 0
    name: string
    numClusters: 0
    odbcParams:
        host: string
        hostname: string
        path: string
        port: 0
        protocol: string
    spotInstancePolicy: string
    state: string
    tags:
        customTags:
            - key: string
              value: string

    SqlEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SqlEndpoint resource accepts the following input properties:

    ClusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    AutoStopMins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    Channel SqlEndpointChannel
    block, consisting of following fields:
    DataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    EnablePhoton bool
    Whether to enable Photon. This field is optional and is enabled by default.
    EnableServerlessCompute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    MinNumClusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumClusters int
    OdbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    State string
    Tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    ClusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    AutoStopMins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    Channel SqlEndpointChannelArgs
    block, consisting of following fields:
    DataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    EnablePhoton bool
    Whether to enable Photon. This field is optional and is enabled by default.
    EnableServerlessCompute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    MinNumClusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumClusters int
    OdbcParams SqlEndpointOdbcParamsArgs
    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. This field is optional. Default is COST_OPTIMIZED.
    State string
    Tags SqlEndpointTagsArgs
    Databricks tags all endpoint resources with these tags.
    clusterSize String
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    autoStopMins Integer
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannel
    block, consisting of following fields:
    dataSourceId String
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton Boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute Boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Integer
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters Integer
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters Integer
    odbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    state String
    tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    clusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    autoStopMins number
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannel
    block, consisting of following fields:
    dataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn string
    jdbcUrl string
    JDBC connection string.
    maxNumClusters number
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters number
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters number
    odbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    state string
    tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    cluster_size str
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    auto_stop_mins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannelArgs
    block, consisting of following fields:
    data_source_id str
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enable_photon bool
    Whether to enable Photon. This field is optional and is enabled by default.
    enable_serverless_compute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instance_profile_arn str
    jdbc_url str
    JDBC connection string.
    max_num_clusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    min_num_clusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    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_clusters int
    odbc_params SqlEndpointOdbcParamsArgs
    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. This field is optional. Default is COST_OPTIMIZED.
    state str
    tags SqlEndpointTagsArgs
    Databricks tags all endpoint resources with these tags.
    clusterSize String
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    autoStopMins Number
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel Property Map
    block, consisting of following fields:
    dataSourceId String
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton Boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute Boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Number
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters Number
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters Number
    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. This field is optional. Default is COST_OPTIMIZED.
    state String
    tags Property Map
    Databricks tags all endpoint resources with these tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlEndpoint Resource

    Get an existing SqlEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SqlEndpointState, opts?: CustomResourceOptions): SqlEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_stop_mins: Optional[int] = None,
        channel: Optional[SqlEndpointChannelArgs] = None,
        cluster_size: Optional[str] = None,
        data_source_id: Optional[str] = None,
        enable_photon: Optional[bool] = None,
        enable_serverless_compute: Optional[bool] = 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_clusters: Optional[int] = None,
        odbc_params: Optional[SqlEndpointOdbcParamsArgs] = None,
        spot_instance_policy: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[SqlEndpointTagsArgs] = None) -> SqlEndpoint
    func GetSqlEndpoint(ctx *Context, name string, id IDInput, state *SqlEndpointState, opts ...ResourceOption) (*SqlEndpoint, error)
    public static SqlEndpoint Get(string name, Input<string> id, SqlEndpointState? state, CustomResourceOptions? opts = null)
    public static SqlEndpoint get(String name, Output<String> id, SqlEndpointState state, CustomResourceOptions options)
    resources:  _:    type: databricks:SqlEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoStopMins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    Channel SqlEndpointChannel
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    DataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    EnablePhoton bool
    Whether to enable Photon. This field is optional and is enabled by default.
    EnableServerlessCompute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    MinNumClusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumClusters int
    OdbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    State string
    Tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    AutoStopMins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    Channel SqlEndpointChannelArgs
    block, consisting of following fields:
    ClusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    DataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    EnablePhoton bool
    Whether to enable Photon. This field is optional and is enabled by default.
    EnableServerlessCompute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    InstanceProfileArn string
    JdbcUrl string
    JDBC connection string.
    MaxNumClusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    MinNumClusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    NumClusters int
    OdbcParams SqlEndpointOdbcParamsArgs
    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. This field is optional. Default is COST_OPTIMIZED.
    State string
    Tags SqlEndpointTagsArgs
    Databricks tags all endpoint resources with these tags.
    autoStopMins Integer
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannel
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    dataSourceId String
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton Boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute Boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Integer
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters Integer
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters Integer
    odbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    state String
    tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    autoStopMins number
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannel
    block, consisting of following fields:
    clusterSize string
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    dataSourceId string
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn string
    jdbcUrl string
    JDBC connection string.
    maxNumClusters number
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters number
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters number
    odbcParams SqlEndpointOdbcParams
    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. This field is optional. Default is COST_OPTIMIZED.
    state string
    tags SqlEndpointTags
    Databricks tags all endpoint resources with these tags.
    auto_stop_mins int
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel SqlEndpointChannelArgs
    block, consisting of following fields:
    cluster_size str
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    data_source_id str
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enable_photon bool
    Whether to enable Photon. This field is optional and is enabled by default.
    enable_serverless_compute bool
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instance_profile_arn str
    jdbc_url str
    JDBC connection string.
    max_num_clusters int
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    min_num_clusters int
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    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_clusters int
    odbc_params SqlEndpointOdbcParamsArgs
    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. This field is optional. Default is COST_OPTIMIZED.
    state str
    tags SqlEndpointTagsArgs
    Databricks tags all endpoint resources with these tags.
    autoStopMins Number
    Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 120, set to 0 to disable the auto stop.
    channel Property Map
    block, consisting of following fields:
    clusterSize String
    The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
    dataSourceId String
    ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
    enablePhoton Boolean
    Whether to enable Photon. This field is optional and is enabled by default.
    enableServerlessCompute Boolean
    Whether this SQL endpoint is a Serverless endpoint. To use a Serverless SQL endpoint, you must enable Serverless SQL endpoints for the workspace.
    instanceProfileArn String
    jdbcUrl String
    JDBC connection string.
    maxNumClusters Number
    Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to 1.
    minNumClusters Number
    Minimum number of clusters available when a SQL endpoint is running. The default is 1.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    numClusters Number
    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. This field is optional. Default is COST_OPTIMIZED.
    state String
    tags Property Map
    Databricks tags all endpoint resources with these tags.

    Supporting Types

    SqlEndpointChannel, SqlEndpointChannelArgs

    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    Name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    name string
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    name str
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
    name String
    Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

    SqlEndpointOdbcParams, SqlEndpointOdbcParamsArgs

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

    SqlEndpointTags, SqlEndpointTagsArgs

    SqlEndpointTagsCustomTag, SqlEndpointTagsCustomTagArgs

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

    Import

    You can import a databricks_sql_endpoint resource with ID like the followingbash

     $ pulumi import databricks:index/sqlEndpoint:SqlEndpoint this <endpoint-id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.