1. Packages
  2. dbt Cloud
  3. API Docs
  4. ProjectArtefacts
dbt Cloud v0.1.10 published on Thursday, Jul 18, 2024 by Pulumi

dbtcloud.ProjectArtefacts

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v0.1.10 published on Thursday, Jul 18, 2024 by Pulumi

    [Deprecated] Resource for mentioning what jobs are the source of truth for the legacy dbt Docs and dbt Source Freshness pages. dbt Explorer doesn’t require this config anymore.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    const myProjectArtefacts = new dbtcloud.ProjectArtefacts("my_project_artefacts", {
        projectId: dbtProject.id,
        docsJobId: prodJob.id,
        freshnessJobId: prodJob.id,
    });
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    my_project_artefacts = dbtcloud.ProjectArtefacts("my_project_artefacts",
        project_id=dbt_project["id"],
        docs_job_id=prod_job["id"],
        freshness_job_id=prod_job["id"])
    
    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.NewProjectArtefacts(ctx, "my_project_artefacts", &dbtcloud.ProjectArtefactsArgs{
    			ProjectId:      pulumi.Any(dbtProject.Id),
    			DocsJobId:      pulumi.Any(prodJob.Id),
    			FreshnessJobId: pulumi.Any(prodJob.Id),
    		})
    		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 myProjectArtefacts = new DbtCloud.ProjectArtefacts("my_project_artefacts", new()
        {
            ProjectId = dbtProject.Id,
            DocsJobId = prodJob.Id,
            FreshnessJobId = prodJob.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dbtcloud.ProjectArtefacts;
    import com.pulumi.dbtcloud.ProjectArtefactsArgs;
    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 myProjectArtefacts = new ProjectArtefacts("myProjectArtefacts", ProjectArtefactsArgs.builder()
                .projectId(dbtProject.id())
                .docsJobId(prodJob.id())
                .freshnessJobId(prodJob.id())
                .build());
    
        }
    }
    
    resources:
      myProjectArtefacts:
        type: dbtcloud:ProjectArtefacts
        name: my_project_artefacts
        properties:
          projectId: ${dbtProject.id}
          docsJobId: ${prodJob.id}
          freshnessJobId: ${prodJob.id}
    

    Create ProjectArtefacts Resource

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

    Constructor syntax

    new ProjectArtefacts(name: string, args: ProjectArtefactsArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectArtefacts(resource_name: str,
                         args: ProjectArtefactsArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectArtefacts(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         project_id: Optional[int] = None,
                         docs_job_id: Optional[int] = None,
                         freshness_job_id: Optional[int] = None)
    func NewProjectArtefacts(ctx *Context, name string, args ProjectArtefactsArgs, opts ...ResourceOption) (*ProjectArtefacts, error)
    public ProjectArtefacts(string name, ProjectArtefactsArgs args, CustomResourceOptions? opts = null)
    public ProjectArtefacts(String name, ProjectArtefactsArgs args)
    public ProjectArtefacts(String name, ProjectArtefactsArgs args, CustomResourceOptions options)
    
    type: dbtcloud:ProjectArtefacts
    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 ProjectArtefactsArgs
    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 ProjectArtefactsArgs
    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 ProjectArtefactsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArtefactsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArtefactsArgs
    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 projectArtefactsResource = new DbtCloud.ProjectArtefacts("projectArtefactsResource", new()
    {
        ProjectId = 0,
        DocsJobId = 0,
        FreshnessJobId = 0,
    });
    
    example, err := dbtcloud.NewProjectArtefacts(ctx, "projectArtefactsResource", &dbtcloud.ProjectArtefactsArgs{
    	ProjectId:      pulumi.Int(0),
    	DocsJobId:      pulumi.Int(0),
    	FreshnessJobId: pulumi.Int(0),
    })
    
    var projectArtefactsResource = new ProjectArtefacts("projectArtefactsResource", ProjectArtefactsArgs.builder()
        .projectId(0)
        .docsJobId(0)
        .freshnessJobId(0)
        .build());
    
    project_artefacts_resource = dbtcloud.ProjectArtefacts("projectArtefactsResource",
        project_id=0,
        docs_job_id=0,
        freshness_job_id=0)
    
    const projectArtefactsResource = new dbtcloud.ProjectArtefacts("projectArtefactsResource", {
        projectId: 0,
        docsJobId: 0,
        freshnessJobId: 0,
    });
    
    type: dbtcloud:ProjectArtefacts
    properties:
        docsJobId: 0
        freshnessJobId: 0
        projectId: 0
    

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

    ProjectId int
    Project ID
    DocsJobId int
    Docs Job ID
    FreshnessJobId int
    Freshness Job ID
    ProjectId int
    Project ID
    DocsJobId int
    Docs Job ID
    FreshnessJobId int
    Freshness Job ID
    projectId Integer
    Project ID
    docsJobId Integer
    Docs Job ID
    freshnessJobId Integer
    Freshness Job ID
    projectId number
    Project ID
    docsJobId number
    Docs Job ID
    freshnessJobId number
    Freshness Job ID
    project_id int
    Project ID
    docs_job_id int
    Docs Job ID
    freshness_job_id int
    Freshness Job ID
    projectId Number
    Project ID
    docsJobId Number
    Docs Job ID
    freshnessJobId Number
    Freshness Job ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectArtefacts 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 ProjectArtefacts Resource

    Get an existing ProjectArtefacts 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?: ProjectArtefactsState, opts?: CustomResourceOptions): ProjectArtefacts
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            docs_job_id: Optional[int] = None,
            freshness_job_id: Optional[int] = None,
            project_id: Optional[int] = None) -> ProjectArtefacts
    func GetProjectArtefacts(ctx *Context, name string, id IDInput, state *ProjectArtefactsState, opts ...ResourceOption) (*ProjectArtefacts, error)
    public static ProjectArtefacts Get(string name, Input<string> id, ProjectArtefactsState? state, CustomResourceOptions? opts = null)
    public static ProjectArtefacts get(String name, Output<String> id, ProjectArtefactsState 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:
    DocsJobId int
    Docs Job ID
    FreshnessJobId int
    Freshness Job ID
    ProjectId int
    Project ID
    DocsJobId int
    Docs Job ID
    FreshnessJobId int
    Freshness Job ID
    ProjectId int
    Project ID
    docsJobId Integer
    Docs Job ID
    freshnessJobId Integer
    Freshness Job ID
    projectId Integer
    Project ID
    docsJobId number
    Docs Job ID
    freshnessJobId number
    Freshness Job ID
    projectId number
    Project ID
    docs_job_id int
    Docs Job ID
    freshness_job_id int
    Freshness Job ID
    project_id int
    Project ID
    docsJobId Number
    Docs Job ID
    freshnessJobId Number
    Freshness Job ID
    projectId Number
    Project ID

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_project_artefacts.my_artefacts

    id = “project_id”

    }

    import {

    to = dbtcloud_project_artefacts.my_artefacts

    id = “12345”

    }

    using the older import command

    $ pulumi import dbtcloud:index/projectArtefacts:ProjectArtefacts my_artefacts "project_id"
    
    $ pulumi import dbtcloud:index/projectArtefacts:ProjectArtefacts my_artefacts 12345
    

    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.10 published on Thursday, Jul 18, 2024 by Pulumi