Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. PostgresBouncer
Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.PostgresBouncer

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    PostgresBouncer Resource

    Example Usage

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

const myBouncer = new planetscale.PostgresBouncer("my_bouncer", {
    organization: "my-organization",
    database: "my-database",
    branch: "main",
    name: "my-bouncer",
    target: "primary",
    bouncerSize: "PGB_5",
    replicasPerCell: 1,
    parameters: {
        pgbouncer: {
            defaultPoolSize: "100",
        },
    },
});

    import pulumi
import pulumi_planetscale as planetscale

my_bouncer = planetscale.PostgresBouncer("my_bouncer",
    organization="my-organization",
    database="my-database",
    branch="main",
    name="my-bouncer",
    target="primary",
    bouncer_size="PGB_5",
    replicas_per_cell=1,
    parameters={
        "pgbouncer": {
            "defaultPoolSize": "100",
        },
    })

    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.NewPostgresBouncer(ctx, "my_bouncer", &planetscale.PostgresBouncerArgs{
			Organization:    pulumi.String("my-organization"),
			Database:        pulumi.String("my-database"),
			Branch:          pulumi.String("main"),
			Name:            pulumi.String("my-bouncer"),
			Target:          pulumi.String("primary"),
			BouncerSize:     pulumi.String("PGB_5"),
			ReplicasPerCell: pulumi.Float64(1),
			Parameters: pulumi.StringMapMap{
				"pgbouncer": pulumi.StringMap{
					"defaultPoolSize": pulumi.String("100"),
				},
			},
		})
		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 myBouncer = new Planetscale.PostgresBouncer("my_bouncer", new()
    {
        Organization = "my-organization",
        Database = "my-database",
        Branch = "main",
        Name = "my-bouncer",
        Target = "primary",
        BouncerSize = "PGB_5",
        ReplicasPerCell = 1,
        Parameters = 
        {
            { "pgbouncer", 
            {
                { "defaultPoolSize", "100" },
            } },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PostgresBouncer;
import com.pulumi.planetscale.PostgresBouncerArgs;
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 myBouncer = new PostgresBouncer("myBouncer", PostgresBouncerArgs.builder()
            .organization("my-organization")
            .database("my-database")
            .branch("main")
            .name("my-bouncer")
            .target("primary")
            .bouncerSize("PGB_5")
            .replicasPerCell(1.0)
            .parameters(Map.of("pgbouncer", Map.of("defaultPoolSize", "100")))
            .build());

    }
}

    resources:
  myBouncer:
    type: planetscale:PostgresBouncer
    name: my_bouncer
    properties:
      organization: my-organization
      database: my-database
      branch: main
      name: my-bouncer
      target: primary
      bouncerSize: PGB_5
      replicasPerCell: 1
      parameters:
        pgbouncer:
          defaultPoolSize: '100'

    Example coming soon!

    Create PostgresBouncer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PostgresBouncer(name: string, args: PostgresBouncerArgs, opts?: CustomResourceOptions);
    @overload
def PostgresBouncer(resource_name: str,
                    args: PostgresBouncerArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PostgresBouncer(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    branch: Optional[str] = None,
                    database: Optional[str] = None,
                    organization: Optional[str] = None,
                    bouncer_size: Optional[str] = None,
                    name: Optional[str] = None,
                    parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
                    replicas_per_cell: Optional[float] = None,
                    target: Optional[str] = None)
    func NewPostgresBouncer(ctx *Context, name string, args PostgresBouncerArgs, opts ...ResourceOption) (*PostgresBouncer, error)
    public PostgresBouncer(string name, PostgresBouncerArgs args, CustomResourceOptions? opts = null)
    public PostgresBouncer(String name, PostgresBouncerArgs args)
public PostgresBouncer(String name, PostgresBouncerArgs args, CustomResourceOptions options)

    type: planetscale:PostgresBouncer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "planetscale_postgres_bouncer" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PostgresBouncerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PostgresBouncerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PostgresBouncerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresBouncerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresBouncerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var postgresBouncerResource = new Planetscale.PostgresBouncer("postgresBouncerResource", new()
{
    Branch = "string",
    Database = "string",
    Organization = "string",
    BouncerSize = "string",
    Name = "string",
    Parameters = 
    {
        { "string", new InputMap<string>
        {
            { "string", "string" },
        } },
    },
    ReplicasPerCell = 0,
    Target = "string",
});

    example, err := planetscale.NewPostgresBouncer(ctx, "postgresBouncerResource", &planetscale.PostgresBouncerArgs{
	Branch:       pulumi.String("string"),
	Database:     pulumi.String("string"),
	Organization: pulumi.String("string"),
	BouncerSize:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Parameters: pulumi.StringMapMap{
		"string": pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	ReplicasPerCell: pulumi.Float64(0),
	Target:          pulumi.String("string"),
})

    resource "planetscale_postgres_bouncer" "postgresBouncerResource" {
  lifecycle {
    create_before_destroy = true
  }
  branch       = "string"
  database     = "string"
  organization = "string"
  bouncer_size = "string"
  name         = "string"
  parameters = {
    "string" = {
      "string" = "string"
    }
  }
  replicas_per_cell = 0
  target            = "string"
}

    var postgresBouncerResource = new PostgresBouncer("postgresBouncerResource", PostgresBouncerArgs.builder()
    .branch("string")
    .database("string")
    .organization("string")
    .bouncerSize("string")
    .name("string")
    .parameters(Map.of("string", Map.of("string", "string")))
    .replicasPerCell(0.0)
    .target("string")
    .build());

    postgres_bouncer_resource = planetscale.PostgresBouncer("postgresBouncerResource",
    branch="string",
    database="string",
    organization="string",
    bouncer_size="string",
    name="string",
    parameters={
        "string": {
            "string": "string",
        },
    },
    replicas_per_cell=float(0),
    target="string")

    const postgresBouncerResource = new planetscale.PostgresBouncer("postgresBouncerResource", {
    branch: "string",
    database: "string",
    organization: "string",
    bouncerSize: "string",
    name: "string",
    parameters: {
        string: {
            string: "string",
        },
    },
    replicasPerCell: 0,
    target: "string",
});

    type: planetscale:PostgresBouncer
properties:
    bouncerSize: string
    branch: string
    database: string
    name: string
    organization: string
    parameters:
        string:
            string: string
    replicasPerCell: 0
    target: string

    PostgresBouncer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PostgresBouncer resource accepts the following input properties:

    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.
    BouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    Name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    Target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    BouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    Name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    Target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    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.
    name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    bouncerSize String
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    name String
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target String
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    bouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    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.
    name str
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target str
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    bouncerSize String
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    name String
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target String
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PostgresBouncer resource produces the following output properties:

    Actor PostgresBouncerActor
    Id string
    The provider-assigned unique ID for this managed resource.
    Actor PostgresBouncerActor
    Id string
    The provider-assigned unique ID for this managed resource.
    actor object
    id string
    The provider-assigned unique ID for this managed resource.
    actor PostgresBouncerActor
    id String
    The provider-assigned unique ID for this managed resource.
    actor PostgresBouncerActor
    id string
    The provider-assigned unique ID for this managed resource.
    actor PostgresBouncerActor
    id str
    The provider-assigned unique ID for this managed resource.
    actor Property Map
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PostgresBouncer Resource

    Get an existing PostgresBouncer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PostgresBouncerState, opts?: CustomResourceOptions): PostgresBouncer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actor: Optional[PostgresBouncerActorArgs] = None,
        bouncer_size: Optional[str] = None,
        branch: Optional[str] = None,
        database: Optional[str] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
        replicas_per_cell: Optional[float] = None,
        target: Optional[str] = None) -> PostgresBouncer
    func GetPostgresBouncer(ctx *Context, name string, id IDInput, state *PostgresBouncerState, opts ...ResourceOption) (*PostgresBouncer, error)
    public static PostgresBouncer Get(string name, Input<string> id, PostgresBouncerState? state, CustomResourceOptions? opts = null)
    public static PostgresBouncer get(String name, Output<String> id, PostgresBouncerState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:PostgresBouncer    get:      id: ${id}
    import {
  to = planetscale_postgres_bouncer.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Actor PostgresBouncerActor
    BouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    Target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    Actor PostgresBouncerActorArgs
    BouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    Target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    actor PostgresBouncerActor
    bouncerSize String
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    name String
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target String
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    actor PostgresBouncerActor
    bouncerSize string
    The bouncer size, e.g. PGB_5, PGB_10, PGB_20, PGB_40, PGB_80, or PGB_160. Defaults to PGB_5.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    name string
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target string
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    actor PostgresBouncerActorArgs
    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.
    branch str
    Branch name from list_branches. Example: main.
    database str
    Database name slug from list_databases. Example: app-db.
    name str
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    organization str
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target str
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.
    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.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    name String
    The name of the bouncer, at most 12 characters. Clients connect through the bouncer by appending it to the username, e.g. postgres.abc123|my-bouncer. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme.
    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 number of PgBouncer instances per availability zone. Defaults to 1.
    target String
    The servers the bouncer routes connections to: primary, replica, or replica_az_affinity (replicas in the same availability zone as the bouncer). must be one of ["primary", "replica", "replicaazaffinity"]; Requires replacement if changed.

    Supporting Types

    PostgresBouncerActor, PostgresBouncerActorArgs

    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

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = planetscale_postgres_bouncer.my_planetscale_postgres_bouncer

    id = jsonencode({

    branch       = "..."

database     = "..."

name         = "..."

organization = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/postgresBouncer:PostgresBouncer my_planetscale_postgres_bouncer '{"branch": "...", "database": "...", "name": "...", "organization": "..."}'

    To learn more about importing existing cloud resources, see Importing resources.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial