Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. DbtGitProjectConfig
fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.DbtGitProjectConfig

Explore with Pulumi AI

fivetran logo
fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
fivetran/terraform-provider-fivetran

    This resource is Deprecated, please follow the 1.5.0 migration guide to update the schema.

    This resource allows you to add and manage dbt Git Projects Configs.

    Example Usage

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

const gitProjectConfig = new fivetran.DbtGitProjectConfig("gitProjectConfig", {
    folderPath: "/dbt/project/folder/path",
    gitBranch: "main",
    gitRemoteUrl: "your_git_remote_url",
    projectId: "project_id",
});

    import pulumi
import pulumi_fivetran as fivetran

git_project_config = fivetran.DbtGitProjectConfig("gitProjectConfig",
    folder_path="/dbt/project/folder/path",
    git_branch="main",
    git_remote_url="your_git_remote_url",
    project_id="project_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.NewDbtGitProjectConfig(ctx, "gitProjectConfig", &fivetran.DbtGitProjectConfigArgs{
			FolderPath:   pulumi.String("/dbt/project/folder/path"),
			GitBranch:    pulumi.String("main"),
			GitRemoteUrl: pulumi.String("your_git_remote_url"),
			ProjectId:    pulumi.String("project_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var gitProjectConfig = new Fivetran.DbtGitProjectConfig("gitProjectConfig", new()
    {
        FolderPath = "/dbt/project/folder/path",
        GitBranch = "main",
        GitRemoteUrl = "your_git_remote_url",
        ProjectId = "project_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.DbtGitProjectConfig;
import com.pulumi.fivetran.DbtGitProjectConfigArgs;
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 gitProjectConfig = new DbtGitProjectConfig("gitProjectConfig", DbtGitProjectConfigArgs.builder()
            .folderPath("/dbt/project/folder/path")
            .gitBranch("main")
            .gitRemoteUrl("your_git_remote_url")
            .projectId("project_id")
            .build());

    }
}

    resources:
  gitProjectConfig:
    type: fivetran:DbtGitProjectConfig
    properties:
      folderPath: /dbt/project/folder/path
      gitBranch: main
      gitRemoteUrl: your_git_remote_url
      projectId: project_id

    Create DbtGitProjectConfig Resource

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

    Constructor syntax

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

@overload
def DbtGitProjectConfig(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project_id: Optional[str] = None,
                        ensure_readiness: Optional[bool] = None,
                        folder_path: Optional[str] = None,
                        git_branch: Optional[str] = None,
                        git_remote_url: Optional[str] = None)
    func NewDbtGitProjectConfig(ctx *Context, name string, args DbtGitProjectConfigArgs, opts ...ResourceOption) (*DbtGitProjectConfig, error)
    public DbtGitProjectConfig(string name, DbtGitProjectConfigArgs args, CustomResourceOptions? opts = null)
    public DbtGitProjectConfig(String name, DbtGitProjectConfigArgs args)
public DbtGitProjectConfig(String name, DbtGitProjectConfigArgs args, CustomResourceOptions options)

    type: fivetran:DbtGitProjectConfig
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 DbtGitProjectConfigArgs
    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 DbtGitProjectConfigArgs
    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 DbtGitProjectConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbtGitProjectConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbtGitProjectConfigArgs
    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 dbtGitProjectConfigResource = new Fivetran.DbtGitProjectConfig("dbtGitProjectConfigResource", new()
{
    ProjectId = "string",
    EnsureReadiness = false,
    FolderPath = "string",
    GitBranch = "string",
    GitRemoteUrl = "string",
});

    example, err := fivetran.NewDbtGitProjectConfig(ctx, "dbtGitProjectConfigResource", &fivetran.DbtGitProjectConfigArgs{
ProjectId: pulumi.String("string"),
EnsureReadiness: pulumi.Bool(false),
FolderPath: pulumi.String("string"),
GitBranch: pulumi.String("string"),
GitRemoteUrl: pulumi.String("string"),
})

    var dbtGitProjectConfigResource = new DbtGitProjectConfig("dbtGitProjectConfigResource", DbtGitProjectConfigArgs.builder()
    .projectId("string")
    .ensureReadiness(false)
    .folderPath("string")
    .gitBranch("string")
    .gitRemoteUrl("string")
    .build());

    dbt_git_project_config_resource = fivetran.DbtGitProjectConfig("dbtGitProjectConfigResource",
    project_id="string",
    ensure_readiness=False,
    folder_path="string",
    git_branch="string",
    git_remote_url="string")

    const dbtGitProjectConfigResource = new fivetran.DbtGitProjectConfig("dbtGitProjectConfigResource", {
    projectId: "string",
    ensureReadiness: false,
    folderPath: "string",
    gitBranch: "string",
    gitRemoteUrl: "string",
});

    type: fivetran:DbtGitProjectConfig
properties:
    ensureReadiness: false
    folderPath: string
    gitBranch: string
    gitRemoteUrl: string
    projectId: string

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

    ProjectId string
    The unique identifier for the dbt Project within the Fivetran system.
    EnsureReadiness bool
    Should resource wait for project to finish initialization. Default value: false.
    FolderPath string
    Folder in Git repo with your dbt project.
    GitBranch string
    Git branch.
    GitRemoteUrl string
    Git remote URL with your dbt project.
    ProjectId string
    The unique identifier for the dbt Project within the Fivetran system.
    EnsureReadiness bool
    Should resource wait for project to finish initialization. Default value: false.
    FolderPath string
    Folder in Git repo with your dbt project.
    GitBranch string
    Git branch.
    GitRemoteUrl string
    Git remote URL with your dbt project.
    projectId String
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness Boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath String
    Folder in Git repo with your dbt project.
    gitBranch String
    Git branch.
    gitRemoteUrl String
    Git remote URL with your dbt project.
    projectId string
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath string
    Folder in Git repo with your dbt project.
    gitBranch string
    Git branch.
    gitRemoteUrl string
    Git remote URL with your dbt project.
    project_id str
    The unique identifier for the dbt Project within the Fivetran system.
    ensure_readiness bool
    Should resource wait for project to finish initialization. Default value: false.
    folder_path str
    Folder in Git repo with your dbt project.
    git_branch str
    Git branch.
    git_remote_url str
    Git remote URL with your dbt project.
    projectId String
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness Boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath String
    Folder in Git repo with your dbt project.
    gitBranch String
    Git branch.
    gitRemoteUrl String
    Git remote URL with your dbt project.

    Outputs

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

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

    Look up Existing DbtGitProjectConfig Resource

    Get an existing DbtGitProjectConfig 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?: DbtGitProjectConfigState, opts?: CustomResourceOptions): DbtGitProjectConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ensure_readiness: Optional[bool] = None,
        folder_path: Optional[str] = None,
        git_branch: Optional[str] = None,
        git_remote_url: Optional[str] = None,
        project_id: Optional[str] = None) -> DbtGitProjectConfig
    func GetDbtGitProjectConfig(ctx *Context, name string, id IDInput, state *DbtGitProjectConfigState, opts ...ResourceOption) (*DbtGitProjectConfig, error)
    public static DbtGitProjectConfig Get(string name, Input<string> id, DbtGitProjectConfigState? state, CustomResourceOptions? opts = null)
    public static DbtGitProjectConfig get(String name, Output<String> id, DbtGitProjectConfigState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:DbtGitProjectConfig    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:
    EnsureReadiness bool
    Should resource wait for project to finish initialization. Default value: false.
    FolderPath string
    Folder in Git repo with your dbt project.
    GitBranch string
    Git branch.
    GitRemoteUrl string
    Git remote URL with your dbt project.
    ProjectId string
    The unique identifier for the dbt Project within the Fivetran system.
    EnsureReadiness bool
    Should resource wait for project to finish initialization. Default value: false.
    FolderPath string
    Folder in Git repo with your dbt project.
    GitBranch string
    Git branch.
    GitRemoteUrl string
    Git remote URL with your dbt project.
    ProjectId string
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness Boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath String
    Folder in Git repo with your dbt project.
    gitBranch String
    Git branch.
    gitRemoteUrl String
    Git remote URL with your dbt project.
    projectId String
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath string
    Folder in Git repo with your dbt project.
    gitBranch string
    Git branch.
    gitRemoteUrl string
    Git remote URL with your dbt project.
    projectId string
    The unique identifier for the dbt Project within the Fivetran system.
    ensure_readiness bool
    Should resource wait for project to finish initialization. Default value: false.
    folder_path str
    Folder in Git repo with your dbt project.
    git_branch str
    Git branch.
    git_remote_url str
    Git remote URL with your dbt project.
    project_id str
    The unique identifier for the dbt Project within the Fivetran system.
    ensureReadiness Boolean
    Should resource wait for project to finish initialization. Default value: false.
    folderPath String
    Folder in Git repo with your dbt project.
    gitBranch String
    Git branch.
    gitRemoteUrl String
    Git remote URL with your dbt project.
    projectId String
    The unique identifier for the dbt Project within the Fivetran system.

    Import

    1. To import an existing fivetran_dbt_git_project_config resource into your Terraform state, you need to get Dbt Project ID via API call GET https://api.fivetran.com/v1/dbt/projects to retrieve available projects.

    2. Fetch project details for particular project-id using GET https://api.fivetran.com/v1/dbt/projects/{project-id} to ensure that this is the project you want to import.

    3. Define an empty resource in your .tf configuration:

    hcl

    resource “fivetran_dbt_git_project_config” “my_imported_fivetran_dbt_git_project_config” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/dbtGitProjectConfig:DbtGitProjectConfig my_imported_fivetran_dbt_git_project_config {Dbt Project ID}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_dbt_git_project_config.my_imported_fivetran_dbt_git_project_config’

    1. Copy the values and paste them to your .tf configuration.

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

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
    fivetran/terraform-provider-fivetran