dbt Cloud v0.1.30, Mar 20 25

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

dbtcloud.getGlobalConnection

Explore with Pulumi AI

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const myConnection = dbtcloud.getGlobalConnection({
    id: 1234,
});

import pulumi
import pulumi_dbtcloud as dbtcloud

my_connection = dbtcloud.get_global_connection(id=1234)

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.LookupGlobalConnection(ctx, &dbtcloud.LookupGlobalConnectionArgs{
			Id: 1234,
		}, nil)
		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 myConnection = DbtCloud.GetGlobalConnection.Invoke(new()
    {
        Id = 1234,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.DbtcloudFunctions;
import com.pulumi.dbtcloud.inputs.GetGlobalConnectionArgs;
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 myConnection = DbtcloudFunctions.getGlobalConnection(GetGlobalConnectionArgs.builder()
            .id(1234)
            .build());

    }
}

variables:
  myConnection:
    fn::invoke:
      function: dbtcloud:getGlobalConnection
      arguments:
        id: 1234

Using getGlobalConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getGlobalConnection(args: GetGlobalConnectionArgs, opts?: InvokeOptions): Promise<GetGlobalConnectionResult>
function getGlobalConnectionOutput(args: GetGlobalConnectionOutputArgs, opts?: InvokeOptions): Output<GetGlobalConnectionResult>

def get_global_connection(id: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGlobalConnectionResult
def get_global_connection_output(id: Optional[pulumi.Input[int]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGlobalConnectionResult]

func LookupGlobalConnection(ctx *Context, args *LookupGlobalConnectionArgs, opts ...InvokeOption) (*LookupGlobalConnectionResult, error)
func LookupGlobalConnectionOutput(ctx *Context, args *LookupGlobalConnectionOutputArgs, opts ...InvokeOption) LookupGlobalConnectionResultOutput

> Note: This function is named LookupGlobalConnection in the Go SDK.

public static class GetGlobalConnection 
{
    public static Task<GetGlobalConnectionResult> InvokeAsync(GetGlobalConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalConnectionResult> Invoke(GetGlobalConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalConnectionResult> getGlobalConnection(GetGlobalConnectionArgs args, InvokeOptions options)
public static Output<GetGlobalConnectionResult> getGlobalConnection(GetGlobalConnectionArgs args, InvokeOptions options)

fn::invoke:
  function: dbtcloud:index/getGlobalConnection:getGlobalConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

Id int: Connection Identifier

Id int: Connection Identifier

id Integer: Connection Identifier

id number: Connection Identifier

id int: Connection Identifier

id Number: Connection Identifier

getGlobalConnection Result

The following output properties are available:

AdapterVersion string: Version of the adapter
ApacheSpark Pulumi.DbtCloud.Outputs.GetGlobalConnectionApacheSpark: Apache Spark connection configuration.
Athena Pulumi.DbtCloud.Outputs.GetGlobalConnectionAthena: Athena connection configuration.
Bigquery Pulumi.DbtCloud.Outputs.GetGlobalConnectionBigquery
Databricks Pulumi.DbtCloud.Outputs.GetGlobalConnectionDatabricks: Databricks connection configuration
Fabric Pulumi.DbtCloud.Outputs.GetGlobalConnectionFabric: Microsoft Fabric connection configuration.
Id int: Connection Identifier
IsSshTunnelEnabled bool: Whether the connection can use an SSH tunnel
Name string: Connection name
OauthConfigurationId int
Postgres Pulumi.DbtCloud.Outputs.GetGlobalConnectionPostgres: PostgreSQL connection configuration.
PrivateLinkEndpointId string: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
Redshift Pulumi.DbtCloud.Outputs.GetGlobalConnectionRedshift: Redshift connection configuration
Snowflake Pulumi.DbtCloud.Outputs.GetGlobalConnectionSnowflake: Snowflake connection configuration
Starburst Pulumi.DbtCloud.Outputs.GetGlobalConnectionStarburst: Starburst/Trino connection configuration.
Synapse Pulumi.DbtCloud.Outputs.GetGlobalConnectionSynapse: Azure Synapse Analytics connection configuration.

AdapterVersion string: Version of the adapter
ApacheSpark GetGlobalConnectionApacheSpark: Apache Spark connection configuration.
Athena GetGlobalConnectionAthena: Athena connection configuration.
Bigquery GetGlobalConnectionBigquery
Databricks GetGlobalConnectionDatabricks: Databricks connection configuration
Fabric GetGlobalConnectionFabric: Microsoft Fabric connection configuration.
Id int: Connection Identifier
IsSshTunnelEnabled bool: Whether the connection can use an SSH tunnel
Name string: Connection name
OauthConfigurationId int
Postgres GetGlobalConnectionPostgres: PostgreSQL connection configuration.
PrivateLinkEndpointId string: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
Redshift GetGlobalConnectionRedshift: Redshift connection configuration
Snowflake GetGlobalConnectionSnowflake: Snowflake connection configuration
Starburst GetGlobalConnectionStarburst: Starburst/Trino connection configuration.
Synapse GetGlobalConnectionSynapse: Azure Synapse Analytics connection configuration.

adapterVersion String: Version of the adapter
apacheSpark GetGlobalConnectionApacheSpark: Apache Spark connection configuration.
athena GetGlobalConnectionAthena: Athena connection configuration.
bigquery GetGlobalConnectionBigquery
databricks GetGlobalConnectionDatabricks: Databricks connection configuration
fabric GetGlobalConnectionFabric: Microsoft Fabric connection configuration.
id Integer: Connection Identifier
isSshTunnelEnabled Boolean: Whether the connection can use an SSH tunnel
name String: Connection name
oauthConfigurationId Integer
postgres GetGlobalConnectionPostgres: PostgreSQL connection configuration.
privateLinkEndpointId String: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
redshift GetGlobalConnectionRedshift: Redshift connection configuration
snowflake GetGlobalConnectionSnowflake: Snowflake connection configuration
starburst GetGlobalConnectionStarburst: Starburst/Trino connection configuration.
synapse GetGlobalConnectionSynapse: Azure Synapse Analytics connection configuration.

adapterVersion string: Version of the adapter
apacheSpark GetGlobalConnectionApacheSpark: Apache Spark connection configuration.
athena GetGlobalConnectionAthena: Athena connection configuration.
bigquery GetGlobalConnectionBigquery
databricks GetGlobalConnectionDatabricks: Databricks connection configuration
fabric GetGlobalConnectionFabric: Microsoft Fabric connection configuration.
id number: Connection Identifier
isSshTunnelEnabled boolean: Whether the connection can use an SSH tunnel
name string: Connection name
oauthConfigurationId number
postgres GetGlobalConnectionPostgres: PostgreSQL connection configuration.
privateLinkEndpointId string: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
redshift GetGlobalConnectionRedshift: Redshift connection configuration
snowflake GetGlobalConnectionSnowflake: Snowflake connection configuration
starburst GetGlobalConnectionStarburst: Starburst/Trino connection configuration.
synapse GetGlobalConnectionSynapse: Azure Synapse Analytics connection configuration.

adapter_version str: Version of the adapter
apache_spark GetGlobalConnectionApacheSpark: Apache Spark connection configuration.
athena GetGlobalConnectionAthena: Athena connection configuration.
bigquery GetGlobalConnectionBigquery
databricks GetGlobalConnectionDatabricks: Databricks connection configuration
fabric GetGlobalConnectionFabric: Microsoft Fabric connection configuration.
id int: Connection Identifier
is_ssh_tunnel_enabled bool: Whether the connection can use an SSH tunnel
name str: Connection name
oauth_configuration_id int
postgres GetGlobalConnectionPostgres: PostgreSQL connection configuration.
private_link_endpoint_id str: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
redshift GetGlobalConnectionRedshift: Redshift connection configuration
snowflake GetGlobalConnectionSnowflake: Snowflake connection configuration
starburst GetGlobalConnectionStarburst: Starburst/Trino connection configuration.
synapse GetGlobalConnectionSynapse: Azure Synapse Analytics connection configuration.

adapterVersion String: Version of the adapter
apacheSpark Property Map: Apache Spark connection configuration.
athena Property Map: Athena connection configuration.
bigquery Property Map
databricks Property Map: Databricks connection configuration
fabric Property Map: Microsoft Fabric connection configuration.
id Number: Connection Identifier
isSshTunnelEnabled Boolean: Whether the connection can use an SSH tunnel
name String: Connection name
oauthConfigurationId Number
postgres Property Map: PostgreSQL connection configuration.
privateLinkEndpointId String: Private Link Endpoint ID. This ID can be found using the privatelink_endpoint data source
redshift Property Map: Redshift connection configuration
snowflake Property Map: Snowflake connection configuration
starburst Property Map: Starburst/Trino connection configuration.
synapse Property Map: Azure Synapse Analytics connection configuration.

Supporting Types

GetGlobalConnectionApacheSpark

Auth string: Auth
Cluster string: Spark cluster for the connection
ConnectRetries int: Connection retries. Default=0
ConnectTimeout int: Connection time out in seconds. Default=10
Host string: Hostname of the connection
Method string: Authentication method for the connection (http or thrift).
Organization string: Organization ID
Port int: Port for the connection. Default=443
User string: User

Auth string: Auth
Cluster string: Spark cluster for the connection
ConnectRetries int: Connection retries. Default=0
ConnectTimeout int: Connection time out in seconds. Default=10
Host string: Hostname of the connection
Method string: Authentication method for the connection (http or thrift).
Organization string: Organization ID
Port int: Port for the connection. Default=443
User string: User

auth String: Auth
cluster String: Spark cluster for the connection
connectRetries Integer: Connection retries. Default=0
connectTimeout Integer: Connection time out in seconds. Default=10
host String: Hostname of the connection
method String: Authentication method for the connection (http or thrift).
organization String: Organization ID
port Integer: Port for the connection. Default=443
user String: User

auth string: Auth
cluster string: Spark cluster for the connection
connectRetries number: Connection retries. Default=0
connectTimeout number: Connection time out in seconds. Default=10
host string: Hostname of the connection
method string: Authentication method for the connection (http or thrift).
organization string: Organization ID
port number: Port for the connection. Default=443
user string: User

auth str: Auth
cluster str: Spark cluster for the connection
connect_retries int: Connection retries. Default=0
connect_timeout int: Connection time out in seconds. Default=10
host str: Hostname of the connection
method str: Authentication method for the connection (http or thrift).
organization str: Organization ID
port int: Port for the connection. Default=443
user str: User

auth String: Auth
cluster String: Spark cluster for the connection
connectRetries Number: Connection retries. Default=0
connectTimeout Number: Connection time out in seconds. Default=10
host String: Hostname of the connection
method String: Authentication method for the connection (http or thrift).
organization String: Organization ID
port Number: Port for the connection. Default=443
user String: User

GetGlobalConnectionAthena

Database string: Specify the database (data catalog) to build models into (lowercase only).
NumBoto3Retries int: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
NumIcebergRetries int: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
NumRetries int: Number of times to retry a failing query.
PollInterval int: Interval in seconds to use for polling the status of query results in Athena.
RegionName string: AWS region of your Athena instance.
S3DataDir string: Prefix for storing tables, if different from the connection's S3 staging directory.
S3DataNaming string: How to generate table paths in the S3 data directory.
S3StagingDir string: S3 location to store Athena query results and metadata.
S3TmpTableDir string: Prefix for storing temporary tables, if different from the connection's S3 data directory.
SparkWorkGroup string: Identifier of Athena Spark workgroup for running Python models.
WorkGroup string: Identifier of Athena workgroup.

Database string: Specify the database (data catalog) to build models into (lowercase only).
NumBoto3Retries int: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
NumIcebergRetries int: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
NumRetries int: Number of times to retry a failing query.
PollInterval int: Interval in seconds to use for polling the status of query results in Athena.
RegionName string: AWS region of your Athena instance.
S3DataDir string: Prefix for storing tables, if different from the connection's S3 staging directory.
S3DataNaming string: How to generate table paths in the S3 data directory.
S3StagingDir string: S3 location to store Athena query results and metadata.
S3TmpTableDir string: Prefix for storing temporary tables, if different from the connection's S3 data directory.
SparkWorkGroup string: Identifier of Athena Spark workgroup for running Python models.
WorkGroup string: Identifier of Athena workgroup.

database String: Specify the database (data catalog) to build models into (lowercase only).
numBoto3Retries Integer: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
numIcebergRetries Integer: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
numRetries Integer: Number of times to retry a failing query.
pollInterval Integer: Interval in seconds to use for polling the status of query results in Athena.
regionName String: AWS region of your Athena instance.
s3DataDir String: Prefix for storing tables, if different from the connection's S3 staging directory.
s3DataNaming String: How to generate table paths in the S3 data directory.
s3StagingDir String: S3 location to store Athena query results and metadata.
s3TmpTableDir String: Prefix for storing temporary tables, if different from the connection's S3 data directory.
sparkWorkGroup String: Identifier of Athena Spark workgroup for running Python models.
workGroup String: Identifier of Athena workgroup.

database string: Specify the database (data catalog) to build models into (lowercase only).
numBoto3Retries number: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
numIcebergRetries number: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
numRetries number: Number of times to retry a failing query.
pollInterval number: Interval in seconds to use for polling the status of query results in Athena.
regionName string: AWS region of your Athena instance.
s3DataDir string: Prefix for storing tables, if different from the connection's S3 staging directory.
s3DataNaming string: How to generate table paths in the S3 data directory.
s3StagingDir string: S3 location to store Athena query results and metadata.
s3TmpTableDir string: Prefix for storing temporary tables, if different from the connection's S3 data directory.
sparkWorkGroup string: Identifier of Athena Spark workgroup for running Python models.
workGroup string: Identifier of Athena workgroup.

database str: Specify the database (data catalog) to build models into (lowercase only).
num_boto3_retries int: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
num_iceberg_retries int: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
num_retries int: Number of times to retry a failing query.
poll_interval int: Interval in seconds to use for polling the status of query results in Athena.
region_name str: AWS region of your Athena instance.
s3_data_dir str: Prefix for storing tables, if different from the connection's S3 staging directory.
s3_data_naming str: How to generate table paths in the S3 data directory.
s3_staging_dir str: S3 location to store Athena query results and metadata.
s3_tmp_table_dir str: Prefix for storing temporary tables, if different from the connection's S3 data directory.
spark_work_group str: Identifier of Athena Spark workgroup for running Python models.
work_group str: Identifier of Athena workgroup.

database String: Specify the database (data catalog) to build models into (lowercase only).
numBoto3Retries Number: Number of times to retry boto3 requests (e.g. deleting S3 files for materialized tables).
numIcebergRetries Number: Number of times to retry iceberg commit queries to fix ICEBERGCOMMITERROR.
numRetries Number: Number of times to retry a failing query.
pollInterval Number: Interval in seconds to use for polling the status of query results in Athena.
regionName String: AWS region of your Athena instance.
s3DataDir String: Prefix for storing tables, if different from the connection's S3 staging directory.
s3DataNaming String: How to generate table paths in the S3 data directory.
s3StagingDir String: S3 location to store Athena query results and metadata.
s3TmpTableDir String: Prefix for storing temporary tables, if different from the connection's S3 data directory.
sparkWorkGroup String: Identifier of Athena Spark workgroup for running Python models.
workGroup String: Identifier of Athena workgroup.

GetGlobalConnectionBigquery

ApplicationId string: OAuth Client ID
ApplicationSecret string: OAuth Client Secret
AuthProviderX509CertUrl string: Auth Provider X509 Cert URL for the Service Account
AuthUri string: Auth URI for the Service Account
ClientEmail string: Service Account email
ClientId string: Client ID of the Service Account
ClientX509CertUrl string: Client X509 Cert URL for the Service Account
DataprocClusterName string: Dataproc cluster name for PySpark workloads
DataprocRegion string: Google Cloud region for PySpark workloads on Dataproc
ExecutionProject string: Project to bill for query execution
GcpProjectId string: The GCP project ID to use for the connection
GcsBucket string: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
ImpersonateServiceAccount string: Service Account to impersonate when running queries
JobCreationTimeoutSeconds int: Maximum timeout for the job creation step
JobRetryDeadlineSeconds int: Total number of seconds to wait while retrying the same query
Location string: Location to create new Datasets in
MaximumBytesBilled int: Max number of bytes that can be billed for a given BigQuery query
Priority string: The priority with which to execute BigQuery queries (batch or interactive)
PrivateKey string: Private Key for the Service Account
PrivateKeyId string: Private Key ID for the Service Account
Retries int: Number of retries for queries
Scopes List<string>: OAuth scopes for the BigQuery connection
TimeoutSeconds int: Timeout in seconds for queries
TokenUri string: Token URI for the Service Account

ApplicationId string: OAuth Client ID
ApplicationSecret string: OAuth Client Secret
AuthProviderX509CertUrl string: Auth Provider X509 Cert URL for the Service Account
AuthUri string: Auth URI for the Service Account
ClientEmail string: Service Account email
ClientId string: Client ID of the Service Account
ClientX509CertUrl string: Client X509 Cert URL for the Service Account
DataprocClusterName string: Dataproc cluster name for PySpark workloads
DataprocRegion string: Google Cloud region for PySpark workloads on Dataproc
ExecutionProject string: Project to bill for query execution
GcpProjectId string: The GCP project ID to use for the connection
GcsBucket string: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
ImpersonateServiceAccount string: Service Account to impersonate when running queries
JobCreationTimeoutSeconds int: Maximum timeout for the job creation step
JobRetryDeadlineSeconds int: Total number of seconds to wait while retrying the same query
Location string: Location to create new Datasets in
MaximumBytesBilled int: Max number of bytes that can be billed for a given BigQuery query
Priority string: The priority with which to execute BigQuery queries (batch or interactive)
PrivateKey string: Private Key for the Service Account
PrivateKeyId string: Private Key ID for the Service Account
Retries int: Number of retries for queries
Scopes []string: OAuth scopes for the BigQuery connection
TimeoutSeconds int: Timeout in seconds for queries
TokenUri string: Token URI for the Service Account

applicationId String: OAuth Client ID
applicationSecret String: OAuth Client Secret
authProviderX509CertUrl String: Auth Provider X509 Cert URL for the Service Account
authUri String: Auth URI for the Service Account
clientEmail String: Service Account email
clientId String: Client ID of the Service Account
clientX509CertUrl String: Client X509 Cert URL for the Service Account
dataprocClusterName String: Dataproc cluster name for PySpark workloads
dataprocRegion String: Google Cloud region for PySpark workloads on Dataproc
executionProject String: Project to bill for query execution
gcpProjectId String: The GCP project ID to use for the connection
gcsBucket String: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
impersonateServiceAccount String: Service Account to impersonate when running queries
jobCreationTimeoutSeconds Integer: Maximum timeout for the job creation step
jobRetryDeadlineSeconds Integer: Total number of seconds to wait while retrying the same query
location String: Location to create new Datasets in
maximumBytesBilled Integer: Max number of bytes that can be billed for a given BigQuery query
priority String: The priority with which to execute BigQuery queries (batch or interactive)
privateKey String: Private Key for the Service Account
privateKeyId String: Private Key ID for the Service Account
retries Integer: Number of retries for queries
scopes List<String>: OAuth scopes for the BigQuery connection
timeoutSeconds Integer: Timeout in seconds for queries
tokenUri String: Token URI for the Service Account

applicationId string: OAuth Client ID
applicationSecret string: OAuth Client Secret
authProviderX509CertUrl string: Auth Provider X509 Cert URL for the Service Account
authUri string: Auth URI for the Service Account
clientEmail string: Service Account email
clientId string: Client ID of the Service Account
clientX509CertUrl string: Client X509 Cert URL for the Service Account
dataprocClusterName string: Dataproc cluster name for PySpark workloads
dataprocRegion string: Google Cloud region for PySpark workloads on Dataproc
executionProject string: Project to bill for query execution
gcpProjectId string: The GCP project ID to use for the connection
gcsBucket string: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
impersonateServiceAccount string: Service Account to impersonate when running queries
jobCreationTimeoutSeconds number: Maximum timeout for the job creation step
jobRetryDeadlineSeconds number: Total number of seconds to wait while retrying the same query
location string: Location to create new Datasets in
maximumBytesBilled number: Max number of bytes that can be billed for a given BigQuery query
priority string: The priority with which to execute BigQuery queries (batch or interactive)
privateKey string: Private Key for the Service Account
privateKeyId string: Private Key ID for the Service Account
retries number: Number of retries for queries
scopes string[]: OAuth scopes for the BigQuery connection
timeoutSeconds number: Timeout in seconds for queries
tokenUri string: Token URI for the Service Account

application_id str: OAuth Client ID
application_secret str: OAuth Client Secret
auth_provider_x509_cert_url str: Auth Provider X509 Cert URL for the Service Account
auth_uri str: Auth URI for the Service Account
client_email str: Service Account email
client_id str: Client ID of the Service Account
client_x509_cert_url str: Client X509 Cert URL for the Service Account
dataproc_cluster_name str: Dataproc cluster name for PySpark workloads
dataproc_region str: Google Cloud region for PySpark workloads on Dataproc
execution_project str: Project to bill for query execution
gcp_project_id str: The GCP project ID to use for the connection
gcs_bucket str: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
impersonate_service_account str: Service Account to impersonate when running queries
job_creation_timeout_seconds int: Maximum timeout for the job creation step
job_retry_deadline_seconds int: Total number of seconds to wait while retrying the same query
location str: Location to create new Datasets in
maximum_bytes_billed int: Max number of bytes that can be billed for a given BigQuery query
priority str: The priority with which to execute BigQuery queries (batch or interactive)
private_key str: Private Key for the Service Account
private_key_id str: Private Key ID for the Service Account
retries int: Number of retries for queries
scopes Sequence[str]: OAuth scopes for the BigQuery connection
timeout_seconds int: Timeout in seconds for queries
token_uri str: Token URI for the Service Account

applicationId String: OAuth Client ID
applicationSecret String: OAuth Client Secret
authProviderX509CertUrl String: Auth Provider X509 Cert URL for the Service Account
authUri String: Auth URI for the Service Account
clientEmail String: Service Account email
clientId String: Client ID of the Service Account
clientX509CertUrl String: Client X509 Cert URL for the Service Account
dataprocClusterName String: Dataproc cluster name for PySpark workloads
dataprocRegion String: Google Cloud region for PySpark workloads on Dataproc
executionProject String: Project to bill for query execution
gcpProjectId String: The GCP project ID to use for the connection
gcsBucket String: URI for a Google Cloud Storage bucket to host Python code executed via Datapro
impersonateServiceAccount String: Service Account to impersonate when running queries
jobCreationTimeoutSeconds Number: Maximum timeout for the job creation step
jobRetryDeadlineSeconds Number: Total number of seconds to wait while retrying the same query
location String: Location to create new Datasets in
maximumBytesBilled Number: Max number of bytes that can be billed for a given BigQuery query
priority String: The priority with which to execute BigQuery queries (batch or interactive)
privateKey String: Private Key for the Service Account
privateKeyId String: Private Key ID for the Service Account
retries Number: Number of retries for queries
scopes List<String>: OAuth scopes for the BigQuery connection
timeoutSeconds Number: Timeout in seconds for queries
tokenUri String: Token URI for the Service Account

GetGlobalConnectionDatabricks

Catalog string: Catalog name if Unity Catalog is enabled in your Databricks workspace.
ClientId string: Required to enable Databricks OAuth authentication for IDE developers.
ClientSecret string: Required to enable Databricks OAuth authentication for IDE developers.
Host string: The hostname of the Databricks cluster or SQL warehouse.
HttpPath string: The HTTP path of the Databricks cluster or SQL warehouse.

Catalog string: Catalog name if Unity Catalog is enabled in your Databricks workspace.
ClientId string: Required to enable Databricks OAuth authentication for IDE developers.
ClientSecret string: Required to enable Databricks OAuth authentication for IDE developers.
Host string: The hostname of the Databricks cluster or SQL warehouse.
HttpPath string: The HTTP path of the Databricks cluster or SQL warehouse.

catalog String: Catalog name if Unity Catalog is enabled in your Databricks workspace.
clientId String: Required to enable Databricks OAuth authentication for IDE developers.
clientSecret String: Required to enable Databricks OAuth authentication for IDE developers.
host String: The hostname of the Databricks cluster or SQL warehouse.
httpPath String: The HTTP path of the Databricks cluster or SQL warehouse.

catalog string: Catalog name if Unity Catalog is enabled in your Databricks workspace.
clientId string: Required to enable Databricks OAuth authentication for IDE developers.
clientSecret string: Required to enable Databricks OAuth authentication for IDE developers.
host string: The hostname of the Databricks cluster or SQL warehouse.
httpPath string: The HTTP path of the Databricks cluster or SQL warehouse.

catalog str: Catalog name if Unity Catalog is enabled in your Databricks workspace.
client_id str: Required to enable Databricks OAuth authentication for IDE developers.
client_secret str: Required to enable Databricks OAuth authentication for IDE developers.
host str: The hostname of the Databricks cluster or SQL warehouse.
http_path str: The HTTP path of the Databricks cluster or SQL warehouse.

catalog String: Catalog name if Unity Catalog is enabled in your Databricks workspace.
clientId String: Required to enable Databricks OAuth authentication for IDE developers.
clientSecret String: Required to enable Databricks OAuth authentication for IDE developers.
host String: The hostname of the Databricks cluster or SQL warehouse.
httpPath String: The HTTP path of the Databricks cluster or SQL warehouse.

GetGlobalConnectionFabric

Database string: The database to connect to for this connection.
LoginTimeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Port int: The port to connect to for this connection. Default=1433
QueryTimeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
Server string: The server hostname.

Database string: The database to connect to for this connection.
LoginTimeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Port int: The port to connect to for this connection. Default=1433
QueryTimeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
Server string: The server hostname.

database String: The database to connect to for this connection.
loginTimeout Integer: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port Integer: The port to connect to for this connection. Default=1433
queryTimeout Integer: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries Integer: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
server String: The server hostname.

database string: The database to connect to for this connection.
loginTimeout number: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port number: The port to connect to for this connection. Default=1433
queryTimeout number: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries number: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
server string: The server hostname.

database str: The database to connect to for this connection.
login_timeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port int: The port to connect to for this connection. Default=1433
query_timeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
server str: The server hostname.

database String: The database to connect to for this connection.
loginTimeout Number: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port Number: The port to connect to for this connection. Default=1433
queryTimeout Number: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries Number: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.
server String: The server hostname.

GetGlobalConnectionPostgres

Dbname string: The database name for this connection.
Hostname string: The hostname of the database.
Port int: The port to connect to for this connection. Default=5432
SshTunnel Pulumi.DbtCloud.Inputs.GetGlobalConnectionPostgresSshTunnel: PostgreSQL SSH Tunnel configuration

Dbname string: The database name for this connection.
Hostname string: The hostname of the database.
Port int: The port to connect to for this connection. Default=5432
SshTunnel GetGlobalConnectionPostgresSshTunnel: PostgreSQL SSH Tunnel configuration

dbname String: The database name for this connection.
hostname String: The hostname of the database.
port Integer: The port to connect to for this connection. Default=5432
sshTunnel GetGlobalConnectionPostgresSshTunnel: PostgreSQL SSH Tunnel configuration

dbname string: The database name for this connection.
hostname string: The hostname of the database.
port number: The port to connect to for this connection. Default=5432
sshTunnel GetGlobalConnectionPostgresSshTunnel: PostgreSQL SSH Tunnel configuration

dbname str: The database name for this connection.
hostname str: The hostname of the database.
port int: The port to connect to for this connection. Default=5432
ssh_tunnel GetGlobalConnectionPostgresSshTunnel: PostgreSQL SSH Tunnel configuration

dbname String: The database name for this connection.
hostname String: The hostname of the database.
port Number: The port to connect to for this connection. Default=5432
sshTunnel Property Map: PostgreSQL SSH Tunnel configuration

GetGlobalConnectionPostgresSshTunnel

Hostname string: The hostname for the SSH tunnel.
Id int: The ID of the SSH tunnel connection.
Port int: The HTTP port for the SSH tunnel.
PublicKey string: The SSH public key generated to allow connecting via SSH tunnel.
Username string: The username to use for the SSH tunnel.

Hostname string: The hostname for the SSH tunnel.
Id int: The ID of the SSH tunnel connection.
Port int: The HTTP port for the SSH tunnel.
PublicKey string: The SSH public key generated to allow connecting via SSH tunnel.
Username string: The username to use for the SSH tunnel.

hostname String: The hostname for the SSH tunnel.
id Integer: The ID of the SSH tunnel connection.
port Integer: The HTTP port for the SSH tunnel.
publicKey String: The SSH public key generated to allow connecting via SSH tunnel.
username String: The username to use for the SSH tunnel.

hostname string: The hostname for the SSH tunnel.
id number: The ID of the SSH tunnel connection.
port number: The HTTP port for the SSH tunnel.
publicKey string: The SSH public key generated to allow connecting via SSH tunnel.
username string: The username to use for the SSH tunnel.

hostname str: The hostname for the SSH tunnel.
id int: The ID of the SSH tunnel connection.
port int: The HTTP port for the SSH tunnel.
public_key str: The SSH public key generated to allow connecting via SSH tunnel.
username str: The username to use for the SSH tunnel.

hostname String: The hostname for the SSH tunnel.
id Number: The ID of the SSH tunnel connection.
port Number: The HTTP port for the SSH tunnel.
publicKey String: The SSH public key generated to allow connecting via SSH tunnel.
username String: The username to use for the SSH tunnel.

GetGlobalConnectionRedshift

Dbname string: The database name for this connection.
Hostname string: The hostname of the data warehouse.
Port int: The port to connect to for this connection. Default=5432
SshTunnel Pulumi.DbtCloud.Inputs.GetGlobalConnectionRedshiftSshTunnel: Redshift SSH Tunnel configuration

Dbname string: The database name for this connection.
Hostname string: The hostname of the data warehouse.
Port int: The port to connect to for this connection. Default=5432
SshTunnel GetGlobalConnectionRedshiftSshTunnel: Redshift SSH Tunnel configuration

dbname String: The database name for this connection.
hostname String: The hostname of the data warehouse.
port Integer: The port to connect to for this connection. Default=5432
sshTunnel GetGlobalConnectionRedshiftSshTunnel: Redshift SSH Tunnel configuration

dbname string: The database name for this connection.
hostname string: The hostname of the data warehouse.
port number: The port to connect to for this connection. Default=5432
sshTunnel GetGlobalConnectionRedshiftSshTunnel: Redshift SSH Tunnel configuration

dbname str: The database name for this connection.
hostname str: The hostname of the data warehouse.
port int: The port to connect to for this connection. Default=5432
ssh_tunnel GetGlobalConnectionRedshiftSshTunnel: Redshift SSH Tunnel configuration

dbname String: The database name for this connection.
hostname String: The hostname of the data warehouse.
port Number: The port to connect to for this connection. Default=5432
sshTunnel Property Map: Redshift SSH Tunnel configuration

GetGlobalConnectionRedshiftSshTunnel

Hostname string: The hostname for the SSH tunnel.
Id int: The ID of the SSH tunnel connection.
Port int: The HTTP port for the SSH tunnel.
PublicKey string: The SSH public key generated to allow connecting via SSH tunnel.
Username string: The username to use for the SSH tunnel.

Hostname string: The hostname for the SSH tunnel.
Id int: The ID of the SSH tunnel connection.
Port int: The HTTP port for the SSH tunnel.
PublicKey string: The SSH public key generated to allow connecting via SSH tunnel.
Username string: The username to use for the SSH tunnel.

hostname String: The hostname for the SSH tunnel.
id Integer: The ID of the SSH tunnel connection.
port Integer: The HTTP port for the SSH tunnel.
publicKey String: The SSH public key generated to allow connecting via SSH tunnel.
username String: The username to use for the SSH tunnel.

hostname string: The hostname for the SSH tunnel.
id number: The ID of the SSH tunnel connection.
port number: The HTTP port for the SSH tunnel.
publicKey string: The SSH public key generated to allow connecting via SSH tunnel.
username string: The username to use for the SSH tunnel.

hostname str: The hostname for the SSH tunnel.
id int: The ID of the SSH tunnel connection.
port int: The HTTP port for the SSH tunnel.
public_key str: The SSH public key generated to allow connecting via SSH tunnel.
username str: The username to use for the SSH tunnel.

hostname String: The hostname for the SSH tunnel.
id Number: The ID of the SSH tunnel connection.
port Number: The HTTP port for the SSH tunnel.
publicKey String: The SSH public key generated to allow connecting via SSH tunnel.
username String: The username to use for the SSH tunnel.

GetGlobalConnectionSnowflake

Account string: The Snowflake account name
AllowSso bool: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
ClientSessionKeepAlive bool: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
Database string: The default database for the connection
OauthClientId string: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
OauthClientSecret string: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
Role string: The Snowflake role to use when running queries on the connection
Warehouse string: The default Snowflake Warehouse to use for the connection

Account string: The Snowflake account name
AllowSso bool: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
ClientSessionKeepAlive bool: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
Database string: The default database for the connection
OauthClientId string: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
OauthClientSecret string: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
Role string: The Snowflake role to use when running queries on the connection
Warehouse string: The default Snowflake Warehouse to use for the connection

account String: The Snowflake account name
allowSso Boolean: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
clientSessionKeepAlive Boolean: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
database String: The default database for the connection
oauthClientId String: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
oauthClientSecret String: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
role String: The Snowflake role to use when running queries on the connection
warehouse String: The default Snowflake Warehouse to use for the connection

account string: The Snowflake account name
allowSso boolean: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
clientSessionKeepAlive boolean: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
database string: The default database for the connection
oauthClientId string: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
oauthClientSecret string: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
role string: The Snowflake role to use when running queries on the connection
warehouse string: The default Snowflake Warehouse to use for the connection

account str: The Snowflake account name
allow_sso bool: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
client_session_keep_alive bool: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
database str: The default database for the connection
oauth_client_id str: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
oauth_client_secret str: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
role str: The Snowflake role to use when running queries on the connection
warehouse str: The default Snowflake Warehouse to use for the connection

account String: The Snowflake account name
allowSso Boolean: Whether to allow Snowflake OAuth for the connection. If true, the oauth_client_id and oauth_client_secret fields must be set
clientSessionKeepAlive Boolean: If true, the snowflake client will keep connections for longer than the default 4 hours. This is helpful when particularly long-running queries are executing (> 4 hours)
database String: The default database for the connection
oauthClientId String: OAuth Client ID. Required to allow OAuth between dbt Cloud and Snowflake
oauthClientSecret String: OAuth Client Secret. Required to allow OAuth between dbt Cloud and Snowflake
role String: The Snowflake role to use when running queries on the connection
warehouse String: The default Snowflake Warehouse to use for the connection

GetGlobalConnectionStarburst

Host string: The hostname of the account to connect to.
Method string: The authentication method. Only LDAP for now.
Port int: The port to connect to for this connection. Default=443

Host string: The hostname of the account to connect to.
Method string: The authentication method. Only LDAP for now.
Port int: The port to connect to for this connection. Default=443

host String: The hostname of the account to connect to.
method String: The authentication method. Only LDAP for now.
port Integer: The port to connect to for this connection. Default=443

host string: The hostname of the account to connect to.
method string: The authentication method. Only LDAP for now.
port number: The port to connect to for this connection. Default=443

host str: The hostname of the account to connect to.
method str: The authentication method. Only LDAP for now.
port int: The port to connect to for this connection. Default=443

host String: The hostname of the account to connect to.
method String: The authentication method. Only LDAP for now.
port Number: The port to connect to for this connection. Default=443

GetGlobalConnectionSynapse

Database string: The database to connect to for this connection.
Host string: The server hostname.
LoginTimeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Port int: The port to connect to for this connection. Default=1433
QueryTimeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

Database string: The database to connect to for this connection.
Host string: The server hostname.
LoginTimeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Port int: The port to connect to for this connection. Default=1433
QueryTimeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
Retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

database String: The database to connect to for this connection.
host String: The server hostname.
loginTimeout Integer: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port Integer: The port to connect to for this connection. Default=1433
queryTimeout Integer: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries Integer: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

database string: The database to connect to for this connection.
host string: The server hostname.
loginTimeout number: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port number: The port to connect to for this connection. Default=1433
queryTimeout number: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries number: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

database str: The database to connect to for this connection.
host str: The server hostname.
login_timeout int: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port int: The port to connect to for this connection. Default=1433
query_timeout int: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries int: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

database String: The database to connect to for this connection.
host String: The server hostname.
loginTimeout Number: The number of seconds used to establish a connection before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
port Number: The port to connect to for this connection. Default=1433
queryTimeout Number: The number of seconds used to wait for a query before failing. Defaults to 0, which means that the timeout is disabled or uses the default system settings.
retries Number: The number of automatic times to retry a query before failing. Defaults to 1. Queries with syntax errors will not be retried. This setting can be used to overcome intermittent network issues.

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

dbtcloud.getGlobalConnection

On this page

On this page

Example Usage

Using getGlobalConnection

getGlobalConnection Result

Supporting Types

GetGlobalConnectionApacheSpark

GetGlobalConnectionAthena

GetGlobalConnectionBigquery

GetGlobalConnectionDatabricks

GetGlobalConnectionFabric

GetGlobalConnectionPostgres

GetGlobalConnectionPostgresSshTunnel

GetGlobalConnectionRedshift

GetGlobalConnectionRedshiftSshTunnel

GetGlobalConnectionSnowflake

GetGlobalConnectionStarburst

GetGlobalConnectionSynapse

Package Details

On this page

On this page