1. Packages
  2. Packages
  3. dbt Cloud Provider
  4. API Docs
  5. LineageIntegration
Viewing docs for dbt Cloud v1.8.0
published on Wednesday, Apr 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

dbtcloud.LineageIntegration

dbtcloud logo
Viewing docs for dbt Cloud v1.8.0
published on Wednesday, Apr 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

    Setup lineage integration for dbt Cloud to automatically fetch lineage from external BI tools in dbt Explorer. Currently supports Tableau.

    This resource requires having an environment tagged as production already created for you project.

    Create LineageIntegration Resource

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

    Constructor syntax

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

@overload
def LineageIntegration(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       host: Optional[str] = None,
                       project_id: Optional[int] = None,
                       site_id: Optional[str] = None,
                       token_name: Optional[str] = None,
                       token: Optional[str] = None,
                       token_wo: Optional[str] = None,
                       token_wo_version: Optional[int] = None)
    func NewLineageIntegration(ctx *Context, name string, args LineageIntegrationArgs, opts ...ResourceOption) (*LineageIntegration, error)
    public LineageIntegration(string name, LineageIntegrationArgs args, CustomResourceOptions? opts = null)
    public LineageIntegration(String name, LineageIntegrationArgs args)
public LineageIntegration(String name, LineageIntegrationArgs args, CustomResourceOptions options)

    type: dbtcloud:LineageIntegration
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 LineageIntegrationArgs
    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 LineageIntegrationArgs
    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 LineageIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LineageIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LineageIntegrationArgs
    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 lineageIntegrationResource = new DbtCloud.LineageIntegration("lineageIntegrationResource", new()
{
    Host = "string",
    ProjectId = 0,
    SiteId = "string",
    TokenName = "string",
    Token = "string",
    TokenWo = "string",
    TokenWoVersion = 0,
});

    example, err := dbtcloud.NewLineageIntegration(ctx, "lineageIntegrationResource", &dbtcloud.LineageIntegrationArgs{
	Host:           pulumi.String("string"),
	ProjectId:      pulumi.Int(0),
	SiteId:         pulumi.String("string"),
	TokenName:      pulumi.String("string"),
	Token:          pulumi.String("string"),
	TokenWo:        pulumi.String("string"),
	TokenWoVersion: pulumi.Int(0),
})

    var lineageIntegrationResource = new LineageIntegration("lineageIntegrationResource", LineageIntegrationArgs.builder()
    .host("string")
    .projectId(0)
    .siteId("string")
    .tokenName("string")
    .token("string")
    .tokenWo("string")
    .tokenWoVersion(0)
    .build());

    lineage_integration_resource = dbtcloud.LineageIntegration("lineageIntegrationResource",
    host="string",
    project_id=0,
    site_id="string",
    token_name="string",
    token="string",
    token_wo="string",
    token_wo_version=0)

    const lineageIntegrationResource = new dbtcloud.LineageIntegration("lineageIntegrationResource", {
    host: "string",
    projectId: 0,
    siteId: "string",
    tokenName: "string",
    token: "string",
    tokenWo: "string",
    tokenWoVersion: 0,
});

    type: dbtcloud:LineageIntegration
properties:
    host: string
    projectId: 0
    siteId: string
    token: string
    tokenName: string
    tokenWo: string
    tokenWoVersion: 0

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

    Host string
    The URL of the BI server (see docs for more details)
    ProjectId int
    The dbt Cloud project ID for the integration
    SiteId string
    The sitename for the collections of dashboards (see docs for more details)
    TokenName string
    The token to use to authenticate to the BI server
    Token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    TokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    TokenWoVersion int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    Host string
    The URL of the BI server (see docs for more details)
    ProjectId int
    The dbt Cloud project ID for the integration
    SiteId string
    The sitename for the collections of dashboards (see docs for more details)
    TokenName string
    The token to use to authenticate to the BI server
    Token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    TokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    TokenWoVersion int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host String
    The URL of the BI server (see docs for more details)
    projectId Integer
    The dbt Cloud project ID for the integration
    siteId String
    The sitename for the collections of dashboards (see docs for more details)
    tokenName String
    The token to use to authenticate to the BI server
    token String
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion Integer
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host string
    The URL of the BI server (see docs for more details)
    projectId number
    The dbt Cloud project ID for the integration
    siteId string
    The sitename for the collections of dashboards (see docs for more details)
    tokenName string
    The token to use to authenticate to the BI server
    token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion number
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host str
    The URL of the BI server (see docs for more details)
    project_id int
    The dbt Cloud project ID for the integration
    site_id str
    The sitename for the collections of dashboards (see docs for more details)
    token_name str
    The token to use to authenticate to the BI server
    token str
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    token_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    token_wo_version int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host String
    The URL of the BI server (see docs for more details)
    projectId Number
    The dbt Cloud project ID for the integration
    siteId String
    The sitename for the collections of dashboards (see docs for more details)
    tokenName String
    The token to use to authenticate to the BI server
    token String
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion Number
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LineageIntegrationId int
    The ID of the lineage integration
    Name string
    The integration type. Today only 'tableau' is supported
    Id string
    The provider-assigned unique ID for this managed resource.
    LineageIntegrationId int
    The ID of the lineage integration
    Name string
    The integration type. Today only 'tableau' is supported
    id String
    The provider-assigned unique ID for this managed resource.
    lineageIntegrationId Integer
    The ID of the lineage integration
    name String
    The integration type. Today only 'tableau' is supported
    id string
    The provider-assigned unique ID for this managed resource.
    lineageIntegrationId number
    The ID of the lineage integration
    name string
    The integration type. Today only 'tableau' is supported
    id str
    The provider-assigned unique ID for this managed resource.
    lineage_integration_id int
    The ID of the lineage integration
    name str
    The integration type. Today only 'tableau' is supported
    id String
    The provider-assigned unique ID for this managed resource.
    lineageIntegrationId Number
    The ID of the lineage integration
    name String
    The integration type. Today only 'tableau' is supported

    Look up Existing LineageIntegration Resource

    Get an existing LineageIntegration 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?: LineageIntegrationState, opts?: CustomResourceOptions): LineageIntegration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        host: Optional[str] = None,
        lineage_integration_id: Optional[int] = None,
        name: Optional[str] = None,
        project_id: Optional[int] = None,
        site_id: Optional[str] = None,
        token: Optional[str] = None,
        token_name: Optional[str] = None,
        token_wo: Optional[str] = None,
        token_wo_version: Optional[int] = None) -> LineageIntegration
    func GetLineageIntegration(ctx *Context, name string, id IDInput, state *LineageIntegrationState, opts ...ResourceOption) (*LineageIntegration, error)
    public static LineageIntegration Get(string name, Input<string> id, LineageIntegrationState? state, CustomResourceOptions? opts = null)
    public static LineageIntegration get(String name, Output<String> id, LineageIntegrationState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:LineageIntegration    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:
    Host string
    The URL of the BI server (see docs for more details)
    LineageIntegrationId int
    The ID of the lineage integration
    Name string
    The integration type. Today only 'tableau' is supported
    ProjectId int
    The dbt Cloud project ID for the integration
    SiteId string
    The sitename for the collections of dashboards (see docs for more details)
    Token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    TokenName string
    The token to use to authenticate to the BI server
    TokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    TokenWoVersion int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    Host string
    The URL of the BI server (see docs for more details)
    LineageIntegrationId int
    The ID of the lineage integration
    Name string
    The integration type. Today only 'tableau' is supported
    ProjectId int
    The dbt Cloud project ID for the integration
    SiteId string
    The sitename for the collections of dashboards (see docs for more details)
    Token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    TokenName string
    The token to use to authenticate to the BI server
    TokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    TokenWoVersion int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host String
    The URL of the BI server (see docs for more details)
    lineageIntegrationId Integer
    The ID of the lineage integration
    name String
    The integration type. Today only 'tableau' is supported
    projectId Integer
    The dbt Cloud project ID for the integration
    siteId String
    The sitename for the collections of dashboards (see docs for more details)
    token String
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenName String
    The token to use to authenticate to the BI server
    tokenWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion Integer
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host string
    The URL of the BI server (see docs for more details)
    lineageIntegrationId number
    The ID of the lineage integration
    name string
    The integration type. Today only 'tableau' is supported
    projectId number
    The dbt Cloud project ID for the integration
    siteId string
    The sitename for the collections of dashboards (see docs for more details)
    token string
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenName string
    The token to use to authenticate to the BI server
    tokenWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion number
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host str
    The URL of the BI server (see docs for more details)
    lineage_integration_id int
    The ID of the lineage integration
    name str
    The integration type. Today only 'tableau' is supported
    project_id int
    The dbt Cloud project ID for the integration
    site_id str
    The sitename for the collections of dashboards (see docs for more details)
    token str
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    token_name str
    The token to use to authenticate to the BI server
    token_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    token_wo_version int
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.
    host String
    The URL of the BI server (see docs for more details)
    lineageIntegrationId Number
    The ID of the lineage integration
    name String
    The integration type. Today only 'tableau' is supported
    projectId Number
    The dbt Cloud project ID for the integration
    siteId String
    The sitename for the collections of dashboards (see docs for more details)
    token String
    The secret token value to use to authenticate to the BI server. Consider using tokenWo instead, which is not stored in state.
    tokenName String
    The token to use to authenticate to the BI server
    tokenWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to token. The value is not stored in state. Requires tokenWoVersion to trigger updates.
    tokenWoVersion Number
    Version number for tokenWo. Increment this value to trigger an update of the token when using tokenWo.

    Import

    using import blocks (requires Terraform >= 1.5) import { to = dbtcloud_lineage_integration.my_lineage_integration id = “projet_id:lineage_integration_id” }

    import { to = dbtcloud_lineage_integration.my_lineage_integration id = “123:4567” }

    using the older import command

    $ pulumi import dbtcloud:index/lineageIntegration:LineageIntegration my_lineage_integration "projet_id:lineage_integration_id"
$ pulumi import dbtcloud:index/lineageIntegration:LineageIntegration my_lineage_integration 123:4567

    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
    Viewing docs for dbt Cloud v1.8.0
    published on Wednesday, Apr 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-dbtcloud
      Try Pulumi Cloud free. Your team will thank you.