getDatabaseConnection

ibm 2.7.0, Oct 7 26

Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm

Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Example Usage

Classic

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

const databaseConnection = ibm.getDatabaseConnection({
    endpointType: "public",
    deploymentId: myDb.id,
    userId: "user_id",
    userType: "database",
});

import pulumi
import pulumi_ibm as ibm

database_connection = ibm.get_database_connection(endpoint_type="public",
    deployment_id=my_db["id"],
    user_id="user_id",
    user_type="database")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetDatabaseConnection(ctx, &ibm.GetDatabaseConnectionArgs{
			EndpointType: "public",
			DeploymentId: myDb.Id,
			UserId:       "user_id",
			UserType:     "database",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var databaseConnection = Ibm.GetDatabaseConnection.Invoke(new()
    {
        EndpointType = "public",
        DeploymentId = myDb.Id,
        UserId = "user_id",
        UserType = "database",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDatabaseConnectionArgs;
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 databaseConnection = IbmFunctions.getDatabaseConnection(GetDatabaseConnectionArgs.builder()
            .endpointType("public")
            .deploymentId(myDb.id())
            .userId("user_id")
            .userType("database")
            .build());

    }
}

variables:
  databaseConnection:
    fn::invoke:
      function: ibm:getDatabaseConnection
      arguments:
        endpointType: public
        deploymentId: ${myDb.id}
        userId: user_id
        userType: database

Example coming soon!

Gen2

For Gen2 instances, connection information is retrieved through IBM Cloud resource keys. A resource key must exist for the instance before this data source can be used. The user_id is matched against resource key names; if no match is found, the first available key is used automatically.

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

const dbKey = new ibm.ResourceKey("db_key", {
    name: "my-db-key",
    resourceInstanceId: myDb.id,
});
const databaseConnection = dbKey.name.apply(name => ibm.getDatabaseConnectionOutput({
    deploymentId: myDb.id,
    userId: name,
    userType: "database",
    endpointType: "private",
}));

import pulumi
import pulumi_ibm as ibm

db_key = ibm.ResourceKey("db_key",
    name="my-db-key",
    resource_instance_id=my_db["id"])
database_connection = db_key.name.apply(lambda name: ibm.get_database_connection_output(deployment_id=my_db["id"],
    user_id=name,
    user_type="database",
    endpoint_type="private"))

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		dbKey, err := ibm.NewResourceKey(ctx, "db_key", &ibm.ResourceKeyArgs{
			Name:               pulumi.String("my-db-key"),
			ResourceInstanceId: pulumi.Any(myDb.Id),
		})
		if err != nil {
			return err
		}
		_ = dbKey.Name.ApplyT(func(name string) (ibm.GetDatabaseConnectionResult, error) {
			return ibm.GetDatabaseConnectionResult(interface{}(ibm.GetDatabaseConnectionOutput(ctx, ibm.GetDatabaseConnectionOutputArgs{
				DeploymentId: myDb.Id,
				UserId:       name,
				UserType:     "database",
				EndpointType: "private",
			}, nil))), nil
		}).(ibm.GetDatabaseConnectionResultOutput)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dbKey = new Ibm.ResourceKey("db_key", new()
    {
        Name = "my-db-key",
        ResourceInstanceId = myDb.Id,
    });

    var databaseConnection = Ibm.GetDatabaseConnection.Invoke(new()
    {
        DeploymentId = myDb.Id,
        UserId = dbKey.Name,
        UserType = "database",
        EndpointType = "private",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ResourceKey;
import com.pulumi.ibm.ResourceKeyArgs;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDatabaseConnectionArgs;
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 dbKey = new ResourceKey("dbKey", ResourceKeyArgs.builder()
            .name("my-db-key")
            .resourceInstanceId(myDb.id())
            .build());

        final var databaseConnection = dbKey.name().applyValue(_name -> IbmFunctions.getDatabaseConnection(GetDatabaseConnectionArgs.builder()
            .deploymentId(myDb.id())
            .userId(_name)
            .userType("database")
            .endpointType("private")
            .build()));

    }
}

resources:
  dbKey:
    type: ibm:ResourceKey
    name: db_key
    properties:
      name: my-db-key
      resourceInstanceId: ${myDb.id}
variables:
  databaseConnection:
    fn::invoke:
      function: ibm:getDatabaseConnection
      arguments:
        deploymentId: ${myDb.id}
        userId: ${dbKey.name}
        userType: database
        endpointType: private

Example coming soon!

Gen2 Behaviour

For Gen2 database instances, connection information is extracted from IBM Cloud resource key credentials via the Resource Controller API rather than the Cloud Databases V5 API. The user_id field is matched against resource key names. If no matching key is found, the first available key is used and user_id is updated in state to reflect the actual key name used.

Note: If no resource keys exist for the Gen2 instance, the data source returns an error. Create a resource key using ibm.ResourceKey before using this data source.

Using getDatabaseConnection

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 getDatabaseConnection(args: GetDatabaseConnectionArgs, opts?: InvokeOptions): Promise<GetDatabaseConnectionResult>
function getDatabaseConnectionOutput(args: GetDatabaseConnectionOutputArgs, opts?: InvokeOutputOptions): Output<GetDatabaseConnectionResult>

def get_database_connection(certificate_root: Optional[str] = None,
                            deployment_id: Optional[str] = None,
                            endpoint_type: Optional[str] = None,
                            id: Optional[str] = None,
                            user_id: Optional[str] = None,
                            user_type: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDatabaseConnectionResult
def get_database_connection_output(certificate_root: pulumi.Input[Optional[str]] = None,
                            deployment_id: pulumi.Input[Optional[str]] = None,
                            endpoint_type: pulumi.Input[Optional[str]] = None,
                            id: pulumi.Input[Optional[str]] = None,
                            user_id: pulumi.Input[Optional[str]] = None,
                            user_type: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetDatabaseConnectionResult]

func GetDatabaseConnection(ctx *Context, args *GetDatabaseConnectionArgs, opts ...InvokeOption) (*GetDatabaseConnectionResult, error)
func GetDatabaseConnectionOutput(ctx *Context, args *GetDatabaseConnectionOutputArgs, opts ...InvokeOption) GetDatabaseConnectionResultOutput

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

public static class GetDatabaseConnection 
{
    public static Task<GetDatabaseConnectionResult> InvokeAsync(GetDatabaseConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseConnectionResult> Invoke(GetDatabaseConnectionInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseConnectionResult> Invoke(GetDatabaseConnectionInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetDatabaseConnectionResult> getDatabaseConnection(GetDatabaseConnectionArgs args, InvokeOptions options)
public static Output<GetDatabaseConnectionResult> getDatabaseConnection(GetDatabaseConnectionArgs args, InvokeOptions options)
public static Output<GetDatabaseConnectionResult> getDatabaseConnection(GetDatabaseConnectionArgs args, InvokeOutputOptions options)

fn::invoke:
  function: ibm:index/getDatabaseConnection:getDatabaseConnection
  arguments:
    # arguments dictionary

data "ibm_get_database_connection" "name" {
    # arguments
}

The following arguments are supported:

DeploymentId string

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

EndpointType string

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

UserId string

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

UserType string

User type. Not used for connection retrieval in Gen2.

CertificateRoot string

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

Id string

The unique identifier of the database_connection.

DeploymentId string

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

EndpointType string

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

UserId string

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

UserType string

User type. Not used for connection retrieval in Gen2.

CertificateRoot string

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

Id string

The unique identifier of the database_connection.

deployment_id string

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

endpoint_type string

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

user_id string

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

user_type string

User type. Not used for connection retrieval in Gen2.

certificate_root string

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

id string

The unique identifier of the database_connection.

deploymentId String

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

endpointType String

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

userId String

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

userType String

User type. Not used for connection retrieval in Gen2.

certificateRoot String

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

id String

The unique identifier of the database_connection.

deploymentId string

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

endpointType string

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

userId string

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

userType string

User type. Not used for connection retrieval in Gen2.

certificateRoot string

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

id string

The unique identifier of the database_connection.

deployment_id str

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

endpoint_type str

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

user_id str

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

user_type str

User type. Not used for connection retrieval in Gen2.

certificate_root str

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

id str

The unique identifier of the database_connection.

deploymentId String

Deployment ID.

Classic: The database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:us-south:a/<account_id>:<instance_id>::

Gen2: The Gen2 database instance CRN, for example:

crn:v1:bluemix:public:databases-for-postgresql:<region>:a/<account_id>:<instance_id>::

The Gen2 deployment CRN can be retrieved from:

The id attribute of an ibm.Database resource configured with a Gen2 plan.
The IBM Cloud UI under Databases → your instance → Overview.

endpointType String

Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. Not used for key selection in Gen2.

Constraints: Allowable values are: public, private.

userId String

User ID.

Classic: The database username to fetch connection information for.

Gen2: The name of the resource key to use. If no key with this name exists, the first available resource key for the instance is used automatically.

userType String

User type. Not used for connection retrieval in Gen2.

certificateRoot String

Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

id String

The unique identifier of the database_connection.