planetscale.getPostgresBouncers

planetscale 1.8.0, Aug 13 26

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale

planetscale/terraform-provider-planetscale

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

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

const myPostgresbouncers = planetscale.getPostgresBouncers({
    branch: "...my_branch...",
    database: "...my_database...",
    organization: "...my_organization...",
});

import pulumi
import pulumi_planetscale as planetscale

my_postgresbouncers = planetscale.get_postgres_bouncers(branch="...my_branch...",
    database="...my_database...",
    organization="...my_organization...")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.GetPostgresBouncers(ctx, &planetscale.GetPostgresBouncersArgs{
			Branch:       "...my_branch...",
			Database:     "...my_database...",
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myPostgresbouncers = Planetscale.GetPostgresBouncers.Invoke(new()
    {
        Branch = "...my_branch...",
        Database = "...my_database...",
        Organization = "...my_organization...",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetPostgresBouncersArgs;
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 myPostgresbouncers = PlanetscaleFunctions.getPostgresBouncers(GetPostgresBouncersArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .build());

    }
}

variables:
  myPostgresbouncers:
    fn::invoke:
      function: planetscale:getPostgresBouncers
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'

Example coming soon!

Using getPostgresBouncers

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 getPostgresBouncers(args: GetPostgresBouncersArgs, opts?: InvokeOptions): Promise<GetPostgresBouncersResult>
function getPostgresBouncersOutput(args: GetPostgresBouncersOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresBouncersResult>

def get_postgres_bouncers(branch: Optional[str] = None,
                          database: Optional[str] = None,
                          organization: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPostgresBouncersResult
def get_postgres_bouncers_output(branch: pulumi.Input[Optional[str]] = None,
                          database: pulumi.Input[Optional[str]] = None,
                          organization: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresBouncersResult]

func GetPostgresBouncers(ctx *Context, args *GetPostgresBouncersArgs, opts ...InvokeOption) (*GetPostgresBouncersResult, error)
func GetPostgresBouncersOutput(ctx *Context, args *GetPostgresBouncersOutputArgs, opts ...InvokeOption) GetPostgresBouncersResultOutput

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

public static class GetPostgresBouncers 
{
    public static Task<GetPostgresBouncersResult> InvokeAsync(GetPostgresBouncersArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresBouncersResult> Invoke(GetPostgresBouncersInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresBouncersResult> Invoke(GetPostgresBouncersInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetPostgresBouncersResult> getPostgresBouncers(GetPostgresBouncersArgs args, InvokeOptions options)
public static Output<GetPostgresBouncersResult> getPostgresBouncers(GetPostgresBouncersArgs args, InvokeOptions options)
public static Output<GetPostgresBouncersResult> getPostgresBouncers(GetPostgresBouncersArgs args, InvokeOutputOptions options)

fn::invoke:
  function: planetscale:index/getPostgresBouncers:getPostgresBouncers
  arguments:
    # arguments dictionary

data "planetscale_get_postgres_bouncers" "name" {
    # arguments
}

The following arguments are supported:

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Organization string: Organization name slug from list_organizations. Example: acme.

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Organization string: Organization name slug from list_organizations. Example: acme.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
organization string: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
organization String: Organization name slug from list_organizations. Example: acme.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
organization string: Organization name slug from list_organizations. Example: acme.

branch str: Branch name from list_branches. Example: main.
database str: Database name slug from list_databases. Example: app-db.
organization str: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
organization String: Organization name slug from list_organizations. Example: acme.

getPostgresBouncers Result

The following output properties are available:

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Datas List<GetPostgresBouncersData>
Id string: The provider-assigned unique ID for this managed resource.
Organization string: Organization name slug from list_organizations. Example: acme.

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Datas []GetPostgresBouncersData
Id string: The provider-assigned unique ID for this managed resource.
Organization string: Organization name slug from list_organizations. Example: acme.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
datas list(object)
id string: The provider-assigned unique ID for this managed resource.
organization string: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
datas List<GetPostgresBouncersData>
id String: The provider-assigned unique ID for this managed resource.
organization String: Organization name slug from list_organizations. Example: acme.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
datas GetPostgresBouncersData[]
id string: The provider-assigned unique ID for this managed resource.
organization string: Organization name slug from list_organizations. Example: acme.

branch str: Branch name from list_branches. Example: main.
database str: Database name slug from list_databases. Example: app-db.
datas Sequence[GetPostgresBouncersData]
id str: The provider-assigned unique ID for this managed resource.
organization str: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
datas List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
organization String: Organization name slug from list_organizations. Example: acme.

Supporting Types

GetPostgresBouncersData

Actor GetPostgresBouncersDataActor
BouncerSize string: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
Id string: The ID of the bouncer
Name string: The name of the bouncer
Parameters Dictionary<string, ImmutableDictionary<string, string>>: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
ReplicasPerCell double: The count of replicas in each cell
Target string: The instance type the bouncer targets

Actor GetPostgresBouncersDataActor
BouncerSize string: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
Id string: The ID of the bouncer
Name string: The name of the bouncer
Parameters map[string]map[string]string: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
ReplicasPerCell float64: The count of replicas in each cell
Target string: The instance type the bouncer targets

actor object
bouncer_size string: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
id string: The ID of the bouncer
name string: The name of the bouncer
parameters map(map(string)): PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
replicas_per_cell number: The count of replicas in each cell
target string: The instance type the bouncer targets

actor GetPostgresBouncersDataActor
bouncerSize String: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
id String: The ID of the bouncer
name String: The name of the bouncer
parameters Map<String,Map<String,String>>: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
replicasPerCell Double: The count of replicas in each cell
target String: The instance type the bouncer targets

actor GetPostgresBouncersDataActor
bouncerSize string: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
id string: The ID of the bouncer
name string: The name of the bouncer
parameters {[key: string]: {[key: string]: string}}: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
replicasPerCell number: The count of replicas in each cell
target string: The instance type the bouncer targets

actor GetPostgresBouncersDataActor
bouncer_size str: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
id str: The ID of the bouncer
name str: The name of the bouncer
parameters Mapping[str, Mapping[str, str]]: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
replicas_per_cell float: The count of replicas in each cell
target str: The instance type the bouncer targets

actor Property Map
bouncerSize String: The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
id String: The ID of the bouncer
name String: The name of the bouncer
parameters Map<Map<String>>: PgBouncer parameter overrides, nested by namespace, e.g. { pgbouncer = { defaultpoolsize = "100" } }. Omitted parameters are reset to their defaults.
replicasPerCell Number: The count of replicas in each cell
target String: The instance type the bouncer targets

GetPostgresBouncersDataActor

Id string: The ID of the actor

Id string: The ID of the actor

id string: The ID of the actor

id String: The ID of the actor

id string: The ID of the actor

id str: The ID of the actor

id String: The ID of the actor

Package Details

Repository: planetscale planetscale/terraform-provider-planetscale
License
Notes: This Pulumi package is based on the planetscale Terraform Provider.

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale

Schema (JSON)

planetscale/terraform-provider-planetscale

planetscale.getPostgresBouncers

On this page

On this page

Example Usage

Using getPostgresBouncers

getPostgresBouncers Result

Supporting Types

GetPostgresBouncersData

GetPostgresBouncersDataActor

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.getPostgresBouncers

On this page

On this page

Example Usage

Using getPostgresBouncers

getPostgresBouncers Result

Supporting Types

GetPostgresBouncersData

GetPostgresBouncersDataActor

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.