1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getConnectionPool
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi

    Gets information about a connection pool in an Aiven for PostgreSQL® service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const main = aiven.getConnectionPool({
        project: exampleProject.project,
        serviceName: examplePostgres.serviceName,
        poolName: "example-pool",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    main = aiven.get_connection_pool(project=example_project["project"],
        service_name=example_postgres["serviceName"],
        pool_name="example-pool")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.GetConnectionPool(ctx, &aiven.LookupConnectionPoolArgs{
    			Project:     exampleProject.Project,
    			ServiceName: examplePostgres.ServiceName,
    			PoolName:    "example-pool",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var main = Aiven.Index.GetConnectionPool.Invoke(new()
        {
            Project = exampleProject.Project,
            ServiceName = examplePostgres.ServiceName,
            PoolName = "example-pool",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.AivenFunctions;
    import com.pulumi.aiven.inputs.GetConnectionPoolArgs;
    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 main = AivenFunctions.getConnectionPool(GetConnectionPoolArgs.builder()
                .project(exampleProject.project())
                .serviceName(examplePostgres.serviceName())
                .poolName("example-pool")
                .build());
    
        }
    }
    
    variables:
      main:
        fn::invoke:
          function: aiven:getConnectionPool
          arguments:
            project: ${exampleProject.project}
            serviceName: ${examplePostgres.serviceName}
            poolName: example-pool
    
    Example coming soon!
    

    Using getConnectionPool

    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 getConnectionPool(args: GetConnectionPoolArgs, opts?: InvokeOptions): Promise<GetConnectionPoolResult>
    function getConnectionPoolOutput(args: GetConnectionPoolOutputArgs, opts?: InvokeOptions): Output<GetConnectionPoolResult>
    def get_connection_pool(pool_name: Optional[str] = None,
                            project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            timeouts: Optional[GetConnectionPoolTimeouts] = None,
                            opts: Optional[InvokeOptions] = None) -> GetConnectionPoolResult
    def get_connection_pool_output(pool_name: pulumi.Input[Optional[str]] = None,
                            project: pulumi.Input[Optional[str]] = None,
                            service_name: pulumi.Input[Optional[str]] = None,
                            timeouts: pulumi.Input[Optional[GetConnectionPoolTimeoutsArgs]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetConnectionPoolResult]
    func LookupConnectionPool(ctx *Context, args *LookupConnectionPoolArgs, opts ...InvokeOption) (*LookupConnectionPoolResult, error)
    func LookupConnectionPoolOutput(ctx *Context, args *LookupConnectionPoolOutputArgs, opts ...InvokeOption) LookupConnectionPoolResultOutput

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

    public static class GetConnectionPool 
    {
        public static Task<GetConnectionPoolResult> InvokeAsync(GetConnectionPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionPoolResult> Invoke(GetConnectionPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionPoolResult> getConnectionPool(GetConnectionPoolArgs args, InvokeOptions options)
    public static Output<GetConnectionPoolResult> getConnectionPool(GetConnectionPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getConnectionPool:getConnectionPool
      arguments:
        # arguments dictionary
    data "aiven_getconnectionpool" "name" {
        # arguments
    }

    The following arguments are supported:

    PoolName string
    PgBouncer connection pool name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetConnectionPoolTimeouts
    PoolName string
    PgBouncer connection pool name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetConnectionPoolTimeouts
    pool_name string
    PgBouncer connection pool name.
    project string
    Project name.
    service_name string
    Service name.
    timeouts object
    poolName String
    PgBouncer connection pool name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetConnectionPoolTimeouts
    poolName string
    PgBouncer connection pool name.
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetConnectionPoolTimeouts
    pool_name str
    PgBouncer connection pool name.
    project str
    Project name.
    service_name str
    Service name.
    timeouts GetConnectionPoolTimeouts
    poolName String
    PgBouncer connection pool name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map

    getConnectionPool Result

    The following output properties are available:

    ConnectionUri string
    Connection URI for the DB pool.
    DatabaseName string
    Service database name.
    Id string
    Resource ID composed as: project/service_name/pool_name.
    PoolMode string
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    PoolName string
    PgBouncer connection pool name.
    PoolSize int
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    Project string
    Project name.
    ServiceName string
    Service name.
    Username string
    Service username.
    Timeouts GetConnectionPoolTimeouts
    ConnectionUri string
    Connection URI for the DB pool.
    DatabaseName string
    Service database name.
    Id string
    Resource ID composed as: project/service_name/pool_name.
    PoolMode string
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    PoolName string
    PgBouncer connection pool name.
    PoolSize int
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    Project string
    Project name.
    ServiceName string
    Service name.
    Username string
    Service username.
    Timeouts GetConnectionPoolTimeouts
    connection_uri string
    Connection URI for the DB pool.
    database_name string
    Service database name.
    id string
    Resource ID composed as: project/service_name/pool_name.
    pool_mode string
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    pool_name string
    PgBouncer connection pool name.
    pool_size number
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    project string
    Project name.
    service_name string
    Service name.
    username string
    Service username.
    timeouts object
    connectionUri String
    Connection URI for the DB pool.
    databaseName String
    Service database name.
    id String
    Resource ID composed as: project/service_name/pool_name.
    poolMode String
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    poolName String
    PgBouncer connection pool name.
    poolSize Integer
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    project String
    Project name.
    serviceName String
    Service name.
    username String
    Service username.
    timeouts GetConnectionPoolTimeouts
    connectionUri string
    Connection URI for the DB pool.
    databaseName string
    Service database name.
    id string
    Resource ID composed as: project/service_name/pool_name.
    poolMode string
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    poolName string
    PgBouncer connection pool name.
    poolSize number
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    project string
    Project name.
    serviceName string
    Service name.
    username string
    Service username.
    timeouts GetConnectionPoolTimeouts
    connection_uri str
    Connection URI for the DB pool.
    database_name str
    Service database name.
    id str
    Resource ID composed as: project/service_name/pool_name.
    pool_mode str
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    pool_name str
    PgBouncer connection pool name.
    pool_size int
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    project str
    Project name.
    service_name str
    Service name.
    username str
    Service username.
    timeouts GetConnectionPoolTimeouts
    connectionUri String
    Connection URI for the DB pool.
    databaseName String
    Service database name.
    id String
    Resource ID composed as: project/service_name/pool_name.
    poolMode String
    PGBouncer pool mode. The possible values are session, statement and transaction. The default value is transaction.
    poolName String
    PgBouncer connection pool name.
    poolSize Number
    Size of PGBouncer's PostgreSQL side connection pool. The default value is 10.
    project String
    Project name.
    serviceName String
    Service name.
    username String
    Service username.
    timeouts Property Map

    Supporting Types

    GetConnectionPoolTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.53.1
    published on Thursday, Apr 23, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.