Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. Connection
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.Connection

Explore with Pulumi AI

databricks logo
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

    This resource can only be used with a workspace-level provider!

    Lakehouse Federation is the query federation platform for Databricks. Databricks uses Unity Catalog to manage query federation. To make a dataset available for read-only querying using Lakehouse Federation, you create the following:

    • A connection, a securable object in Unity Catalog that specifies a path and credentials for accessing an external database system.
    • A foreign catalog

    This resource manages connections in Unity Catalog

    Example Usage

    Create a connection to a MySQL database

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

const mysql = new databricks.Connection("mysql", {
    name: "mysql_connection",
    connectionType: "MYSQL",
    comment: "this is a connection to mysql db",
    options: {
        host: "test.mysql.database.azure.com",
        port: "3306",
        user: "user",
        password: "password",
    },
    properties: {
        purpose: "testing",
    },
});

    import pulumi
import pulumi_databricks as databricks

mysql = databricks.Connection("mysql",
    name="mysql_connection",
    connection_type="MYSQL",
    comment="this is a connection to mysql db",
    options={
        "host": "test.mysql.database.azure.com",
        "port": "3306",
        "user": "user",
        "password": "password",
    },
    properties={
        "purpose": "testing",
    })

    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.NewConnection(ctx, "mysql", &databricks.ConnectionArgs{
			Name:           pulumi.String("mysql_connection"),
			ConnectionType: pulumi.String("MYSQL"),
			Comment:        pulumi.String("this is a connection to mysql db"),
			Options: pulumi.StringMap{
				"host":     pulumi.String("test.mysql.database.azure.com"),
				"port":     pulumi.String("3306"),
				"user":     pulumi.String("user"),
				"password": pulumi.String("password"),
			},
			Properties: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		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 mysql = new Databricks.Connection("mysql", new()
    {
        Name = "mysql_connection",
        ConnectionType = "MYSQL",
        Comment = "this is a connection to mysql db",
        Options = 
        {
            { "host", "test.mysql.database.azure.com" },
            { "port", "3306" },
            { "user", "user" },
            { "password", "password" },
        },
        Properties = 
        {
            { "purpose", "testing" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
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) {
        var mysql = new Connection("mysql", ConnectionArgs.builder()
            .name("mysql_connection")
            .connectionType("MYSQL")
            .comment("this is a connection to mysql db")
            .options(Map.ofEntries(
                Map.entry("host", "test.mysql.database.azure.com"),
                Map.entry("port", "3306"),
                Map.entry("user", "user"),
                Map.entry("password", "password")
            ))
            .properties(Map.of("purpose", "testing"))
            .build());

    }
}

    resources:
  mysql:
    type: databricks:Connection
    properties:
      name: mysql_connection
      connectionType: MYSQL
      comment: this is a connection to mysql db
      options:
        host: test.mysql.database.azure.com
        port: '3306'
        user: user
        password: password
      properties:
        purpose: testing

    Create a connection to a BigQuery database

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

const bigquery = new databricks.Connection("bigquery", {
    name: "bq_connection",
    connectionType: "BIGQUERY",
    comment: "this is a connection to BQ",
    options: {
        GoogleServiceAccountKeyJson: JSON.stringify({
            type: "service_account",
            project_id: "PROJECT_ID",
            private_key_id: "KEY_ID",
            private_key: `-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
`,
            client_email: "SERVICE_ACCOUNT_EMAIL",
            client_id: "CLIENT_ID",
            auth_uri: "https://accounts.google.com/o/oauth2/auth",
            token_uri: "https://accounts.google.com/o/oauth2/token",
            auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
            client_x509_cert_url: "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
            universe_domain: "googleapis.com",
        }),
    },
    properties: {
        purpose: "testing",
    },
});

    import pulumi
import json
import pulumi_databricks as databricks

bigquery = databricks.Connection("bigquery",
    name="bq_connection",
    connection_type="BIGQUERY",
    comment="this is a connection to BQ",
    options={
        "GoogleServiceAccountKeyJson": json.dumps({
            "type": "service_account",
            "project_id": "PROJECT_ID",
            "private_key_id": "KEY_ID",
            "private_key": """-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
""",
            "client_email": "SERVICE_ACCOUNT_EMAIL",
            "client_id": "CLIENT_ID",
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": "https://accounts.google.com/o/oauth2/token",
            "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
            "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
            "universe_domain": "googleapis.com",
        }),
    },
    properties={
        "purpose": "testing",
    })

    package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"type":                        "service_account",
			"project_id":                  "PROJECT_ID",
			"private_key_id":              "KEY_ID",
			"private_key":                 "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n",
			"client_email":                "SERVICE_ACCOUNT_EMAIL",
			"client_id":                   "CLIENT_ID",
			"auth_uri":                    "https://accounts.google.com/o/oauth2/auth",
			"token_uri":                   "https://accounts.google.com/o/oauth2/token",
			"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
			"client_x509_cert_url":        "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
			"universe_domain":             "googleapis.com",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = databricks.NewConnection(ctx, "bigquery", &databricks.ConnectionArgs{
			Name:           pulumi.String("bq_connection"),
			ConnectionType: pulumi.String("BIGQUERY"),
			Comment:        pulumi.String("this is a connection to BQ"),
			Options: pulumi.StringMap{
				"GoogleServiceAccountKeyJson": pulumi.String(json0),
			},
			Properties: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var bigquery = new Databricks.Connection("bigquery", new()
    {
        Name = "bq_connection",
        ConnectionType = "BIGQUERY",
        Comment = "this is a connection to BQ",
        Options = 
        {
            { "GoogleServiceAccountKeyJson", JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["type"] = "service_account",
                ["project_id"] = "PROJECT_ID",
                ["private_key_id"] = "KEY_ID",
                ["private_key"] = @"-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
",
                ["client_email"] = "SERVICE_ACCOUNT_EMAIL",
                ["client_id"] = "CLIENT_ID",
                ["auth_uri"] = "https://accounts.google.com/o/oauth2/auth",
                ["token_uri"] = "https://accounts.google.com/o/oauth2/token",
                ["auth_provider_x509_cert_url"] = "https://www.googleapis.com/oauth2/v1/certs",
                ["client_x509_cert_url"] = "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
                ["universe_domain"] = "googleapis.com",
            }) },
        },
        Properties = 
        {
            { "purpose", "testing" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        var bigquery = new Connection("bigquery", ConnectionArgs.builder()
            .name("bq_connection")
            .connectionType("BIGQUERY")
            .comment("this is a connection to BQ")
            .options(Map.of("GoogleServiceAccountKeyJson", serializeJson(
                jsonObject(
                    jsonProperty("type", "service_account"),
                    jsonProperty("project_id", "PROJECT_ID"),
                    jsonProperty("private_key_id", "KEY_ID"),
                    jsonProperty("private_key", """
-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
                    """),
                    jsonProperty("client_email", "SERVICE_ACCOUNT_EMAIL"),
                    jsonProperty("client_id", "CLIENT_ID"),
                    jsonProperty("auth_uri", "https://accounts.google.com/o/oauth2/auth"),
                    jsonProperty("token_uri", "https://accounts.google.com/o/oauth2/token"),
                    jsonProperty("auth_provider_x509_cert_url", "https://www.googleapis.com/oauth2/v1/certs"),
                    jsonProperty("client_x509_cert_url", "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL"),
                    jsonProperty("universe_domain", "googleapis.com")
                ))))
            .properties(Map.of("purpose", "testing"))
            .build());

    }
}

    resources:
  bigquery:
    type: databricks:Connection
    properties:
      name: bq_connection
      connectionType: BIGQUERY
      comment: this is a connection to BQ
      options:
        GoogleServiceAccountKeyJson:
          fn::toJSON:
            type: service_account
            project_id: PROJECT_ID
            private_key_id: KEY_ID
            private_key: |
              -----BEGIN PRIVATE KEY-----
              PRIVATE_KEY
              -----END PRIVATE KEY-----              
            client_email: SERVICE_ACCOUNT_EMAIL
            client_id: CLIENT_ID
            auth_uri: https://accounts.google.com/o/oauth2/auth
            token_uri: https://accounts.google.com/o/oauth2/token
            auth_provider_x509_cert_url: https://www.googleapis.com/oauth2/v1/certs
            client_x509_cert_url: https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL
            universe_domain: googleapis.com
      properties:
        purpose: testing

    Create a connection to builtin Hive Metastore

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

const _this = new databricks.Connection("this", {
    name: "hms-builtin",
    connectionType: "HIVE_METASTORE",
    comment: "This is a connection to builtin HMS",
    options: {
        builtin: "true",
    },
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.Connection("this",
    name="hms-builtin",
    connection_type="HIVE_METASTORE",
    comment="This is a connection to builtin HMS",
    options={
        "builtin": "true",
    })

    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.NewConnection(ctx, "this", &databricks.ConnectionArgs{
			Name:           pulumi.String("hms-builtin"),
			ConnectionType: pulumi.String("HIVE_METASTORE"),
			Comment:        pulumi.String("This is a connection to builtin HMS"),
			Options: pulumi.StringMap{
				"builtin": pulumi.String("true"),
			},
		})
		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 @this = new Databricks.Connection("this", new()
    {
        Name = "hms-builtin",
        ConnectionType = "HIVE_METASTORE",
        Comment = "This is a connection to builtin HMS",
        Options = 
        {
            { "builtin", "true" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
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) {
        var this_ = new Connection("this", ConnectionArgs.builder()
            .name("hms-builtin")
            .connectionType("HIVE_METASTORE")
            .comment("This is a connection to builtin HMS")
            .options(Map.of("builtin", "true"))
            .build());

    }
}

    resources:
  this:
    type: databricks:Connection
    properties:
      name: hms-builtin
      connectionType: HIVE_METASTORE
      comment: This is a connection to builtin HMS
      options:
        builtin: 'true'

    Create Connection Resource

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

    Constructor syntax

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

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               comment: Optional[str] = None,
               connection_type: Optional[str] = None,
               name: Optional[str] = None,
               options: Optional[Mapping[str, str]] = None,
               owner: Optional[str] = None,
               properties: Optional[Mapping[str, str]] = None,
               read_only: Optional[bool] = None)
    func NewConnection(ctx *Context, name string, args *ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs? args = null, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

    type: databricks:Connection
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 ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    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 connectionResource = new Databricks.Connection("connectionResource", new()
{
    Comment = "string",
    ConnectionType = "string",
    Name = "string",
    Options = 
    {
        { "string", "string" },
    },
    Owner = "string",
    Properties = 
    {
        { "string", "string" },
    },
    ReadOnly = false,
});

    example, err := databricks.NewConnection(ctx, "connectionResource", &databricks.ConnectionArgs{
	Comment:        pulumi.String("string"),
	ConnectionType: pulumi.String("string"),
	Name:           pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Owner: pulumi.String("string"),
	Properties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ReadOnly: pulumi.Bool(false),
})

    var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
    .comment("string")
    .connectionType("string")
    .name("string")
    .options(Map.of("string", "string"))
    .owner("string")
    .properties(Map.of("string", "string"))
    .readOnly(false)
    .build());

    connection_resource = databricks.Connection("connectionResource",
    comment="string",
    connection_type="string",
    name="string",
    options={
        "string": "string",
    },
    owner="string",
    properties={
        "string": "string",
    },
    read_only=False)

    const connectionResource = new databricks.Connection("connectionResource", {
    comment: "string",
    connectionType: "string",
    name: "string",
    options: {
        string: "string",
    },
    owner: "string",
    properties: {
        string: "string",
    },
    readOnly: false,
});

    type: databricks:Connection
properties:
    comment: string
    connectionType: string
    name: string
    options:
        string: string
    owner: string
    properties:
        string: string
    readOnly: false

    Connection 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 Connection resource accepts the following input properties:

    Comment string
    Free-form text.
    ConnectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    Name string
    Name of the Connection.
    Options Dictionary<string, string>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    Owner string
    Name of the connection owner.
    Properties Dictionary<string, string>
    Free-form connection properties.
    ReadOnly bool
    Comment string
    Free-form text.
    ConnectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    Name string
    Name of the Connection.
    Options map[string]string
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    Owner string
    Name of the connection owner.
    Properties map[string]string
    Free-form connection properties.
    ReadOnly bool
    comment String
    Free-form text.
    connectionType String
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    name String
    Name of the Connection.
    options Map<String,String>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner String
    Name of the connection owner.
    properties Map<String,String>
    Free-form connection properties.
    readOnly Boolean
    comment string
    Free-form text.
    connectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    name string
    Name of the Connection.
    options {[key: string]: string}
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner string
    Name of the connection owner.
    properties {[key: string]: string}
    Free-form connection properties.
    readOnly boolean
    comment str
    Free-form text.
    connection_type str
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    name str
    Name of the Connection.
    options Mapping[str, str]
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner str
    Name of the connection owner.
    properties Mapping[str, str]
    Free-form connection properties.
    read_only bool
    comment String
    Free-form text.
    connectionType String
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    name String
    Name of the Connection.
    options Map<String>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner String
    Name of the connection owner.
    properties Map<String>
    Free-form connection properties.
    readOnly Boolean

    Outputs

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

    ConnectionId string
    Unique ID of the connection.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential for this connection.
    FullName string
    Full name of connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    Unique ID of the UC metastore for this connection.
    ProvisioningInfos List<ConnectionProvisioningInfo>
    Object with the status of an asynchronously provisioned resource.
    SecurableType string
    UpdatedAt int
    Time at which connection this was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified the connection.
    Url string
    URL of the remote data source, extracted from options.
    ConnectionId string
    Unique ID of the connection.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential for this connection.
    FullName string
    Full name of connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    Unique ID of the UC metastore for this connection.
    ProvisioningInfos []ConnectionProvisioningInfo
    Object with the status of an asynchronously provisioned resource.
    SecurableType string
    UpdatedAt int
    Time at which connection this was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified the connection.
    Url string
    URL of the remote data source, extracted from options.
    connectionId String
    Unique ID of the connection.
    createdAt Integer
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential for this connection.
    fullName String
    Full name of connection.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String
    Unique ID of the UC metastore for this connection.
    provisioningInfos List<ConnectionProvisioningInfo>
    Object with the status of an asynchronously provisioned resource.
    securableType String
    updatedAt Integer
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified the connection.
    url String
    URL of the remote data source, extracted from options.
    connectionId string
    Unique ID of the connection.
    createdAt number
    Time at which this connection was created, in epoch milliseconds.
    createdBy string
    Username of connection creator.
    credentialType string
    The type of credential for this connection.
    fullName string
    Full name of connection.
    id string
    The provider-assigned unique ID for this managed resource.
    metastoreId string
    Unique ID of the UC metastore for this connection.
    provisioningInfos ConnectionProvisioningInfo[]
    Object with the status of an asynchronously provisioned resource.
    securableType string
    updatedAt number
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy string
    Username of user who last modified the connection.
    url string
    URL of the remote data source, extracted from options.
    connection_id str
    Unique ID of the connection.
    created_at int
    Time at which this connection was created, in epoch milliseconds.
    created_by str
    Username of connection creator.
    credential_type str
    The type of credential for this connection.
    full_name str
    Full name of connection.
    id str
    The provider-assigned unique ID for this managed resource.
    metastore_id str
    Unique ID of the UC metastore for this connection.
    provisioning_infos Sequence[ConnectionProvisioningInfo]
    Object with the status of an asynchronously provisioned resource.
    securable_type str
    updated_at int
    Time at which connection this was last modified, in epoch milliseconds.
    updated_by str
    Username of user who last modified the connection.
    url str
    URL of the remote data source, extracted from options.
    connectionId String
    Unique ID of the connection.
    createdAt Number
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential for this connection.
    fullName String
    Full name of connection.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String
    Unique ID of the UC metastore for this connection.
    provisioningInfos List<Property Map>
    Object with the status of an asynchronously provisioned resource.
    securableType String
    updatedAt Number
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified the connection.
    url String
    URL of the remote data source, extracted from options.

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        connection_id: Optional[str] = None,
        connection_type: Optional[str] = None,
        created_at: Optional[int] = None,
        created_by: Optional[str] = None,
        credential_type: Optional[str] = None,
        full_name: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        provisioning_infos: Optional[Sequence[ConnectionProvisioningInfoArgs]] = None,
        read_only: Optional[bool] = None,
        securable_type: Optional[str] = None,
        updated_at: Optional[int] = None,
        updated_by: Optional[str] = None,
        url: Optional[str] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Connection    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:
    Comment string
    Free-form text.
    ConnectionId string
    Unique ID of the connection.
    ConnectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential for this connection.
    FullName string
    Full name of connection.
    MetastoreId string
    Unique ID of the UC metastore for this connection.
    Name string
    Name of the Connection.
    Options Dictionary<string, string>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    Owner string
    Name of the connection owner.
    Properties Dictionary<string, string>
    Free-form connection properties.
    ProvisioningInfos List<ConnectionProvisioningInfo>
    Object with the status of an asynchronously provisioned resource.
    ReadOnly bool
    SecurableType string
    UpdatedAt int
    Time at which connection this was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified the connection.
    Url string
    URL of the remote data source, extracted from options.
    Comment string
    Free-form text.
    ConnectionId string
    Unique ID of the connection.
    ConnectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential for this connection.
    FullName string
    Full name of connection.
    MetastoreId string
    Unique ID of the UC metastore for this connection.
    Name string
    Name of the Connection.
    Options map[string]string
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    Owner string
    Name of the connection owner.
    Properties map[string]string
    Free-form connection properties.
    ProvisioningInfos []ConnectionProvisioningInfoArgs
    Object with the status of an asynchronously provisioned resource.
    ReadOnly bool
    SecurableType string
    UpdatedAt int
    Time at which connection this was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified the connection.
    Url string
    URL of the remote data source, extracted from options.
    comment String
    Free-form text.
    connectionId String
    Unique ID of the connection.
    connectionType String
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    createdAt Integer
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential for this connection.
    fullName String
    Full name of connection.
    metastoreId String
    Unique ID of the UC metastore for this connection.
    name String
    Name of the Connection.
    options Map<String,String>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner String
    Name of the connection owner.
    properties Map<String,String>
    Free-form connection properties.
    provisioningInfos List<ConnectionProvisioningInfo>
    Object with the status of an asynchronously provisioned resource.
    readOnly Boolean
    securableType String
    updatedAt Integer
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified the connection.
    url String
    URL of the remote data source, extracted from options.
    comment string
    Free-form text.
    connectionId string
    Unique ID of the connection.
    connectionType string
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    createdAt number
    Time at which this connection was created, in epoch milliseconds.
    createdBy string
    Username of connection creator.
    credentialType string
    The type of credential for this connection.
    fullName string
    Full name of connection.
    metastoreId string
    Unique ID of the UC metastore for this connection.
    name string
    Name of the Connection.
    options {[key: string]: string}
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner string
    Name of the connection owner.
    properties {[key: string]: string}
    Free-form connection properties.
    provisioningInfos ConnectionProvisioningInfo[]
    Object with the status of an asynchronously provisioned resource.
    readOnly boolean
    securableType string
    updatedAt number
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy string
    Username of user who last modified the connection.
    url string
    URL of the remote data source, extracted from options.
    comment str
    Free-form text.
    connection_id str
    Unique ID of the connection.
    connection_type str
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    created_at int
    Time at which this connection was created, in epoch milliseconds.
    created_by str
    Username of connection creator.
    credential_type str
    The type of credential for this connection.
    full_name str
    Full name of connection.
    metastore_id str
    Unique ID of the UC metastore for this connection.
    name str
    Name of the Connection.
    options Mapping[str, str]
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner str
    Name of the connection owner.
    properties Mapping[str, str]
    Free-form connection properties.
    provisioning_infos Sequence[ConnectionProvisioningInfoArgs]
    Object with the status of an asynchronously provisioned resource.
    read_only bool
    securable_type str
    updated_at int
    Time at which connection this was last modified, in epoch milliseconds.
    updated_by str
    Username of user who last modified the connection.
    url str
    URL of the remote data source, extracted from options.
    comment String
    Free-form text.
    connectionId String
    Unique ID of the connection.
    connectionType String
    Connection type. BIGQUERY MYSQL POSTGRESQL SNOWFLAKE REDSHIFT SQLDW SQLSERVER, SALESFORCE, HIVE_METASTORE, GLUE, TERADATA, ORACLE or DATABRICKS are supported. Up-to-date list of connection type supported is in the documentation
    createdAt Number
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential for this connection.
    fullName String
    Full name of connection.
    metastoreId String
    Unique ID of the UC metastore for this connection.
    name String
    Name of the Connection.
    options Map<String>
    The key value of options required by the connection, e.g. host, port, user, password or GoogleServiceAccountKeyJson. Please consult the documentation for the required option.
    owner String
    Name of the connection owner.
    properties Map<String>
    Free-form connection properties.
    provisioningInfos List<Property Map>
    Object with the status of an asynchronously provisioned resource.
    readOnly Boolean
    securableType String
    updatedAt Number
    Time at which connection this was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified the connection.
    url String
    URL of the remote data source, extracted from options.

    Supporting Types

    ConnectionProvisioningInfo, ConnectionProvisioningInfoArgs

    State string
    State string
    state String
    state string
    state str
    state String

    Import

    This resource can be imported by id:

    bash

    $ pulumi import databricks:index/connection:Connection this '<metastore_id>|<name>'

    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
    Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-databricks