1. Packages
  2. Packages
  3. dbt Cloud Provider
  4. API Docs
  5. StarburstCredential
Viewing docs for dbt Cloud v1.8.1
published on Friday, May 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

dbtcloud.StarburstCredential

dbtcloud logo
Viewing docs for dbt Cloud v1.8.1
published on Friday, May 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

    Starburst/Trino credential resource

    Example Usage

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

// Using the classic sensitive attribute (stored in state)
const example = new dbtcloud.StarburstCredential("example", {
    projectId: exampleDbtcloudProject.id,
    database: "your_catalog",
    schema: "your_schema",
    user: "your_user",
    password: "your_password",
});
const config = new pulumi.Config();
const starburstPassword = config.require("starburstPassword");
const exampleWo = new dbtcloud.StarburstCredential("example_wo", {
    projectId: exampleDbtcloudProject.id,
    database: "your_catalog",
    schema: "your_schema",
    user: "your_user",
    passwordWo: starburstPassword,
    passwordWoVersion: 1,
});

    import pulumi
import pulumi_dbtcloud as dbtcloud

# Using the classic sensitive attribute (stored in state)
example = dbtcloud.StarburstCredential("example",
    project_id=example_dbtcloud_project["id"],
    database="your_catalog",
    schema="your_schema",
    user="your_user",
    password="your_password")
config = pulumi.Config()
starburst_password = config.require("starburstPassword")
example_wo = dbtcloud.StarburstCredential("example_wo",
    project_id=example_dbtcloud_project["id"],
    database="your_catalog",
    schema="your_schema",
    user="your_user",
    password_wo=starburst_password,
    password_wo_version=1)

    package main

import (
	"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Using the classic sensitive attribute (stored in state)
		_, err := dbtcloud.NewStarburstCredential(ctx, "example", &dbtcloud.StarburstCredentialArgs{
			ProjectId: pulumi.Any(exampleDbtcloudProject.Id),
			Database:  pulumi.String("your_catalog"),
			Schema:    pulumi.String("your_schema"),
			User:      pulumi.String("your_user"),
			Password:  pulumi.String("your_password"),
		})
		if err != nil {
			return err
		}
		cfg := config.New(ctx, "")
		starburstPassword := cfg.Require("starburstPassword")
		_, err = dbtcloud.NewStarburstCredential(ctx, "example_wo", &dbtcloud.StarburstCredentialArgs{
			ProjectId:         pulumi.Any(exampleDbtcloudProject.Id),
			Database:          pulumi.String("your_catalog"),
			Schema:            pulumi.String("your_schema"),
			User:              pulumi.String("your_user"),
			PasswordWo:        pulumi.String(pulumi.String(starburstPassword)),
			PasswordWoVersion: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Using the classic sensitive attribute (stored in state)
    var example = new DbtCloud.Index.StarburstCredential("example", new()
    {
        ProjectId = exampleDbtcloudProject.Id,
        Database = "your_catalog",
        Schema = "your_schema",
        User = "your_user",
        Password = "your_password",
    });

    var config = new Config();
    var starburstPassword = config.Require("starburstPassword");
    var exampleWo = new DbtCloud.Index.StarburstCredential("example_wo", new()
    {
        ProjectId = exampleDbtcloudProject.Id,
        Database = "your_catalog",
        Schema = "your_schema",
        User = "your_user",
        PasswordWo = starburstPassword,
        PasswordWoVersion = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.StarburstCredential;
import com.pulumi.dbtcloud.StarburstCredentialArgs;
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) {
        final var config = ctx.config();
        // Using the classic sensitive attribute (stored in state)
        var example = new StarburstCredential("example", StarburstCredentialArgs.builder()
            .projectId(exampleDbtcloudProject.id())
            .database("your_catalog")
            .schema("your_schema")
            .user("your_user")
            .password("your_password")
            .build());

        final var starburstPassword = config.require("starburstPassword");
        var exampleWo = new StarburstCredential("exampleWo", StarburstCredentialArgs.builder()
            .projectId(exampleDbtcloudProject.id())
            .database("your_catalog")
            .schema("your_schema")
            .user("your_user")
            .passwordWo(starburstPassword)
            .passwordWoVersion(1)
            .build());

    }
}

    configuration:
  # Using write-only attributes (not stored in state, requires Terraform >= 1.11)
  # //
  # // The password_wo value is never persisted in the Terraform state file.
  # // Use password_wo_version to trigger an update when the password changes.
  starburstPassword:
    type: string
resources:
  # Using the classic sensitive attribute (stored in state)
  example:
    type: dbtcloud:StarburstCredential
    properties:
      projectId: ${exampleDbtcloudProject.id}
      database: your_catalog
      schema: your_schema
      user: your_user
      password: your_password
  exampleWo:
    type: dbtcloud:StarburstCredential
    name: example_wo
    properties:
      projectId: ${exampleDbtcloudProject.id}
      database: your_catalog
      schema: your_schema
      user: your_user
      passwordWo: ${starburstPassword}
      passwordWoVersion: 1

    Create StarburstCredential Resource

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

    Constructor syntax

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

@overload
def StarburstCredential(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        database: Optional[str] = None,
                        project_id: Optional[int] = None,
                        schema: Optional[str] = None,
                        user: Optional[str] = None,
                        password: Optional[str] = None,
                        password_wo: Optional[str] = None,
                        password_wo_version: Optional[int] = None)
    func NewStarburstCredential(ctx *Context, name string, args StarburstCredentialArgs, opts ...ResourceOption) (*StarburstCredential, error)
    public StarburstCredential(string name, StarburstCredentialArgs args, CustomResourceOptions? opts = null)
    public StarburstCredential(String name, StarburstCredentialArgs args)
public StarburstCredential(String name, StarburstCredentialArgs args, CustomResourceOptions options)

    type: dbtcloud:StarburstCredential
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 StarburstCredentialArgs
    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 StarburstCredentialArgs
    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 StarburstCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StarburstCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StarburstCredentialArgs
    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 starburstCredentialResource = new DbtCloud.StarburstCredential("starburstCredentialResource", new()
{
    Database = "string",
    ProjectId = 0,
    Schema = "string",
    User = "string",
    Password = "string",
    PasswordWo = "string",
    PasswordWoVersion = 0,
});

    example, err := dbtcloud.NewStarburstCredential(ctx, "starburstCredentialResource", &dbtcloud.StarburstCredentialArgs{
	Database:          pulumi.String("string"),
	ProjectId:         pulumi.Int(0),
	Schema:            pulumi.String("string"),
	User:              pulumi.String("string"),
	Password:          pulumi.String("string"),
	PasswordWo:        pulumi.String("string"),
	PasswordWoVersion: pulumi.Int(0),
})

    var starburstCredentialResource = new StarburstCredential("starburstCredentialResource", StarburstCredentialArgs.builder()
    .database("string")
    .projectId(0)
    .schema("string")
    .user("string")
    .password("string")
    .passwordWo("string")
    .passwordWoVersion(0)
    .build());

    starburst_credential_resource = dbtcloud.StarburstCredential("starburstCredentialResource",
    database="string",
    project_id=0,
    schema="string",
    user="string",
    password="string",
    password_wo="string",
    password_wo_version=0)

    const starburstCredentialResource = new dbtcloud.StarburstCredential("starburstCredentialResource", {
    database: "string",
    projectId: 0,
    schema: "string",
    user: "string",
    password: "string",
    passwordWo: "string",
    passwordWoVersion: 0,
});

    type: dbtcloud:StarburstCredential
properties:
    database: string
    password: string
    passwordWo: string
    passwordWoVersion: 0
    projectId: 0
    schema: string
    user: string

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

    Database string
    The catalog to connect use
    ProjectId int
    Project ID to create the Starburst/Trino credential in
    Schema string
    The schema where to create models
    User string
    The username for the Starburst/Trino account
    Password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    PasswordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    Database string
    The catalog to connect use
    ProjectId int
    Project ID to create the Starburst/Trino credential in
    Schema string
    The schema where to create models
    User string
    The username for the Starburst/Trino account
    Password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    PasswordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    database String
    The catalog to connect use
    projectId Integer
    Project ID to create the Starburst/Trino credential in
    schema String
    The schema where to create models
    user String
    The username for the Starburst/Trino account
    password String
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Integer
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    database string
    The catalog to connect use
    projectId number
    Project ID to create the Starburst/Trino credential in
    schema string
    The schema where to create models
    user string
    The username for the Starburst/Trino account
    password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    database str
    The catalog to connect use
    project_id int
    Project ID to create the Starburst/Trino credential in
    schema str
    The schema where to create models
    user str
    The username for the Starburst/Trino account
    password str
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    password_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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    password_wo_version int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    database String
    The catalog to connect use
    projectId Number
    Project ID to create the Starburst/Trino credential in
    schema String
    The schema where to create models
    user String
    The username for the Starburst/Trino account
    password String
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.

    Outputs

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

    CredentialId int
    The internal credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    CredentialId int
    The internal credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    credentialId Integer
    The internal credential ID
    id String
    The provider-assigned unique ID for this managed resource.
    credentialId number
    The internal credential ID
    id string
    The provider-assigned unique ID for this managed resource.
    credential_id int
    The internal credential ID
    id str
    The provider-assigned unique ID for this managed resource.
    credentialId Number
    The internal credential ID
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StarburstCredential Resource

    Get an existing StarburstCredential 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?: StarburstCredentialState, opts?: CustomResourceOptions): StarburstCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_id: Optional[int] = None,
        database: Optional[str] = None,
        password: Optional[str] = None,
        password_wo: Optional[str] = None,
        password_wo_version: Optional[int] = None,
        project_id: Optional[int] = None,
        schema: Optional[str] = None,
        user: Optional[str] = None) -> StarburstCredential
    func GetStarburstCredential(ctx *Context, name string, id IDInput, state *StarburstCredentialState, opts ...ResourceOption) (*StarburstCredential, error)
    public static StarburstCredential Get(string name, Input<string> id, StarburstCredentialState? state, CustomResourceOptions? opts = null)
    public static StarburstCredential get(String name, Output<String> id, StarburstCredentialState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:StarburstCredential    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:
    CredentialId int
    The internal credential ID
    Database string
    The catalog to connect use
    Password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    PasswordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    ProjectId int
    Project ID to create the Starburst/Trino credential in
    Schema string
    The schema where to create models
    User string
    The username for the Starburst/Trino account
    CredentialId int
    The internal credential ID
    Database string
    The catalog to connect use
    Password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    PasswordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    ProjectId int
    Project ID to create the Starburst/Trino credential in
    Schema string
    The schema where to create models
    User string
    The username for the Starburst/Trino account
    credentialId Integer
    The internal credential ID
    database String
    The catalog to connect use
    password String
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Integer
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId Integer
    Project ID to create the Starburst/Trino credential in
    schema String
    The schema where to create models
    user String
    The username for the Starburst/Trino account
    credentialId number
    The internal credential ID
    database string
    The catalog to connect use
    password string
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId number
    Project ID to create the Starburst/Trino credential in
    schema string
    The schema where to create models
    user string
    The username for the Starburst/Trino account
    credential_id int
    The internal credential ID
    database str
    The catalog to connect use
    password str
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    password_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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    password_wo_version int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    project_id int
    Project ID to create the Starburst/Trino credential in
    schema str
    The schema where to create models
    user str
    The username for the Starburst/Trino account
    credentialId Number
    The internal credential ID
    database String
    The catalog to connect use
    password String
    The password for the Starburst/Trino account. Consider using passwordWo instead, which is not stored in state.
    passwordWo 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 password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId Number
    Project ID to create the Starburst/Trino credential in
    schema String
    The schema where to create models
    user String
    The username for the Starburst/Trino account

    Import

    using import blocks (requires Terraform >= 1.5) import { to = dbtcloud_starburst_credential.my_starburst_credential id = “project_id:credential_id” }

    import { to = dbtcloud_starburst_credential.my_starburst_credential id = “12345:6789” }

    using the older import command

    $ pulumi import dbtcloud:index/starburstCredential:StarburstCredential my_starburst_credential "project_id:credential_id"
$ pulumi import dbtcloud:index/starburstCredential:StarburstCredential my_starburst_credential 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
    Viewing docs for dbt Cloud v1.8.1
    published on Friday, May 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-dbtcloud
      Try Pulumi Cloud free. Your team will thank you.