Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. BigQueryCredential
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

dbtcloud.BigQueryCredential

Explore with Pulumi AI

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

Example Usage

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

const myCredential = new dbtcloud.BigQueryCredential("my_credential", {
    projectId: dbtProject.id,
    dataset: "my_bq_dataset",
    numThreads: 16,
});
Copy
import pulumi
import pulumi_dbtcloud as dbtcloud

my_credential = dbtcloud.BigQueryCredential("my_credential",
    project_id=dbt_project["id"],
    dataset="my_bq_dataset",
    num_threads=16)
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.NewBigQueryCredential(ctx, "my_credential", &dbtcloud.BigQueryCredentialArgs{
			ProjectId:  pulumi.Any(dbtProject.Id),
			Dataset:    pulumi.String("my_bq_dataset"),
			NumThreads: pulumi.Int(16),
		})
		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 myCredential = new DbtCloud.BigQueryCredential("my_credential", new()
    {
        ProjectId = dbtProject.Id,
        Dataset = "my_bq_dataset",
        NumThreads = 16,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.BigQueryCredential;
import com.pulumi.dbtcloud.BigQueryCredentialArgs;
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 myCredential = new BigQueryCredential("myCredential", BigQueryCredentialArgs.builder()
            .projectId(dbtProject.id())
            .dataset("my_bq_dataset")
            .numThreads(16)
            .build());

    }
}
Copy
resources:
  myCredential:
    type: dbtcloud:BigQueryCredential
    name: my_credential
    properties:
      projectId: ${dbtProject.id}
      dataset: my_bq_dataset
      numThreads: 16
Copy

Create BigQueryCredential Resource

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

Constructor syntax

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

@overload
def BigQueryCredential(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       dataset: Optional[str] = None,
                       num_threads: Optional[int] = None,
                       project_id: Optional[int] = None,
                       is_active: Optional[bool] = None)
func NewBigQueryCredential(ctx *Context, name string, args BigQueryCredentialArgs, opts ...ResourceOption) (*BigQueryCredential, error)
public BigQueryCredential(string name, BigQueryCredentialArgs args, CustomResourceOptions? opts = null)
public BigQueryCredential(String name, BigQueryCredentialArgs args)
public BigQueryCredential(String name, BigQueryCredentialArgs args, CustomResourceOptions options)

type: dbtcloud:BigQueryCredential
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. BigQueryCredentialArgs
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. BigQueryCredentialArgs
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. BigQueryCredentialArgs
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. BigQueryCredentialArgs
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. BigQueryCredentialArgs
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 bigQueryCredentialResource = new DbtCloud.BigQueryCredential("bigQueryCredentialResource", new()
{
    Dataset = "string",
    NumThreads = 0,
    ProjectId = 0,
    IsActive = false,
});
Copy
example, err := dbtcloud.NewBigQueryCredential(ctx, "bigQueryCredentialResource", &dbtcloud.BigQueryCredentialArgs{
	Dataset:    pulumi.String("string"),
	NumThreads: pulumi.Int(0),
	ProjectId:  pulumi.Int(0),
	IsActive:   pulumi.Bool(false),
})
Copy
var bigQueryCredentialResource = new BigQueryCredential("bigQueryCredentialResource", BigQueryCredentialArgs.builder()
    .dataset("string")
    .numThreads(0)
    .projectId(0)
    .isActive(false)
    .build());
Copy
big_query_credential_resource = dbtcloud.BigQueryCredential("bigQueryCredentialResource",
    dataset="string",
    num_threads=0,
    project_id=0,
    is_active=False)
Copy
const bigQueryCredentialResource = new dbtcloud.BigQueryCredential("bigQueryCredentialResource", {
    dataset: "string",
    numThreads: 0,
    projectId: 0,
    isActive: false,
});
Copy
type: dbtcloud:BigQueryCredential
properties:
    dataset: string
    isActive: false
    numThreads: 0
    projectId: 0
Copy

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

Dataset This property is required. string
Default dataset name
NumThreads This property is required. int
Number of threads to use
ProjectId
This property is required.
Changes to this property will trigger replacement.
int
Project ID to create the BigQuery credential in
IsActive bool
Whether the BigQuery credential is active
Dataset This property is required. string
Default dataset name
NumThreads This property is required. int
Number of threads to use
ProjectId
This property is required.
Changes to this property will trigger replacement.
int
Project ID to create the BigQuery credential in
IsActive bool
Whether the BigQuery credential is active
dataset This property is required. String
Default dataset name
numThreads This property is required. Integer
Number of threads to use
projectId
This property is required.
Changes to this property will trigger replacement.
Integer
Project ID to create the BigQuery credential in
isActive Boolean
Whether the BigQuery credential is active
dataset This property is required. string
Default dataset name
numThreads This property is required. number
Number of threads to use
projectId
This property is required.
Changes to this property will trigger replacement.
number
Project ID to create the BigQuery credential in
isActive boolean
Whether the BigQuery credential is active
dataset This property is required. str
Default dataset name
num_threads This property is required. int
Number of threads to use
project_id
This property is required.
Changes to this property will trigger replacement.
int
Project ID to create the BigQuery credential in
is_active bool
Whether the BigQuery credential is active
dataset This property is required. String
Default dataset name
numThreads This property is required. Number
Number of threads to use
projectId
This property is required.
Changes to this property will trigger replacement.
Number
Project ID to create the BigQuery credential in
isActive Boolean
Whether the BigQuery credential is active

Outputs

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

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

Look up Existing BigQueryCredential Resource

Get an existing BigQueryCredential 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?: BigQueryCredentialState, opts?: CustomResourceOptions): BigQueryCredential
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_id: Optional[int] = None,
        dataset: Optional[str] = None,
        is_active: Optional[bool] = None,
        num_threads: Optional[int] = None,
        project_id: Optional[int] = None) -> BigQueryCredential
func GetBigQueryCredential(ctx *Context, name string, id IDInput, state *BigQueryCredentialState, opts ...ResourceOption) (*BigQueryCredential, error)
public static BigQueryCredential Get(string name, Input<string> id, BigQueryCredentialState? state, CustomResourceOptions? opts = null)
public static BigQueryCredential get(String name, Output<String> id, BigQueryCredentialState state, CustomResourceOptions options)
resources:  _:    type: dbtcloud:BigQueryCredential    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 system BigQuery credential ID
Dataset string
Default dataset name
IsActive bool
Whether the BigQuery credential is active
NumThreads int
Number of threads to use
ProjectId Changes to this property will trigger replacement. int
Project ID to create the BigQuery credential in
CredentialId int
The system BigQuery credential ID
Dataset string
Default dataset name
IsActive bool
Whether the BigQuery credential is active
NumThreads int
Number of threads to use
ProjectId Changes to this property will trigger replacement. int
Project ID to create the BigQuery credential in
credentialId Integer
The system BigQuery credential ID
dataset String
Default dataset name
isActive Boolean
Whether the BigQuery credential is active
numThreads Integer
Number of threads to use
projectId Changes to this property will trigger replacement. Integer
Project ID to create the BigQuery credential in
credentialId number
The system BigQuery credential ID
dataset string
Default dataset name
isActive boolean
Whether the BigQuery credential is active
numThreads number
Number of threads to use
projectId Changes to this property will trigger replacement. number
Project ID to create the BigQuery credential in
credential_id int
The system BigQuery credential ID
dataset str
Default dataset name
is_active bool
Whether the BigQuery credential is active
num_threads int
Number of threads to use
project_id Changes to this property will trigger replacement. int
Project ID to create the BigQuery credential in
credentialId Number
The system BigQuery credential ID
dataset String
Default dataset name
isActive Boolean
Whether the BigQuery credential is active
numThreads Number
Number of threads to use
projectId Changes to this property will trigger replacement. Number
Project ID to create the BigQuery credential in

Import

using import blocks (requires Terraform >= 1.5)

import {

to = dbtcloud_bigquery_credential.my_credential

id = “project_id:credential_id”

}

import {

to = dbtcloud_bigquery_credential.my_credential

id = “12345:5678”

}

using the older import command

$ pulumi import dbtcloud:index/bigQueryCredential:BigQueryCredential my_credential "project_id:credential_id"
Copy
$ pulumi import dbtcloud:index/bigQueryCredential:BigQueryCredential my_credential 12345:5678
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.
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud