Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. TransformationProject
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.TransformationProject

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    Import

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

    2. Fetch project details for particular project-id using GET https://api.fivetran.com/v1/transformation-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_transformation_project” “my_imported_fivetran_transformation_project” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/transformationProject:TransformationProject my_imported_fivetran_transformation_project {Transformation Project ID}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_transformation_project.my_imported_fivetran_transformation_project’

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

    Create TransformationProject Resource

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

    Constructor syntax

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

@overload
def TransformationProject(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          group_id: Optional[str] = None,
                          type: Optional[str] = None,
                          project_config: Optional[TransformationProjectProjectConfigArgs] = None,
                          run_tests: Optional[bool] = None)
    func NewTransformationProject(ctx *Context, name string, args TransformationProjectArgs, opts ...ResourceOption) (*TransformationProject, error)
    public TransformationProject(string name, TransformationProjectArgs args, CustomResourceOptions? opts = null)
    public TransformationProject(String name, TransformationProjectArgs args)
public TransformationProject(String name, TransformationProjectArgs args, CustomResourceOptions options)

    type: fivetran:TransformationProject
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 TransformationProjectArgs
    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 TransformationProjectArgs
    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 TransformationProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransformationProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransformationProjectArgs
    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 transformationProjectResource = new Fivetran.TransformationProject("transformationProjectResource", new()
{
    GroupId = "string",
    Type = "string",
    ProjectConfig = new Fivetran.Inputs.TransformationProjectProjectConfigArgs
    {
        DbtVersion = "string",
        DefaultSchema = "string",
        EnvironmentVars = new[]
        {
            "string",
        },
        FolderPath = "string",
        GitBranch = "string",
        GitRemoteUrl = "string",
        PublicKey = "string",
        TargetName = "string",
        Threads = 0,
    },
    RunTests = false,
});

    example, err := fivetran.NewTransformationProject(ctx, "transformationProjectResource", &fivetran.TransformationProjectArgs{
GroupId: pulumi.String("string"),
Type: pulumi.String("string"),
ProjectConfig: &.TransformationProjectProjectConfigArgs{
DbtVersion: pulumi.String("string"),
DefaultSchema: pulumi.String("string"),
EnvironmentVars: pulumi.StringArray{
pulumi.String("string"),
},
FolderPath: pulumi.String("string"),
GitBranch: pulumi.String("string"),
GitRemoteUrl: pulumi.String("string"),
PublicKey: pulumi.String("string"),
TargetName: pulumi.String("string"),
Threads: pulumi.Float64(0),
},
RunTests: pulumi.Bool(false),
})

    var transformationProjectResource = new TransformationProject("transformationProjectResource", TransformationProjectArgs.builder()
    .groupId("string")
    .type("string")
    .projectConfig(TransformationProjectProjectConfigArgs.builder()
        .dbtVersion("string")
        .defaultSchema("string")
        .environmentVars("string")
        .folderPath("string")
        .gitBranch("string")
        .gitRemoteUrl("string")
        .publicKey("string")
        .targetName("string")
        .threads(0)
        .build())
    .runTests(false)
    .build());

    transformation_project_resource = fivetran.TransformationProject("transformationProjectResource",
    group_id="string",
    type="string",
    project_config={
        "dbt_version": "string",
        "default_schema": "string",
        "environment_vars": ["string"],
        "folder_path": "string",
        "git_branch": "string",
        "git_remote_url": "string",
        "public_key": "string",
        "target_name": "string",
        "threads": 0,
    },
    run_tests=False)

    const transformationProjectResource = new fivetran.TransformationProject("transformationProjectResource", {
    groupId: "string",
    type: "string",
    projectConfig: {
        dbtVersion: "string",
        defaultSchema: "string",
        environmentVars: ["string"],
        folderPath: "string",
        gitBranch: "string",
        gitRemoteUrl: "string",
        publicKey: "string",
        targetName: "string",
        threads: 0,
    },
    runTests: false,
});

    type: fivetran:TransformationProject
properties:
    groupId: string
    projectConfig:
        dbtVersion: string
        defaultSchema: string
        environmentVars:
            - string
        folderPath: string
        gitBranch: string
        gitRemoteUrl: string
        publicKey: string
        targetName: string
        threads: 0
    runTests: false
    type: string

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

    GroupId string
    The unique identifier for the group within the Fivetran system.
    Type string
    Transformation project type.
    ProjectConfig TransformationProjectProjectConfig
    RunTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    GroupId string
    The unique identifier for the group within the Fivetran system.
    Type string
    Transformation project type.
    ProjectConfig TransformationProjectProjectConfigArgs
    RunTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    groupId String
    The unique identifier for the group within the Fivetran system.
    type String
    Transformation project type.
    projectConfig TransformationProjectProjectConfig
    runTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    groupId string
    The unique identifier for the group within the Fivetran system.
    type string
    Transformation project type.
    projectConfig TransformationProjectProjectConfig
    runTests boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    group_id str
    The unique identifier for the group within the Fivetran system.
    type str
    Transformation project type.
    project_config TransformationProjectProjectConfigArgs
    run_tests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    groupId String
    The unique identifier for the group within the Fivetran system.
    type String
    Transformation project type.
    projectConfig Property Map
    runTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.

    Outputs

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

    CreatedAt string
    The timestamp of the transformation Project creation.
    CreatedById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    Errors List<string>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    CreatedAt string
    The timestamp of the transformation Project creation.
    CreatedById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    Errors []string
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    createdAt String
    The timestamp of the transformation Project creation.
    createdById String
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of transformation Project (NOT_READY, READY, ERROR).
    createdAt string
    The timestamp of the transformation Project creation.
    createdById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors string[]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    created_at str
    The timestamp of the transformation Project creation.
    created_by_id str
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors Sequence[str]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of transformation Project (NOT_READY, READY, ERROR).
    createdAt String
    The timestamp of the transformation Project creation.
    createdById String
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of transformation Project (NOT_READY, READY, ERROR).

    Look up Existing TransformationProject Resource

    Get an existing TransformationProject 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?: TransformationProjectState, opts?: CustomResourceOptions): TransformationProject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by_id: Optional[str] = None,
        errors: Optional[Sequence[str]] = None,
        group_id: Optional[str] = None,
        project_config: Optional[TransformationProjectProjectConfigArgs] = None,
        run_tests: Optional[bool] = None,
        status: Optional[str] = None,
        type: Optional[str] = None) -> TransformationProject
    func GetTransformationProject(ctx *Context, name string, id IDInput, state *TransformationProjectState, opts ...ResourceOption) (*TransformationProject, error)
    public static TransformationProject Get(string name, Input<string> id, TransformationProjectState? state, CustomResourceOptions? opts = null)
    public static TransformationProject get(String name, Output<String> id, TransformationProjectState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:TransformationProject    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:
    CreatedAt string
    The timestamp of the transformation Project creation.
    CreatedById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    Errors List<string>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    GroupId string
    The unique identifier for the group within the Fivetran system.
    ProjectConfig TransformationProjectProjectConfig
    RunTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    Type string
    Transformation project type.
    CreatedAt string
    The timestamp of the transformation Project creation.
    CreatedById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    Errors []string
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    GroupId string
    The unique identifier for the group within the Fivetran system.
    ProjectConfig TransformationProjectProjectConfigArgs
    RunTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    Type string
    Transformation project type.
    createdAt String
    The timestamp of the transformation Project creation.
    createdById String
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    groupId String
    The unique identifier for the group within the Fivetran system.
    projectConfig TransformationProjectProjectConfig
    runTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    status String
    Status of transformation Project (NOT_READY, READY, ERROR).
    type String
    Transformation project type.
    createdAt string
    The timestamp of the transformation Project creation.
    createdById string
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors string[]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    groupId string
    The unique identifier for the group within the Fivetran system.
    projectConfig TransformationProjectProjectConfig
    runTests boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    status string
    Status of transformation Project (NOT_READY, READY, ERROR).
    type string
    Transformation project type.
    created_at str
    The timestamp of the transformation Project creation.
    created_by_id str
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors Sequence[str]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    group_id str
    The unique identifier for the group within the Fivetran system.
    project_config TransformationProjectProjectConfigArgs
    run_tests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    status str
    Status of transformation Project (NOT_READY, READY, ERROR).
    type str
    Transformation project type.
    createdAt String
    The timestamp of the transformation Project creation.
    createdById String
    The unique identifier for the User within the Fivetran system who created the dbt Project.
    errors List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    groupId String
    The unique identifier for the group within the Fivetran system.
    projectConfig Property Map
    runTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    status String
    Status of transformation Project (NOT_READY, READY, ERROR).
    type String
    Transformation project type.

    Supporting Types

    TransformationProjectProjectConfig, TransformationProjectProjectConfigArgs

    DbtVersion string
    The version of transformation that should run the project
    DefaultSchema string
    Default schema in destination. This production schema will contain your transformed data.
    EnvironmentVars List<string>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    FolderPath string
    Folder in Git repo with your transformation project
    GitBranch string
    Git branch
    GitRemoteUrl string
    Git remote URL with your transformation project
    PublicKey string
    Public key to grant Fivetran SSH access to git repository.
    TargetName string
    Target name to set or override the value from the deployment.yaml
    Threads double
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
    DbtVersion string
    The version of transformation that should run the project
    DefaultSchema string
    Default schema in destination. This production schema will contain your transformed data.
    EnvironmentVars []string
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    FolderPath string
    Folder in Git repo with your transformation project
    GitBranch string
    Git branch
    GitRemoteUrl string
    Git remote URL with your transformation project
    PublicKey string
    Public key to grant Fivetran SSH access to git repository.
    TargetName string
    Target name to set or override the value from the deployment.yaml
    Threads float64
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
    dbtVersion String
    The version of transformation that should run the project
    defaultSchema String
    Default schema in destination. This production schema will contain your transformed data.
    environmentVars List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    folderPath String
    Folder in Git repo with your transformation project
    gitBranch String
    Git branch
    gitRemoteUrl String
    Git remote URL with your transformation project
    publicKey String
    Public key to grant Fivetran SSH access to git repository.
    targetName String
    Target name to set or override the value from the deployment.yaml
    threads Double
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
    dbtVersion string
    The version of transformation that should run the project
    defaultSchema string
    Default schema in destination. This production schema will contain your transformed data.
    environmentVars string[]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    folderPath string
    Folder in Git repo with your transformation project
    gitBranch string
    Git branch
    gitRemoteUrl string
    Git remote URL with your transformation project
    publicKey string
    Public key to grant Fivetran SSH access to git repository.
    targetName string
    Target name to set or override the value from the deployment.yaml
    threads number
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
    dbt_version str
    The version of transformation that should run the project
    default_schema str
    Default schema in destination. This production schema will contain your transformed data.
    environment_vars Sequence[str]
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    folder_path str
    Folder in Git repo with your transformation project
    git_branch str
    Git branch
    git_remote_url str
    Git remote URL with your transformation project
    public_key str
    Public key to grant Fivetran SSH access to git repository.
    target_name str
    Target name to set or override the value from the deployment.yaml
    threads float
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
    dbtVersion String
    The version of transformation that should run the project
    defaultSchema String
    Default schema in destination. This production schema will contain your transformed data.
    environmentVars List<String>
    List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
    folderPath String
    Folder in Git repo with your transformation project
    gitBranch String
    Git branch
    gitRemoteUrl String
    Git remote URL with your transformation project
    publicKey String
    Public key to grant Fivetran SSH access to git repository.
    targetName String
    Target name to set or override the value from the deployment.yaml
    threads Number
    The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.

    Package Details

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