1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. getPostgresSqlConnectionPool
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudProjectDatabase.getPostgresSqlConnectionPool

ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Use this data source to get information about a connection pool of a postgresql cluster associated with a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

export = async () => {
    const testPool = await ovh.CloudProjectDatabase.getPostgresSqlConnectionPool({
        serviceName: "XXX",
        clusterId: "YYY",
        name: "ZZZ",
    });
    return {
        testPool: {
            serviceName: testPool.serviceName,
            clusterId: testPool.clusterId,
            name: testPool.name,
            databaseId: testPool.databaseId,
            mode: testPool.mode,
            size: testPool.size,
            port: testPool.port,
            sslMode: testPool.sslMode,
            uri: testPool.uri,
            userId: testPool.userId,
        },
    };
}

    import pulumi
import pulumi_ovh as ovh

test_pool = ovh.CloudProjectDatabase.get_postgres_sql_connection_pool(service_name="XXX",
    cluster_id="YYY",
    name="ZZZ")
pulumi.export("testPool", {
    "serviceName": test_pool.service_name,
    "clusterId": test_pool.cluster_id,
    "name": test_pool.name,
    "databaseId": test_pool.database_id,
    "mode": test_pool.mode,
    "size": test_pool.size,
    "port": test_pool.port,
    "sslMode": test_pool.ssl_mode,
    "uri": test_pool.uri,
    "userId": test_pool.user_id,
})

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudprojectdatabase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testPool, err := cloudprojectdatabase.GetPostgresSqlConnectionPool(ctx, &cloudprojectdatabase.GetPostgresSqlConnectionPoolArgs{
			ServiceName: "XXX",
			ClusterId:   "YYY",
			Name:        "ZZZ",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("testPool", pulumi.Map{
			"serviceName": testPool.ServiceName,
			"clusterId":   testPool.ClusterId,
			"name":        testPool.Name,
			"databaseId":  testPool.DatabaseId,
			"mode":        testPool.Mode,
			"size":        testPool.Size,
			"port":        testPool.Port,
			"sslMode":     testPool.SslMode,
			"uri":         testPool.Uri,
			"userId":      testPool.UserId,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPool = Ovh.CloudProjectDatabase.GetPostgresSqlConnectionPool.Invoke(new()
    {
        ServiceName = "XXX",
        ClusterId = "YYY",
        Name = "ZZZ",
    });

    return new Dictionary<string, object?>
    {
        ["testPool"] = 
        {
            { "serviceName", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.ServiceName) },
            { "clusterId", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.ClusterId) },
            { "name", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.Name) },
            { "databaseId", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.DatabaseId) },
            { "mode", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.Mode) },
            { "size", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.Size) },
            { "port", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.Port) },
            { "sslMode", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.SslMode) },
            { "uri", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.Uri) },
            { "userId", testPool.Apply(getPostgresSqlConnectionPoolResult => getPostgresSqlConnectionPoolResult.UserId) },
        },
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProjectDatabase.CloudProjectDatabaseFunctions;
import com.pulumi.ovh.CloudProjectDatabase.inputs.GetPostgresSqlConnectionPoolArgs;
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 testPool = CloudProjectDatabaseFunctions.getPostgresSqlConnectionPool(GetPostgresSqlConnectionPoolArgs.builder()
            .serviceName("XXX")
            .clusterId("YYY")
            .name("ZZZ")
            .build());

        ctx.export("testPool", Map.ofEntries(
            Map.entry("serviceName", testPool.serviceName()),
            Map.entry("clusterId", testPool.clusterId()),
            Map.entry("name", testPool.name()),
            Map.entry("databaseId", testPool.databaseId()),
            Map.entry("mode", testPool.mode()),
            Map.entry("size", testPool.size()),
            Map.entry("port", testPool.port()),
            Map.entry("sslMode", testPool.sslMode()),
            Map.entry("uri", testPool.uri()),
            Map.entry("userId", testPool.userId())
        ));
    }
}

    variables:
  testPool:
    fn::invoke:
      function: ovh:CloudProjectDatabase:getPostgresSqlConnectionPool
      arguments:
        serviceName: XXX
        clusterId: YYY
        name: ZZZ
outputs:
  testPool:
    serviceName: ${testPool.serviceName}
    clusterId: ${testPool.clusterId}
    name: ${testPool.name}
    databaseId: ${testPool.databaseId}
    mode: ${testPool.mode}
    size: ${testPool.size}
    port: ${testPool.port}
    sslMode: ${testPool.sslMode}
    uri: ${testPool.uri}
    userId: ${testPool.userId}

    Using getPostgresSqlConnectionPool

    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 getPostgresSqlConnectionPool(args: GetPostgresSqlConnectionPoolArgs, opts?: InvokeOptions): Promise<GetPostgresSqlConnectionPoolResult>
function getPostgresSqlConnectionPoolOutput(args: GetPostgresSqlConnectionPoolOutputArgs, opts?: InvokeOptions): Output<GetPostgresSqlConnectionPoolResult>
    def get_postgres_sql_connection_pool(cluster_id: Optional[str] = None,
                                     name: Optional[str] = None,
                                     service_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPostgresSqlConnectionPoolResult
def get_postgres_sql_connection_pool_output(cluster_id: Optional[pulumi.Input[str]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     service_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetPostgresSqlConnectionPoolResult]
    func LookupPostgresSqlConnectionPool(ctx *Context, args *LookupPostgresSqlConnectionPoolArgs, opts ...InvokeOption) (*LookupPostgresSqlConnectionPoolResult, error)
func LookupPostgresSqlConnectionPoolOutput(ctx *Context, args *LookupPostgresSqlConnectionPoolOutputArgs, opts ...InvokeOption) LookupPostgresSqlConnectionPoolResultOutput

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

    public static class GetPostgresSqlConnectionPool 
{
    public static Task<GetPostgresSqlConnectionPoolResult> InvokeAsync(GetPostgresSqlConnectionPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresSqlConnectionPoolResult> Invoke(GetPostgresSqlConnectionPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresSqlConnectionPoolResult> getPostgresSqlConnectionPool(GetPostgresSqlConnectionPoolArgs args, InvokeOptions options)
public static Output<GetPostgresSqlConnectionPoolResult> getPostgresSqlConnectionPool(GetPostgresSqlConnectionPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:CloudProjectDatabase/getPostgresSqlConnectionPool:getPostgresSqlConnectionPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    Cluster ID.
    Name string
    Name of the Connection pool.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    ClusterId string
    Cluster ID.
    Name string
    Name of the Connection pool.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID.
    name String
    Name of the Connection pool.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId string
    Cluster ID.
    name string
    Name of the Connection pool.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    cluster_id str
    Cluster ID.
    name str
    Name of the Connection pool.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID.
    name String
    Name of the Connection pool.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    getPostgresSqlConnectionPool Result

    The following output properties are available:

    ClusterId string
    See Argument Reference above
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mode string
    Connection mode to the connection pool Available modes:
    Name string
    See Argument Reference above
    Port int
    Port of the connection pool.
    ServiceName string
    See Argument Reference above
    Size int
    Size of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    ClusterId string
    See Argument Reference above
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mode string
    Connection mode to the connection pool Available modes:
    Name string
    See Argument Reference above
    Port int
    Port of the connection pool.
    ServiceName string
    See Argument Reference above
    Size int
    Size of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    See Argument Reference above
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    id String
    The provider-assigned unique ID for this managed resource.
    mode String
    Connection mode to the connection pool Available modes:
    name String
    See Argument Reference above
    port Integer
    Port of the connection pool.
    serviceName String
    See Argument Reference above
    size Integer
    Size of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId string
    See Argument Reference above
    databaseId string
    Database ID for a database that belongs to the Database cluster given above.
    id string
    The provider-assigned unique ID for this managed resource.
    mode string
    Connection mode to the connection pool Available modes:
    name string
    See Argument Reference above
    port number
    Port of the connection pool.
    serviceName string
    See Argument Reference above
    size number
    Size of the connection pool.
    sslMode string
    Ssl connection mode for the pool.
    uri string
    Connection URI to the pool.
    userId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    cluster_id str
    See Argument Reference above
    database_id str
    Database ID for a database that belongs to the Database cluster given above.
    id str
    The provider-assigned unique ID for this managed resource.
    mode str
    Connection mode to the connection pool Available modes:
    name str
    See Argument Reference above
    port int
    Port of the connection pool.
    service_name str
    See Argument Reference above
    size int
    Size of the connection pool.
    ssl_mode str
    Ssl connection mode for the pool.
    uri str
    Connection URI to the pool.
    user_id str
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    See Argument Reference above
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    id String
    The provider-assigned unique ID for this managed resource.
    mode String
    Connection mode to the connection pool Available modes:
    name String
    See Argument Reference above
    port Number
    Port of the connection pool.
    serviceName String
    See Argument Reference above
    size Number
    Size of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh
      Try Pulumi Cloud free. Your team will thank you.