1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. StarburstCredential
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

dbtcloud.StarburstCredential

Explore with Pulumi AI

Starburst/Trino credential resource

Example Usage

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

const example = new dbtcloud.StarburstCredential("example", {
    projectId: exampleDbtcloudProject.id,
    database: "your_catalog",
    schema: "your_schema",
    user: "your_user",
    password: "your_password",
});
Copy
import pulumi
import pulumi_dbtcloud as dbtcloud

example = dbtcloud.StarburstCredential("example",
    project_id=example_dbtcloud_project["id"],
    database="your_catalog",
    schema="your_schema",
    user="your_user",
    password="your_password")
Copy
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.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
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DbtCloud = Pulumi.DbtCloud;

return await Deployment.RunAsync(() => 
{
    var example = new DbtCloud.StarburstCredential("example", new()
    {
        ProjectId = exampleDbtcloudProject.Id,
        Database = "your_catalog",
        Schema = "your_schema",
        User = "your_user",
        Password = "your_password",
    });

});
Copy
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) {
        var example = new StarburstCredential("example", StarburstCredentialArgs.builder()
            .projectId(exampleDbtcloudProject.id())
            .database("your_catalog")
            .schema("your_schema")
            .user("your_user")
            .password("your_password")
            .build());

    }
}
Copy
resources:
  example:
    type: dbtcloud:StarburstCredential
    properties:
      projectId: ${exampleDbtcloudProject.id}
      database: your_catalog
      schema: your_schema
      user: your_user
      password: your_password
Copy

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,
                        password: Optional[str] = None,
                        project_id: Optional[int] = None,
                        schema: Optional[str] = None,
                        user: Optional[str] = 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 This property is required. string
The unique name of the resource.
args This property is required. StarburstCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. StarburstCredentialArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StarburstCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    Password = "string",
    ProjectId = 0,
    Schema = "string",
    User = "string",
});
Copy
example, err := dbtcloud.NewStarburstCredential(ctx, "starburstCredentialResource", &dbtcloud.StarburstCredentialArgs{
	Database:  pulumi.String("string"),
	Password:  pulumi.String("string"),
	ProjectId: pulumi.Int(0),
	Schema:    pulumi.String("string"),
	User:      pulumi.String("string"),
})
Copy
var starburstCredentialResource = new StarburstCredential("starburstCredentialResource", StarburstCredentialArgs.builder()
    .database("string")
    .password("string")
    .projectId(0)
    .schema("string")
    .user("string")
    .build());
Copy
starburst_credential_resource = dbtcloud.StarburstCredential("starburstCredentialResource",
    database="string",
    password="string",
    project_id=0,
    schema="string",
    user="string")
Copy
const starburstCredentialResource = new dbtcloud.StarburstCredential("starburstCredentialResource", {
    database: "string",
    password: "string",
    projectId: 0,
    schema: "string",
    user: "string",
});
Copy
type: dbtcloud:StarburstCredential
properties:
    database: string
    password: string
    projectId: 0
    schema: string
    user: string
Copy

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 This property is required. string
The catalog to connect use
Password This property is required. string
The password for the Starburst/Trino account
ProjectId This property is required. int
Project ID to create the Starburst/Trino credential in
Schema This property is required. string
The schema where to create models
User This property is required. string
The username for the Starburst/Trino account
Database This property is required. string
The catalog to connect use
Password This property is required. string
The password for the Starburst/Trino account
ProjectId This property is required. int
Project ID to create the Starburst/Trino credential in
Schema This property is required. string
The schema where to create models
User This property is required. string
The username for the Starburst/Trino account
database This property is required. String
The catalog to connect use
password This property is required. String
The password for the Starburst/Trino account
projectId This property is required. Integer
Project ID to create the Starburst/Trino credential in
schema This property is required. String
The schema where to create models
user This property is required. String
The username for the Starburst/Trino account
database This property is required. string
The catalog to connect use
password This property is required. string
The password for the Starburst/Trino account
projectId This property is required. number
Project ID to create the Starburst/Trino credential in
schema This property is required. string
The schema where to create models
user This property is required. string
The username for the Starburst/Trino account
database This property is required. str
The catalog to connect use
password This property is required. str
The password for the Starburst/Trino account
project_id This property is required. int
Project ID to create the Starburst/Trino credential in
schema This property is required. str
The schema where to create models
user This property is required. str
The username for the Starburst/Trino account
database This property is required. String
The catalog to connect use
password This property is required. String
The password for the Starburst/Trino account
projectId This property is required. Number
Project ID to create the Starburst/Trino credential in
schema This property is required. String
The schema where to create models
user This property is required. String
The username for the Starburst/Trino account

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,
        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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
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
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
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
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
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
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"
Copy
$ pulumi import dbtcloud:index/starburstCredential:StarburstCredential my_starburst_credential 12345:6789
Copy

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.