1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getConnections
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi

snowflake.getConnections

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi

Data source used to get details of filtered connections. Filtering is aligned with the current possibilities for SHOW CONNECTIONS query. The results of SHOW is encapsulated in one output collection connections.

Using getConnections

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 getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>
function getConnectionsOutput(args: GetConnectionsOutputArgs, opts?: InvokeOptions): Output<GetConnectionsResult>
Copy
def get_connections(like: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetConnectionsResult
def get_connections_output(like: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetConnectionsResult]
Copy
func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)
func GetConnectionsOutput(ctx *Context, args *GetConnectionsOutputArgs, opts ...InvokeOption) GetConnectionsResultOutput
Copy

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

public static class GetConnections 
{
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionsResult> Invoke(GetConnectionsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
public static Output<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: snowflake:index/getConnections:getConnections
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
like str
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).

getConnections Result

The following output properties are available:

Connections List<GetConnectionsConnection>
Holds the aggregated output of all connections details queries.
Id string
The provider-assigned unique ID for this managed resource.
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Connections []GetConnectionsConnection
Holds the aggregated output of all connections details queries.
Id string
The provider-assigned unique ID for this managed resource.
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
connections List<GetConnectionsConnection>
Holds the aggregated output of all connections details queries.
id String
The provider-assigned unique ID for this managed resource.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
connections GetConnectionsConnection[]
Holds the aggregated output of all connections details queries.
id string
The provider-assigned unique ID for this managed resource.
like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
connections Sequence[GetConnectionsConnection]
Holds the aggregated output of all connections details queries.
id str
The provider-assigned unique ID for this managed resource.
like str
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
connections List<Property Map>
Holds the aggregated output of all connections details queries.
id String
The provider-assigned unique ID for this managed resource.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).

Supporting Types

GetConnectionsConnection

ShowOutputs This property is required. List<GetConnectionsConnectionShowOutput>
Holds the output of SHOW CONNECTIONS.
ShowOutputs This property is required. []GetConnectionsConnectionShowOutput
Holds the output of SHOW CONNECTIONS.
showOutputs This property is required. List<GetConnectionsConnectionShowOutput>
Holds the output of SHOW CONNECTIONS.
showOutputs This property is required. GetConnectionsConnectionShowOutput[]
Holds the output of SHOW CONNECTIONS.
show_outputs This property is required. Sequence[GetConnectionsConnectionShowOutput]
Holds the output of SHOW CONNECTIONS.
showOutputs This property is required. List<Property Map>
Holds the output of SHOW CONNECTIONS.

GetConnectionsConnectionShowOutput

AccountLocator This property is required. string
AccountName This property is required. string
Comment This property is required. string
ConnectionUrl This property is required. string
CreatedOn This property is required. string
FailoverAllowedToAccounts This property is required. List<string>
IsPrimary This property is required. bool
Name This property is required. string
OrganizationName This property is required. string
Primary This property is required. string
RegionGroup This property is required. string
SnowflakeRegion This property is required. string
AccountLocator This property is required. string
AccountName This property is required. string
Comment This property is required. string
ConnectionUrl This property is required. string
CreatedOn This property is required. string
FailoverAllowedToAccounts This property is required. []string
IsPrimary This property is required. bool
Name This property is required. string
OrganizationName This property is required. string
Primary This property is required. string
RegionGroup This property is required. string
SnowflakeRegion This property is required. string
accountLocator This property is required. String
accountName This property is required. String
comment This property is required. String
connectionUrl This property is required. String
createdOn This property is required. String
failoverAllowedToAccounts This property is required. List<String>
isPrimary This property is required. Boolean
name This property is required. String
organizationName This property is required. String
primary This property is required. String
regionGroup This property is required. String
snowflakeRegion This property is required. String
accountLocator This property is required. string
accountName This property is required. string
comment This property is required. string
connectionUrl This property is required. string
createdOn This property is required. string
failoverAllowedToAccounts This property is required. string[]
isPrimary This property is required. boolean
name This property is required. string
organizationName This property is required. string
primary This property is required. string
regionGroup This property is required. string
snowflakeRegion This property is required. string
account_locator This property is required. str
account_name This property is required. str
comment This property is required. str
connection_url This property is required. str
created_on This property is required. str
failover_allowed_to_accounts This property is required. Sequence[str]
is_primary This property is required. bool
name This property is required. str
organization_name This property is required. str
primary This property is required. str
region_group This property is required. str
snowflake_region This property is required. str
accountLocator This property is required. String
accountName This property is required. String
comment This property is required. String
connectionUrl This property is required. String
createdOn This property is required. String
failoverAllowedToAccounts This property is required. List<String>
isPrimary This property is required. Boolean
name This property is required. String
organizationName This property is required. String
primary This property is required. String
regionGroup This property is required. String
snowflakeRegion This property is required. String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi