1. Packages
  2. dbt Cloud
  3. API Docs
  4. Connection
dbt Cloud v0.1.8 published on Tuesday, Jun 11, 2024 by Pulumi

dbtcloud.Connection

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v0.1.8 published on Tuesday, Jun 11, 2024 by Pulumi

    Create a Data Warehouse connection for your project in dbt Cloud. The connection will need to be linked to the dbt Cloud project via a dbtcloud.ProjectConnection resource.

    This resource can be used for Databricks, Postgres, Redshift, Snowflake and AlloyDB connections. For BigQuery, due to the list of fields being very different, you can use the dbtcloud.BigQueryConnection resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    const databricks = new dbtcloud.Connection("databricks", {
        projectId: dbtProject.id,
        type: "adapter",
        name: "Databricks",
        database: "",
        hostName: "my-databricks-host.cloud.databricks.com",
        httpPath: "/my/path",
        catalog: "moo",
        oauthClientId: "yourclientid",
        oauthClientSecret: "yourclientsecret",
    });
    const redshift = new dbtcloud.Connection("redshift", {
        projectId: dbtProject.id,
        type: "redshift",
        name: "My Redshift Warehouse",
        database: "my-database",
        port: 5439,
        hostName: "my-redshift-hostname",
    });
    const snowflake = new dbtcloud.Connection("snowflake", {
        projectId: dbtProject.id,
        type: "snowflake",
        name: "My Snowflake warehouse",
        account: "my-snowflake-account",
        database: "MY_DATABASE",
        role: "MY_ROLE",
        warehouse: "MY_WAREHOUSE",
        oauthClientId: "yourclientid",
        oauthClientSecret: "yourclientsecret",
        allowSso: true,
    });
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    databricks = dbtcloud.Connection("databricks",
        project_id=dbt_project["id"],
        type="adapter",
        name="Databricks",
        database="",
        host_name="my-databricks-host.cloud.databricks.com",
        http_path="/my/path",
        catalog="moo",
        oauth_client_id="yourclientid",
        oauth_client_secret="yourclientsecret")
    redshift = dbtcloud.Connection("redshift",
        project_id=dbt_project["id"],
        type="redshift",
        name="My Redshift Warehouse",
        database="my-database",
        port=5439,
        host_name="my-redshift-hostname")
    snowflake = dbtcloud.Connection("snowflake",
        project_id=dbt_project["id"],
        type="snowflake",
        name="My Snowflake warehouse",
        account="my-snowflake-account",
        database="MY_DATABASE",
        role="MY_ROLE",
        warehouse="MY_WAREHOUSE",
        oauth_client_id="yourclientid",
        oauth_client_secret="yourclientsecret",
        allow_sso=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dbtcloud.NewConnection(ctx, "databricks", &dbtcloud.ConnectionArgs{
    			ProjectId:         pulumi.Any(dbtProject.Id),
    			Type:              pulumi.String("adapter"),
    			Name:              pulumi.String("Databricks"),
    			Database:          pulumi.String(""),
    			HostName:          pulumi.String("my-databricks-host.cloud.databricks.com"),
    			HttpPath:          pulumi.String("/my/path"),
    			Catalog:           pulumi.String("moo"),
    			OauthClientId:     pulumi.String("yourclientid"),
    			OauthClientSecret: pulumi.String("yourclientsecret"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = dbtcloud.NewConnection(ctx, "redshift", &dbtcloud.ConnectionArgs{
    			ProjectId: pulumi.Any(dbtProject.Id),
    			Type:      pulumi.String("redshift"),
    			Name:      pulumi.String("My Redshift Warehouse"),
    			Database:  pulumi.String("my-database"),
    			Port:      pulumi.Int(5439),
    			HostName:  pulumi.String("my-redshift-hostname"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = dbtcloud.NewConnection(ctx, "snowflake", &dbtcloud.ConnectionArgs{
    			ProjectId:         pulumi.Any(dbtProject.Id),
    			Type:              pulumi.String("snowflake"),
    			Name:              pulumi.String("My Snowflake warehouse"),
    			Account:           pulumi.String("my-snowflake-account"),
    			Database:          pulumi.String("MY_DATABASE"),
    			Role:              pulumi.String("MY_ROLE"),
    			Warehouse:         pulumi.String("MY_WAREHOUSE"),
    			OauthClientId:     pulumi.String("yourclientid"),
    			OauthClientSecret: pulumi.String("yourclientsecret"),
    			AllowSso:          pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DbtCloud = Pulumi.DbtCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var databricks = new DbtCloud.Connection("databricks", new()
        {
            ProjectId = dbtProject.Id,
            Type = "adapter",
            Name = "Databricks",
            Database = "",
            HostName = "my-databricks-host.cloud.databricks.com",
            HttpPath = "/my/path",
            Catalog = "moo",
            OauthClientId = "yourclientid",
            OauthClientSecret = "yourclientsecret",
        });
    
        var redshift = new DbtCloud.Connection("redshift", new()
        {
            ProjectId = dbtProject.Id,
            Type = "redshift",
            Name = "My Redshift Warehouse",
            Database = "my-database",
            Port = 5439,
            HostName = "my-redshift-hostname",
        });
    
        var snowflake = new DbtCloud.Connection("snowflake", new()
        {
            ProjectId = dbtProject.Id,
            Type = "snowflake",
            Name = "My Snowflake warehouse",
            Account = "my-snowflake-account",
            Database = "MY_DATABASE",
            Role = "MY_ROLE",
            Warehouse = "MY_WAREHOUSE",
            OauthClientId = "yourclientid",
            OauthClientSecret = "yourclientsecret",
            AllowSso = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dbtcloud.Connection;
    import com.pulumi.dbtcloud.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 databricks = new Connection("databricks", ConnectionArgs.builder()
                .projectId(dbtProject.id())
                .type("adapter")
                .name("Databricks")
                .database("")
                .hostName("my-databricks-host.cloud.databricks.com")
                .httpPath("/my/path")
                .catalog("moo")
                .oauthClientId("yourclientid")
                .oauthClientSecret("yourclientsecret")
                .build());
    
            var redshift = new Connection("redshift", ConnectionArgs.builder()
                .projectId(dbtProject.id())
                .type("redshift")
                .name("My Redshift Warehouse")
                .database("my-database")
                .port(5439)
                .hostName("my-redshift-hostname")
                .build());
    
            var snowflake = new Connection("snowflake", ConnectionArgs.builder()
                .projectId(dbtProject.id())
                .type("snowflake")
                .name("My Snowflake warehouse")
                .account("my-snowflake-account")
                .database("MY_DATABASE")
                .role("MY_ROLE")
                .warehouse("MY_WAREHOUSE")
                .oauthClientId("yourclientid")
                .oauthClientSecret("yourclientsecret")
                .allowSso(true)
                .build());
    
        }
    }
    
    resources:
      databricks:
        type: dbtcloud:Connection
        properties:
          projectId: ${dbtProject.id}
          type: adapter
          name: Databricks
          database:
          hostName: my-databricks-host.cloud.databricks.com
          httpPath: /my/path
          catalog: moo
          oauthClientId: yourclientid
          oauthClientSecret: yourclientsecret
      redshift:
        type: dbtcloud:Connection
        properties:
          projectId: ${dbtProject.id}
          type: redshift
          name: My Redshift Warehouse
          database: my-database
          port: 5439
          hostName: my-redshift-hostname
      snowflake:
        type: dbtcloud:Connection
        properties:
          projectId: ${dbtProject.id}
          type: snowflake
          name: My Snowflake warehouse
          account: my-snowflake-account
          database: MY_DATABASE
          role: MY_ROLE
          warehouse: MY_WAREHOUSE
          oauthClientId: yourclientid
          oauthClientSecret: yourclientsecret
          allowSso: 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: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   database: Optional[str] = None,
                   type: Optional[str] = None,
                   project_id: Optional[int] = None,
                   name: Optional[str] = None,
                   oauth_client_secret: Optional[str] = None,
                   host_name: Optional[str] = None,
                   http_path: Optional[str] = None,
                   is_active: Optional[bool] = None,
                   account: Optional[str] = None,
                   oauth_client_id: Optional[str] = None,
                   catalog: Optional[str] = None,
                   port: Optional[int] = None,
                   private_link_endpoint_id: Optional[str] = None,
                   allow_sso: Optional[bool] = None,
                   role: Optional[str] = None,
                   tunnel_enabled: Optional[bool] = None,
                   allow_keep_alive: Optional[bool] = None,
                   warehouse: Optional[str] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: dbtcloud: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.

    Example

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

    var connectionResource = new DbtCloud.Connection("connectionResource", new()
    {
        Database = "string",
        Type = "string",
        ProjectId = 0,
        Name = "string",
        OauthClientSecret = "string",
        HostName = "string",
        HttpPath = "string",
        IsActive = false,
        Account = "string",
        OauthClientId = "string",
        Catalog = "string",
        Port = 0,
        PrivateLinkEndpointId = "string",
        AllowSso = false,
        Role = "string",
        TunnelEnabled = false,
        AllowKeepAlive = false,
        Warehouse = "string",
    });
    
    example, err := dbtcloud.NewConnection(ctx, "connectionResource", &dbtcloud.ConnectionArgs{
    	Database:              pulumi.String("string"),
    	Type:                  pulumi.String("string"),
    	ProjectId:             pulumi.Int(0),
    	Name:                  pulumi.String("string"),
    	OauthClientSecret:     pulumi.String("string"),
    	HostName:              pulumi.String("string"),
    	HttpPath:              pulumi.String("string"),
    	IsActive:              pulumi.Bool(false),
    	Account:               pulumi.String("string"),
    	OauthClientId:         pulumi.String("string"),
    	Catalog:               pulumi.String("string"),
    	Port:                  pulumi.Int(0),
    	PrivateLinkEndpointId: pulumi.String("string"),
    	AllowSso:              pulumi.Bool(false),
    	Role:                  pulumi.String("string"),
    	TunnelEnabled:         pulumi.Bool(false),
    	AllowKeepAlive:        pulumi.Bool(false),
    	Warehouse:             pulumi.String("string"),
    })
    
    var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
        .database("string")
        .type("string")
        .projectId(0)
        .name("string")
        .oauthClientSecret("string")
        .hostName("string")
        .httpPath("string")
        .isActive(false)
        .account("string")
        .oauthClientId("string")
        .catalog("string")
        .port(0)
        .privateLinkEndpointId("string")
        .allowSso(false)
        .role("string")
        .tunnelEnabled(false)
        .allowKeepAlive(false)
        .warehouse("string")
        .build());
    
    connection_resource = dbtcloud.Connection("connectionResource",
        database="string",
        type="string",
        project_id=0,
        name="string",
        oauth_client_secret="string",
        host_name="string",
        http_path="string",
        is_active=False,
        account="string",
        oauth_client_id="string",
        catalog="string",
        port=0,
        private_link_endpoint_id="string",
        allow_sso=False,
        role="string",
        tunnel_enabled=False,
        allow_keep_alive=False,
        warehouse="string")
    
    const connectionResource = new dbtcloud.Connection("connectionResource", {
        database: "string",
        type: "string",
        projectId: 0,
        name: "string",
        oauthClientSecret: "string",
        hostName: "string",
        httpPath: "string",
        isActive: false,
        account: "string",
        oauthClientId: "string",
        catalog: "string",
        port: 0,
        privateLinkEndpointId: "string",
        allowSso: false,
        role: "string",
        tunnelEnabled: false,
        allowKeepAlive: false,
        warehouse: "string",
    });
    
    type: dbtcloud:Connection
    properties:
        account: string
        allowKeepAlive: false
        allowSso: false
        catalog: string
        database: string
        hostName: string
        httpPath: string
        isActive: false
        name: string
        oauthClientId: string
        oauthClientSecret: string
        port: 0
        privateLinkEndpointId: string
        projectId: 0
        role: string
        tunnelEnabled: false
        type: string
        warehouse: string
    

    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

    The Connection resource accepts the following input properties:

    Database string
    Database name for the connection
    ProjectId int
    Project ID to create the connection in
    Type string
    The type of connection
    Account string
    Account name for the connection (for Snowflake)
    AllowKeepAlive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    AllowSso bool
    Whether or not the connection should allow SSO (for Snowflake)
    Catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    HostName string
    Host name for the connection, including Databricks cluster
    HttpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    IsActive bool
    Whether the connection is active
    Name string
    Connection name
    OauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    OauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    Port int
    Port number to connect via
    PrivateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    Role string
    Role name for the connection (for Snowflake)
    TunnelEnabled bool
    Whether or not tunneling should be enabled on your database connection
    Warehouse string
    Warehouse name for the connection (for Snowflake)
    Database string
    Database name for the connection
    ProjectId int
    Project ID to create the connection in
    Type string
    The type of connection
    Account string
    Account name for the connection (for Snowflake)
    AllowKeepAlive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    AllowSso bool
    Whether or not the connection should allow SSO (for Snowflake)
    Catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    HostName string
    Host name for the connection, including Databricks cluster
    HttpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    IsActive bool
    Whether the connection is active
    Name string
    Connection name
    OauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    OauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    Port int
    Port number to connect via
    PrivateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    Role string
    Role name for the connection (for Snowflake)
    TunnelEnabled bool
    Whether or not tunneling should be enabled on your database connection
    Warehouse string
    Warehouse name for the connection (for Snowflake)
    database String
    Database name for the connection
    projectId Integer
    Project ID to create the connection in
    type String
    The type of connection
    account String
    Account name for the connection (for Snowflake)
    allowKeepAlive Boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso Boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog String
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    hostName String
    Host name for the connection, including Databricks cluster
    httpPath String
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive Boolean
    Whether the connection is active
    name String
    Connection name
    oauthClientId String
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret String
    OAuth client secret (for Snowflake and Databricks)
    port Integer
    Port number to connect via
    privateLinkEndpointId String
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    role String
    Role name for the connection (for Snowflake)
    tunnelEnabled Boolean
    Whether or not tunneling should be enabled on your database connection
    warehouse String
    Warehouse name for the connection (for Snowflake)
    database string
    Database name for the connection
    projectId number
    Project ID to create the connection in
    type string
    The type of connection
    account string
    Account name for the connection (for Snowflake)
    allowKeepAlive boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    hostName string
    Host name for the connection, including Databricks cluster
    httpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive boolean
    Whether the connection is active
    name string
    Connection name
    oauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    port number
    Port number to connect via
    privateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    role string
    Role name for the connection (for Snowflake)
    tunnelEnabled boolean
    Whether or not tunneling should be enabled on your database connection
    warehouse string
    Warehouse name for the connection (for Snowflake)
    database str
    Database name for the connection
    project_id int
    Project ID to create the connection in
    type str
    The type of connection
    account str
    Account name for the connection (for Snowflake)
    allow_keep_alive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allow_sso bool
    Whether or not the connection should allow SSO (for Snowflake)
    catalog str
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    host_name str
    Host name for the connection, including Databricks cluster
    http_path str
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    is_active bool
    Whether the connection is active
    name str
    Connection name
    oauth_client_id str
    OAuth client identifier (for Snowflake and Databricks)
    oauth_client_secret str
    OAuth client secret (for Snowflake and Databricks)
    port int
    Port number to connect via
    private_link_endpoint_id str
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    role str
    Role name for the connection (for Snowflake)
    tunnel_enabled bool
    Whether or not tunneling should be enabled on your database connection
    warehouse str
    Warehouse name for the connection (for Snowflake)
    database String
    Database name for the connection
    projectId Number
    Project ID to create the connection in
    type String
    The type of connection
    account String
    Account name for the connection (for Snowflake)
    allowKeepAlive Boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso Boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog String
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    hostName String
    Host name for the connection, including Databricks cluster
    httpPath String
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive Boolean
    Whether the connection is active
    name String
    Connection name
    oauthClientId String
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret String
    OAuth client secret (for Snowflake and Databricks)
    port Number
    Port number to connect via
    privateLinkEndpointId String
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    role String
    Role name for the connection (for Snowflake)
    tunnelEnabled Boolean
    Whether or not tunneling should be enabled on your database connection
    warehouse String
    Warehouse name for the connection (for Snowflake)

    Outputs

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

    AdapterId int
    Adapter id created for the Databricks connection (for Databricks)
    ConnectionId int
    Connection Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    AdapterId int
    Adapter id created for the Databricks connection (for Databricks)
    ConnectionId int
    Connection Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    adapterId Integer
    Adapter id created for the Databricks connection (for Databricks)
    connectionId Integer
    Connection Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    adapterId number
    Adapter id created for the Databricks connection (for Databricks)
    connectionId number
    Connection Identifier
    id string
    The provider-assigned unique ID for this managed resource.
    adapter_id int
    Adapter id created for the Databricks connection (for Databricks)
    connection_id int
    Connection Identifier
    id str
    The provider-assigned unique ID for this managed resource.
    adapterId Number
    Adapter id created for the Databricks connection (for Databricks)
    connectionId Number
    Connection Identifier
    id String
    The provider-assigned unique ID for this managed resource.

    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,
            account: Optional[str] = None,
            adapter_id: Optional[int] = None,
            allow_keep_alive: Optional[bool] = None,
            allow_sso: Optional[bool] = None,
            catalog: Optional[str] = None,
            connection_id: Optional[int] = None,
            database: Optional[str] = None,
            host_name: Optional[str] = None,
            http_path: Optional[str] = None,
            is_active: Optional[bool] = None,
            name: Optional[str] = None,
            oauth_client_id: Optional[str] = None,
            oauth_client_secret: Optional[str] = None,
            port: Optional[int] = None,
            private_link_endpoint_id: Optional[str] = None,
            project_id: Optional[int] = None,
            role: Optional[str] = None,
            tunnel_enabled: Optional[bool] = None,
            type: Optional[str] = None,
            warehouse: 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)
    Resource lookup is not supported in YAML
    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:
    Account string
    Account name for the connection (for Snowflake)
    AdapterId int
    Adapter id created for the Databricks connection (for Databricks)
    AllowKeepAlive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    AllowSso bool
    Whether or not the connection should allow SSO (for Snowflake)
    Catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    ConnectionId int
    Connection Identifier
    Database string
    Database name for the connection
    HostName string
    Host name for the connection, including Databricks cluster
    HttpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    IsActive bool
    Whether the connection is active
    Name string
    Connection name
    OauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    OauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    Port int
    Port number to connect via
    PrivateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    ProjectId int
    Project ID to create the connection in
    Role string
    Role name for the connection (for Snowflake)
    TunnelEnabled bool
    Whether or not tunneling should be enabled on your database connection
    Type string
    The type of connection
    Warehouse string
    Warehouse name for the connection (for Snowflake)
    Account string
    Account name for the connection (for Snowflake)
    AdapterId int
    Adapter id created for the Databricks connection (for Databricks)
    AllowKeepAlive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    AllowSso bool
    Whether or not the connection should allow SSO (for Snowflake)
    Catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    ConnectionId int
    Connection Identifier
    Database string
    Database name for the connection
    HostName string
    Host name for the connection, including Databricks cluster
    HttpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    IsActive bool
    Whether the connection is active
    Name string
    Connection name
    OauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    OauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    Port int
    Port number to connect via
    PrivateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    ProjectId int
    Project ID to create the connection in
    Role string
    Role name for the connection (for Snowflake)
    TunnelEnabled bool
    Whether or not tunneling should be enabled on your database connection
    Type string
    The type of connection
    Warehouse string
    Warehouse name for the connection (for Snowflake)
    account String
    Account name for the connection (for Snowflake)
    adapterId Integer
    Adapter id created for the Databricks connection (for Databricks)
    allowKeepAlive Boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso Boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog String
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    connectionId Integer
    Connection Identifier
    database String
    Database name for the connection
    hostName String
    Host name for the connection, including Databricks cluster
    httpPath String
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive Boolean
    Whether the connection is active
    name String
    Connection name
    oauthClientId String
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret String
    OAuth client secret (for Snowflake and Databricks)
    port Integer
    Port number to connect via
    privateLinkEndpointId String
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    projectId Integer
    Project ID to create the connection in
    role String
    Role name for the connection (for Snowflake)
    tunnelEnabled Boolean
    Whether or not tunneling should be enabled on your database connection
    type String
    The type of connection
    warehouse String
    Warehouse name for the connection (for Snowflake)
    account string
    Account name for the connection (for Snowflake)
    adapterId number
    Adapter id created for the Databricks connection (for Databricks)
    allowKeepAlive boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog string
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    connectionId number
    Connection Identifier
    database string
    Database name for the connection
    hostName string
    Host name for the connection, including Databricks cluster
    httpPath string
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive boolean
    Whether the connection is active
    name string
    Connection name
    oauthClientId string
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret string
    OAuth client secret (for Snowflake and Databricks)
    port number
    Port number to connect via
    privateLinkEndpointId string
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    projectId number
    Project ID to create the connection in
    role string
    Role name for the connection (for Snowflake)
    tunnelEnabled boolean
    Whether or not tunneling should be enabled on your database connection
    type string
    The type of connection
    warehouse string
    Warehouse name for the connection (for Snowflake)
    account str
    Account name for the connection (for Snowflake)
    adapter_id int
    Adapter id created for the Databricks connection (for Databricks)
    allow_keep_alive bool
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allow_sso bool
    Whether or not the connection should allow SSO (for Snowflake)
    catalog str
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    connection_id int
    Connection Identifier
    database str
    Database name for the connection
    host_name str
    Host name for the connection, including Databricks cluster
    http_path str
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    is_active bool
    Whether the connection is active
    name str
    Connection name
    oauth_client_id str
    OAuth client identifier (for Snowflake and Databricks)
    oauth_client_secret str
    OAuth client secret (for Snowflake and Databricks)
    port int
    Port number to connect via
    private_link_endpoint_id str
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    project_id int
    Project ID to create the connection in
    role str
    Role name for the connection (for Snowflake)
    tunnel_enabled bool
    Whether or not tunneling should be enabled on your database connection
    type str
    The type of connection
    warehouse str
    Warehouse name for the connection (for Snowflake)
    account String
    Account name for the connection (for Snowflake)
    adapterId Number
    Adapter id created for the Databricks connection (for Databricks)
    allowKeepAlive Boolean
    Whether or not the connection should allow client session keep alive (for Snowflake)
    allowSso Boolean
    Whether or not the connection should allow SSO (for Snowflake)
    catalog String
    Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
    connectionId Number
    Connection Identifier
    database String
    Database name for the connection
    hostName String
    Host name for the connection, including Databricks cluster
    httpPath String
    The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
    isActive Boolean
    Whether the connection is active
    name String
    Connection name
    oauthClientId String
    OAuth client identifier (for Snowflake and Databricks)
    oauthClientSecret String
    OAuth client secret (for Snowflake and Databricks)
    port Number
    Port number to connect via
    privateLinkEndpointId String
    The ID of the PrivateLink connection. This ID can be found using the privatelink_endpoint data source
    projectId Number
    Project ID to create the connection in
    role String
    Role name for the connection (for Snowflake)
    tunnelEnabled Boolean
    Whether or not tunneling should be enabled on your database connection
    type String
    The type of connection
    warehouse String
    Warehouse name for the connection (for Snowflake)

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_connection.test_connection

    id = “project_id:connection_id”

    }

    import {

    to = dbtcloud_connection.test_connection

    id = “12345:6789”

    }

    using the older import command

    $ pulumi import dbtcloud:index/connection:Connection test_connection "project_id:connection_id"
    
    $ pulumi import dbtcloud:index/connection:Connection test_connection 12345:6789
    

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

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    dbt Cloud v0.1.8 published on Tuesday, Jun 11, 2024 by Pulumi