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

dbtcloud.FabricConnection

Explore with Pulumi AI

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

    Resource to create Microsoft Fabric connections in dbt Cloud

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    const myFabricConnection = new dbtcloud.FabricConnection("my_fabric_connection", {
        projectId: dbtProject.id,
        name: "Connection Name",
        server: "my-server",
        database: "my-database",
        port: 1234,
        loginTimeout: 30,
    });
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    my_fabric_connection = dbtcloud.FabricConnection("my_fabric_connection",
        project_id=dbt_project["id"],
        name="Connection Name",
        server="my-server",
        database="my-database",
        port=1234,
        login_timeout=30)
    
    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.NewFabricConnection(ctx, "my_fabric_connection", &dbtcloud.FabricConnectionArgs{
    			ProjectId:    pulumi.Any(dbtProject.Id),
    			Name:         pulumi.String("Connection Name"),
    			Server:       pulumi.String("my-server"),
    			Database:     pulumi.String("my-database"),
    			Port:         pulumi.Int(1234),
    			LoginTimeout: pulumi.Int(30),
    		})
    		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 myFabricConnection = new DbtCloud.FabricConnection("my_fabric_connection", new()
        {
            ProjectId = dbtProject.Id,
            Name = "Connection Name",
            Server = "my-server",
            Database = "my-database",
            Port = 1234,
            LoginTimeout = 30,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dbtcloud.FabricConnection;
    import com.pulumi.dbtcloud.FabricConnectionArgs;
    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 myFabricConnection = new FabricConnection("myFabricConnection", FabricConnectionArgs.builder()
                .projectId(dbtProject.id())
                .name("Connection Name")
                .server("my-server")
                .database("my-database")
                .port(1234)
                .loginTimeout(30)
                .build());
    
        }
    }
    
    resources:
      myFabricConnection:
        type: dbtcloud:FabricConnection
        name: my_fabric_connection
        properties:
          projectId: ${dbtProject.id}
          name: Connection Name
          server: my-server
          database: my-database
          port: 1234
          loginTimeout: 30
    

    Create FabricConnection Resource

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

    Constructor syntax

    new FabricConnection(name: string, args: FabricConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def FabricConnection(resource_name: str,
                         args: FabricConnectionArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FabricConnection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         database: Optional[str] = None,
                         port: Optional[int] = None,
                         project_id: Optional[int] = None,
                         server: Optional[str] = None,
                         login_timeout: Optional[int] = None,
                         name: Optional[str] = None,
                         query_timeout: Optional[int] = None,
                         retries: Optional[int] = None)
    func NewFabricConnection(ctx *Context, name string, args FabricConnectionArgs, opts ...ResourceOption) (*FabricConnection, error)
    public FabricConnection(string name, FabricConnectionArgs args, CustomResourceOptions? opts = null)
    public FabricConnection(String name, FabricConnectionArgs args)
    public FabricConnection(String name, FabricConnectionArgs args, CustomResourceOptions options)
    
    type: dbtcloud:FabricConnection
    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 FabricConnectionArgs
    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 FabricConnectionArgs
    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 FabricConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FabricConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FabricConnectionArgs
    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 fabricConnectionResource = new DbtCloud.FabricConnection("fabricConnectionResource", new()
    {
        Database = "string",
        Port = 0,
        ProjectId = 0,
        Server = "string",
        LoginTimeout = 0,
        Name = "string",
        QueryTimeout = 0,
        Retries = 0,
    });
    
    example, err := dbtcloud.NewFabricConnection(ctx, "fabricConnectionResource", &dbtcloud.FabricConnectionArgs{
    	Database:     pulumi.String("string"),
    	Port:         pulumi.Int(0),
    	ProjectId:    pulumi.Int(0),
    	Server:       pulumi.String("string"),
    	LoginTimeout: pulumi.Int(0),
    	Name:         pulumi.String("string"),
    	QueryTimeout: pulumi.Int(0),
    	Retries:      pulumi.Int(0),
    })
    
    var fabricConnectionResource = new FabricConnection("fabricConnectionResource", FabricConnectionArgs.builder()
        .database("string")
        .port(0)
        .projectId(0)
        .server("string")
        .loginTimeout(0)
        .name("string")
        .queryTimeout(0)
        .retries(0)
        .build());
    
    fabric_connection_resource = dbtcloud.FabricConnection("fabricConnectionResource",
        database="string",
        port=0,
        project_id=0,
        server="string",
        login_timeout=0,
        name="string",
        query_timeout=0,
        retries=0)
    
    const fabricConnectionResource = new dbtcloud.FabricConnection("fabricConnectionResource", {
        database: "string",
        port: 0,
        projectId: 0,
        server: "string",
        loginTimeout: 0,
        name: "string",
        queryTimeout: 0,
        retries: 0,
    });
    
    type: dbtcloud:FabricConnection
    properties:
        database: string
        loginTimeout: 0
        name: string
        port: 0
        projectId: 0
        queryTimeout: 0
        retries: 0
        server: string
    

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

    Database string
    The database to connect to for this connection.
    Port int
    The port to connect to for this connection.
    ProjectId int
    Project ID to create the connection in
    Server string
    The server hostname.
    LoginTimeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Name string
    Connection name
    QueryTimeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    Database string
    The database to connect to for this connection.
    Port int
    The port to connect to for this connection.
    ProjectId int
    Project ID to create the connection in
    Server string
    The server hostname.
    LoginTimeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Name string
    Connection name
    QueryTimeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    database String
    The database to connect to for this connection.
    port Integer
    The port to connect to for this connection.
    projectId Integer
    Project ID to create the connection in
    server String
    The server hostname.
    loginTimeout Integer
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name String
    Connection name
    queryTimeout Integer
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries Integer
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    database string
    The database to connect to for this connection.
    port number
    The port to connect to for this connection.
    projectId number
    Project ID to create the connection in
    server string
    The server hostname.
    loginTimeout number
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name string
    Connection name
    queryTimeout number
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries number
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    database str
    The database to connect to for this connection.
    port int
    The port to connect to for this connection.
    project_id int
    Project ID to create the connection in
    server str
    The server hostname.
    login_timeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name str
    Connection name
    query_timeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    database String
    The database to connect to for this connection.
    port Number
    The port to connect to for this connection.
    projectId Number
    Project ID to create the connection in
    server String
    The server hostname.
    loginTimeout Number
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name String
    Connection name
    queryTimeout Number
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries Number
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

    Outputs

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

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

    Look up Existing FabricConnection Resource

    Get an existing FabricConnection 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?: FabricConnectionState, opts?: CustomResourceOptions): FabricConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adapter_id: Optional[int] = None,
            connection_id: Optional[int] = None,
            database: Optional[str] = None,
            login_timeout: Optional[int] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            project_id: Optional[int] = None,
            query_timeout: Optional[int] = None,
            retries: Optional[int] = None,
            server: Optional[str] = None) -> FabricConnection
    func GetFabricConnection(ctx *Context, name string, id IDInput, state *FabricConnectionState, opts ...ResourceOption) (*FabricConnection, error)
    public static FabricConnection Get(string name, Input<string> id, FabricConnectionState? state, CustomResourceOptions? opts = null)
    public static FabricConnection get(String name, Output<String> id, FabricConnectionState 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:
    AdapterId int
    Adapter id created for the Fabric connection
    ConnectionId int
    Connection Identifier
    Database string
    The database to connect to for this connection.
    LoginTimeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Name string
    Connection name
    Port int
    The port to connect to for this connection.
    ProjectId int
    Project ID to create the connection in
    QueryTimeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    Server string
    The server hostname.
    AdapterId int
    Adapter id created for the Fabric connection
    ConnectionId int
    Connection Identifier
    Database string
    The database to connect to for this connection.
    LoginTimeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Name string
    Connection name
    Port int
    The port to connect to for this connection.
    ProjectId int
    Project ID to create the connection in
    QueryTimeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    Retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    Server string
    The server hostname.
    adapterId Integer
    Adapter id created for the Fabric connection
    connectionId Integer
    Connection Identifier
    database String
    The database to connect to for this connection.
    loginTimeout Integer
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name String
    Connection name
    port Integer
    The port to connect to for this connection.
    projectId Integer
    Project ID to create the connection in
    queryTimeout Integer
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries Integer
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    server String
    The server hostname.
    adapterId number
    Adapter id created for the Fabric connection
    connectionId number
    Connection Identifier
    database string
    The database to connect to for this connection.
    loginTimeout number
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name string
    Connection name
    port number
    The port to connect to for this connection.
    projectId number
    Project ID to create the connection in
    queryTimeout number
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries number
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    server string
    The server hostname.
    adapter_id int
    Adapter id created for the Fabric connection
    connection_id int
    Connection Identifier
    database str
    The database to connect to for this connection.
    login_timeout int
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name str
    Connection name
    port int
    The port to connect to for this connection.
    project_id int
    Project ID to create the connection in
    query_timeout int
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries int
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    server str
    The server hostname.
    adapterId Number
    Adapter id created for the Fabric connection
    connectionId Number
    Connection Identifier
    database String
    The database to connect to for this connection.
    loginTimeout Number
    The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    name String
    Connection name
    port Number
    The port to connect to for this connection.
    projectId Number
    Project ID to create the connection in
    queryTimeout Number
    The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
    retries Number
    The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
    server String
    The server hostname.

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_fabric_connection.my_connection

    id = “project_id:connection_id”

    }

    import {

    to = dbtcloud_fabric_connection.my_connection

    id = “12345:6789”

    }

    using the older import command

    $ pulumi import dbtcloud:index/fabricConnection:FabricConnection my_connection "project_id:connection_id"
    
    $ pulumi import dbtcloud:index/fabricConnection:FabricConnection my_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