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

dbtcloud.getConnection

Explore with Pulumi AI

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

Using getConnection

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.

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
Copy
def get_connection(connection_id: Optional[int] = None,
                   project_id: Optional[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[int]] = None,
                   project_id: Optional[pulumi.Input[int]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
Copy
func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput
Copy

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: dbtcloud:index/getConnection:getConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionId This property is required. int
ID for the connection
ProjectId This property is required. int
Project ID to create the connection in
ConnectionId This property is required. int
ID for the connection
ProjectId This property is required. int
Project ID to create the connection in
connectionId This property is required. Integer
ID for the connection
projectId This property is required. Integer
Project ID to create the connection in
connectionId This property is required. number
ID for the connection
projectId This property is required. number
Project ID to create the connection in
connection_id This property is required. int
ID for the connection
project_id This property is required. int
Project ID to create the connection in
connectionId This property is required. Number
ID for the connection
projectId This property is required. Number
Project ID to create the connection in

getConnection Result

The following output properties are available:

Account string
Account for the connection
AllowKeepAlive bool
Flag for whether or not to use the keep session alive parameter in the connection
AllowSso bool
Flag for whether or not to use SSO for the connection
ConnectionId int
ID for the connection
Database string
Database name for the connection
Id string
The provider-assigned unique ID for this managed resource.
IsActive bool
Whether the connection is active
Name string
Connection name
PrivateLinkEndpointId string
The ID of the PrivateLink connection
ProjectId int
Project ID to create the connection in
Role string
Role name for the connection
Type string
Connection type
Warehouse string
Warehouse name for the connection
Account string
Account for the connection
AllowKeepAlive bool
Flag for whether or not to use the keep session alive parameter in the connection
AllowSso bool
Flag for whether or not to use SSO for the connection
ConnectionId int
ID for the connection
Database string
Database name for the connection
Id string
The provider-assigned unique ID for this managed resource.
IsActive bool
Whether the connection is active
Name string
Connection name
PrivateLinkEndpointId string
The ID of the PrivateLink connection
ProjectId int
Project ID to create the connection in
Role string
Role name for the connection
Type string
Connection type
Warehouse string
Warehouse name for the connection
account String
Account for the connection
allowKeepAlive Boolean
Flag for whether or not to use the keep session alive parameter in the connection
allowSso Boolean
Flag for whether or not to use SSO for the connection
connectionId Integer
ID for the connection
database String
Database name for the connection
id String
The provider-assigned unique ID for this managed resource.
isActive Boolean
Whether the connection is active
name String
Connection name
privateLinkEndpointId String
The ID of the PrivateLink connection
projectId Integer
Project ID to create the connection in
role String
Role name for the connection
type String
Connection type
warehouse String
Warehouse name for the connection
account string
Account for the connection
allowKeepAlive boolean
Flag for whether or not to use the keep session alive parameter in the connection
allowSso boolean
Flag for whether or not to use SSO for the connection
connectionId number
ID for the connection
database string
Database name for the connection
id string
The provider-assigned unique ID for this managed resource.
isActive boolean
Whether the connection is active
name string
Connection name
privateLinkEndpointId string
The ID of the PrivateLink connection
projectId number
Project ID to create the connection in
role string
Role name for the connection
type string
Connection type
warehouse string
Warehouse name for the connection
account str
Account for the connection
allow_keep_alive bool
Flag for whether or not to use the keep session alive parameter in the connection
allow_sso bool
Flag for whether or not to use SSO for the connection
connection_id int
ID for the connection
database str
Database name for the connection
id str
The provider-assigned unique ID for this managed resource.
is_active bool
Whether the connection is active
name str
Connection name
private_link_endpoint_id str
The ID of the PrivateLink connection
project_id int
Project ID to create the connection in
role str
Role name for the connection
type str
Connection type
warehouse str
Warehouse name for the connection
account String
Account for the connection
allowKeepAlive Boolean
Flag for whether or not to use the keep session alive parameter in the connection
allowSso Boolean
Flag for whether or not to use SSO for the connection
connectionId Number
ID for the connection
database String
Database name for the connection
id String
The provider-assigned unique ID for this managed resource.
isActive Boolean
Whether the connection is active
name String
Connection name
privateLinkEndpointId String
The ID of the PrivateLink connection
projectId Number
Project ID to create the connection in
role String
Role name for the connection
type String
Connection type
warehouse String
Warehouse name for the connection

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