digitalocean.DatabasePostgresqlConfig
Explore with Pulumi AI
Provides a virtual resource that can be used to change advanced configuration options for a DigitalOcean managed PostgreSQL database cluster.
Note PostgreSQL configurations are only removed from state when destroyed. The remote configuration is not unset.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const exampleDatabaseCluster = new digitalocean.DatabaseCluster("example", {
    name: "example-postgresql-cluster",
    engine: "pg",
    version: "15",
    size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
    region: digitalocean.Region.NYC1,
    nodeCount: 1,
});
const example = new digitalocean.DatabasePostgresqlConfig("example", {
    clusterId: exampleDatabaseCluster.id,
    timezone: "UTC",
    workMem: 16,
});
import pulumi
import pulumi_digitalocean as digitalocean
example_database_cluster = digitalocean.DatabaseCluster("example",
    name="example-postgresql-cluster",
    engine="pg",
    version="15",
    size=digitalocean.DatabaseSlug.D_B_1_VPCU1_GB,
    region=digitalocean.Region.NYC1,
    node_count=1)
example = digitalocean.DatabasePostgresqlConfig("example",
    cluster_id=example_database_cluster.id,
    timezone="UTC",
    work_mem=16)
package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDatabaseCluster, err := digitalocean.NewDatabaseCluster(ctx, "example", &digitalocean.DatabaseClusterArgs{
			Name:      pulumi.String("example-postgresql-cluster"),
			Engine:    pulumi.String("pg"),
			Version:   pulumi.String("15"),
			Size:      pulumi.String(digitalocean.DatabaseSlug_DB_1VPCU1GB),
			Region:    pulumi.String(digitalocean.RegionNYC1),
			NodeCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewDatabasePostgresqlConfig(ctx, "example", &digitalocean.DatabasePostgresqlConfigArgs{
			ClusterId: exampleDatabaseCluster.ID(),
			Timezone:  pulumi.String("UTC"),
			WorkMem:   pulumi.Int(16),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() => 
{
    var exampleDatabaseCluster = new DigitalOcean.DatabaseCluster("example", new()
    {
        Name = "example-postgresql-cluster",
        Engine = "pg",
        Version = "15",
        Size = DigitalOcean.DatabaseSlug.DB_1VPCU1GB,
        Region = DigitalOcean.Region.NYC1,
        NodeCount = 1,
    });
    var example = new DigitalOcean.DatabasePostgresqlConfig("example", new()
    {
        ClusterId = exampleDatabaseCluster.Id,
        Timezone = "UTC",
        WorkMem = 16,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DatabaseCluster;
import com.pulumi.digitalocean.DatabaseClusterArgs;
import com.pulumi.digitalocean.DatabasePostgresqlConfig;
import com.pulumi.digitalocean.DatabasePostgresqlConfigArgs;
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 exampleDatabaseCluster = new DatabaseCluster("exampleDatabaseCluster", DatabaseClusterArgs.builder()
            .name("example-postgresql-cluster")
            .engine("pg")
            .version("15")
            .size("db-s-1vcpu-1gb")
            .region("nyc1")
            .nodeCount(1)
            .build());
        var example = new DatabasePostgresqlConfig("example", DatabasePostgresqlConfigArgs.builder()
            .clusterId(exampleDatabaseCluster.id())
            .timezone("UTC")
            .workMem(16)
            .build());
    }
}
resources:
  example:
    type: digitalocean:DatabasePostgresqlConfig
    properties:
      clusterId: ${exampleDatabaseCluster.id}
      timezone: UTC
      workMem: 16
  exampleDatabaseCluster:
    type: digitalocean:DatabaseCluster
    name: example
    properties:
      name: example-postgresql-cluster
      engine: pg
      version: '15'
      size: db-s-1vcpu-1gb
      region: nyc1
      nodeCount: 1
Create DatabasePostgresqlConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatabasePostgresqlConfig(name: string, args: DatabasePostgresqlConfigArgs, opts?: CustomResourceOptions);@overload
def DatabasePostgresqlConfig(resource_name: str,
                             args: DatabasePostgresqlConfigArgs,
                             opts: Optional[ResourceOptions] = None)
@overload
def DatabasePostgresqlConfig(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             cluster_id: Optional[str] = None,
                             autovacuum_analyze_scale_factor: Optional[float] = None,
                             autovacuum_analyze_threshold: Optional[int] = None,
                             autovacuum_freeze_max_age: Optional[int] = None,
                             autovacuum_max_workers: Optional[int] = None,
                             autovacuum_naptime: Optional[int] = None,
                             autovacuum_vacuum_cost_delay: Optional[int] = None,
                             autovacuum_vacuum_cost_limit: Optional[int] = None,
                             autovacuum_vacuum_scale_factor: Optional[float] = None,
                             autovacuum_vacuum_threshold: Optional[int] = None,
                             backup_hour: Optional[int] = None,
                             backup_minute: Optional[int] = None,
                             bgwriter_delay: Optional[int] = None,
                             bgwriter_flush_after: Optional[int] = None,
                             bgwriter_lru_maxpages: Optional[int] = None,
                             bgwriter_lru_multiplier: Optional[float] = None,
                             deadlock_timeout: Optional[int] = None,
                             default_toast_compression: Optional[str] = None,
                             idle_in_transaction_session_timeout: Optional[int] = None,
                             jit: Optional[bool] = None,
                             log_autovacuum_min_duration: Optional[int] = None,
                             log_error_verbosity: Optional[str] = None,
                             log_line_prefix: Optional[str] = None,
                             log_min_duration_statement: Optional[int] = None,
                             max_files_per_process: Optional[int] = None,
                             max_locks_per_transaction: Optional[int] = None,
                             max_logical_replication_workers: Optional[int] = None,
                             max_parallel_workers: Optional[int] = None,
                             max_parallel_workers_per_gather: Optional[int] = None,
                             max_pred_locks_per_transaction: Optional[int] = None,
                             max_prepared_transactions: Optional[int] = None,
                             max_replication_slots: Optional[int] = None,
                             max_stack_depth: Optional[int] = None,
                             max_standby_archive_delay: Optional[int] = None,
                             max_standby_streaming_delay: Optional[int] = None,
                             max_wal_senders: Optional[int] = None,
                             max_worker_processes: Optional[int] = None,
                             pg_partman_bgw_interval: Optional[int] = None,
                             pg_partman_bgw_role: Optional[str] = None,
                             pg_stat_statements_track: Optional[str] = None,
                             pgbouncers: Optional[Sequence[DatabasePostgresqlConfigPgbouncerArgs]] = None,
                             shared_buffers_percentage: Optional[float] = None,
                             temp_file_limit: Optional[int] = None,
                             timescaledbs: Optional[Sequence[DatabasePostgresqlConfigTimescaledbArgs]] = None,
                             timezone: Optional[str] = None,
                             track_activity_query_size: Optional[int] = None,
                             track_commit_timestamp: Optional[str] = None,
                             track_functions: Optional[str] = None,
                             track_io_timing: Optional[str] = None,
                             wal_sender_timeout: Optional[int] = None,
                             wal_writer_delay: Optional[int] = None,
                             work_mem: Optional[int] = None)func NewDatabasePostgresqlConfig(ctx *Context, name string, args DatabasePostgresqlConfigArgs, opts ...ResourceOption) (*DatabasePostgresqlConfig, error)public DatabasePostgresqlConfig(string name, DatabasePostgresqlConfigArgs args, CustomResourceOptions? opts = null)
public DatabasePostgresqlConfig(String name, DatabasePostgresqlConfigArgs args)
public DatabasePostgresqlConfig(String name, DatabasePostgresqlConfigArgs args, CustomResourceOptions options)
type: digitalocean:DatabasePostgresqlConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DatabasePostgresqlConfigArgs
- 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 DatabasePostgresqlConfigArgs
- 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 DatabasePostgresqlConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabasePostgresqlConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabasePostgresqlConfigArgs
- 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 databasePostgresqlConfigResource = new DigitalOcean.DatabasePostgresqlConfig("databasePostgresqlConfigResource", new()
{
    ClusterId = "string",
    AutovacuumAnalyzeScaleFactor = 0,
    AutovacuumAnalyzeThreshold = 0,
    AutovacuumFreezeMaxAge = 0,
    AutovacuumMaxWorkers = 0,
    AutovacuumNaptime = 0,
    AutovacuumVacuumCostDelay = 0,
    AutovacuumVacuumCostLimit = 0,
    AutovacuumVacuumScaleFactor = 0,
    AutovacuumVacuumThreshold = 0,
    BackupHour = 0,
    BackupMinute = 0,
    BgwriterDelay = 0,
    BgwriterFlushAfter = 0,
    BgwriterLruMaxpages = 0,
    BgwriterLruMultiplier = 0,
    DeadlockTimeout = 0,
    DefaultToastCompression = "string",
    IdleInTransactionSessionTimeout = 0,
    Jit = false,
    LogAutovacuumMinDuration = 0,
    LogErrorVerbosity = "string",
    LogLinePrefix = "string",
    LogMinDurationStatement = 0,
    MaxFilesPerProcess = 0,
    MaxLocksPerTransaction = 0,
    MaxLogicalReplicationWorkers = 0,
    MaxParallelWorkers = 0,
    MaxParallelWorkersPerGather = 0,
    MaxPredLocksPerTransaction = 0,
    MaxPreparedTransactions = 0,
    MaxReplicationSlots = 0,
    MaxStackDepth = 0,
    MaxStandbyArchiveDelay = 0,
    MaxStandbyStreamingDelay = 0,
    MaxWalSenders = 0,
    MaxWorkerProcesses = 0,
    PgPartmanBgwInterval = 0,
    PgPartmanBgwRole = "string",
    PgStatStatementsTrack = "string",
    Pgbouncers = new[]
    {
        new DigitalOcean.Inputs.DatabasePostgresqlConfigPgbouncerArgs
        {
            AutodbIdleTimeout = 0,
            AutodbMaxDbConnections = 0,
            AutodbPoolMode = "string",
            AutodbPoolSize = 0,
            IgnoreStartupParameters = new[]
            {
                "string",
            },
            MinPoolSize = 0,
            ServerIdleTimeout = 0,
            ServerLifetime = 0,
            ServerResetQueryAlways = false,
        },
    },
    SharedBuffersPercentage = 0,
    TempFileLimit = 0,
    Timescaledbs = new[]
    {
        new DigitalOcean.Inputs.DatabasePostgresqlConfigTimescaledbArgs
        {
            MaxBackgroundWorkers = 0,
        },
    },
    Timezone = "string",
    TrackActivityQuerySize = 0,
    TrackCommitTimestamp = "string",
    TrackFunctions = "string",
    TrackIoTiming = "string",
    WalSenderTimeout = 0,
    WalWriterDelay = 0,
    WorkMem = 0,
});
example, err := digitalocean.NewDatabasePostgresqlConfig(ctx, "databasePostgresqlConfigResource", &digitalocean.DatabasePostgresqlConfigArgs{
	ClusterId:                       pulumi.String("string"),
	AutovacuumAnalyzeScaleFactor:    pulumi.Float64(0),
	AutovacuumAnalyzeThreshold:      pulumi.Int(0),
	AutovacuumFreezeMaxAge:          pulumi.Int(0),
	AutovacuumMaxWorkers:            pulumi.Int(0),
	AutovacuumNaptime:               pulumi.Int(0),
	AutovacuumVacuumCostDelay:       pulumi.Int(0),
	AutovacuumVacuumCostLimit:       pulumi.Int(0),
	AutovacuumVacuumScaleFactor:     pulumi.Float64(0),
	AutovacuumVacuumThreshold:       pulumi.Int(0),
	BackupHour:                      pulumi.Int(0),
	BackupMinute:                    pulumi.Int(0),
	BgwriterDelay:                   pulumi.Int(0),
	BgwriterFlushAfter:              pulumi.Int(0),
	BgwriterLruMaxpages:             pulumi.Int(0),
	BgwriterLruMultiplier:           pulumi.Float64(0),
	DeadlockTimeout:                 pulumi.Int(0),
	DefaultToastCompression:         pulumi.String("string"),
	IdleInTransactionSessionTimeout: pulumi.Int(0),
	Jit:                             pulumi.Bool(false),
	LogAutovacuumMinDuration:        pulumi.Int(0),
	LogErrorVerbosity:               pulumi.String("string"),
	LogLinePrefix:                   pulumi.String("string"),
	LogMinDurationStatement:         pulumi.Int(0),
	MaxFilesPerProcess:              pulumi.Int(0),
	MaxLocksPerTransaction:          pulumi.Int(0),
	MaxLogicalReplicationWorkers:    pulumi.Int(0),
	MaxParallelWorkers:              pulumi.Int(0),
	MaxParallelWorkersPerGather:     pulumi.Int(0),
	MaxPredLocksPerTransaction:      pulumi.Int(0),
	MaxPreparedTransactions:         pulumi.Int(0),
	MaxReplicationSlots:             pulumi.Int(0),
	MaxStackDepth:                   pulumi.Int(0),
	MaxStandbyArchiveDelay:          pulumi.Int(0),
	MaxStandbyStreamingDelay:        pulumi.Int(0),
	MaxWalSenders:                   pulumi.Int(0),
	MaxWorkerProcesses:              pulumi.Int(0),
	PgPartmanBgwInterval:            pulumi.Int(0),
	PgPartmanBgwRole:                pulumi.String("string"),
	PgStatStatementsTrack:           pulumi.String("string"),
	Pgbouncers: digitalocean.DatabasePostgresqlConfigPgbouncerArray{
		&digitalocean.DatabasePostgresqlConfigPgbouncerArgs{
			AutodbIdleTimeout:      pulumi.Int(0),
			AutodbMaxDbConnections: pulumi.Int(0),
			AutodbPoolMode:         pulumi.String("string"),
			AutodbPoolSize:         pulumi.Int(0),
			IgnoreStartupParameters: pulumi.StringArray{
				pulumi.String("string"),
			},
			MinPoolSize:            pulumi.Int(0),
			ServerIdleTimeout:      pulumi.Int(0),
			ServerLifetime:         pulumi.Int(0),
			ServerResetQueryAlways: pulumi.Bool(false),
		},
	},
	SharedBuffersPercentage: pulumi.Float64(0),
	TempFileLimit:           pulumi.Int(0),
	Timescaledbs: digitalocean.DatabasePostgresqlConfigTimescaledbArray{
		&digitalocean.DatabasePostgresqlConfigTimescaledbArgs{
			MaxBackgroundWorkers: pulumi.Int(0),
		},
	},
	Timezone:               pulumi.String("string"),
	TrackActivityQuerySize: pulumi.Int(0),
	TrackCommitTimestamp:   pulumi.String("string"),
	TrackFunctions:         pulumi.String("string"),
	TrackIoTiming:          pulumi.String("string"),
	WalSenderTimeout:       pulumi.Int(0),
	WalWriterDelay:         pulumi.Int(0),
	WorkMem:                pulumi.Int(0),
})
var databasePostgresqlConfigResource = new DatabasePostgresqlConfig("databasePostgresqlConfigResource", DatabasePostgresqlConfigArgs.builder()
    .clusterId("string")
    .autovacuumAnalyzeScaleFactor(0)
    .autovacuumAnalyzeThreshold(0)
    .autovacuumFreezeMaxAge(0)
    .autovacuumMaxWorkers(0)
    .autovacuumNaptime(0)
    .autovacuumVacuumCostDelay(0)
    .autovacuumVacuumCostLimit(0)
    .autovacuumVacuumScaleFactor(0)
    .autovacuumVacuumThreshold(0)
    .backupHour(0)
    .backupMinute(0)
    .bgwriterDelay(0)
    .bgwriterFlushAfter(0)
    .bgwriterLruMaxpages(0)
    .bgwriterLruMultiplier(0)
    .deadlockTimeout(0)
    .defaultToastCompression("string")
    .idleInTransactionSessionTimeout(0)
    .jit(false)
    .logAutovacuumMinDuration(0)
    .logErrorVerbosity("string")
    .logLinePrefix("string")
    .logMinDurationStatement(0)
    .maxFilesPerProcess(0)
    .maxLocksPerTransaction(0)
    .maxLogicalReplicationWorkers(0)
    .maxParallelWorkers(0)
    .maxParallelWorkersPerGather(0)
    .maxPredLocksPerTransaction(0)
    .maxPreparedTransactions(0)
    .maxReplicationSlots(0)
    .maxStackDepth(0)
    .maxStandbyArchiveDelay(0)
    .maxStandbyStreamingDelay(0)
    .maxWalSenders(0)
    .maxWorkerProcesses(0)
    .pgPartmanBgwInterval(0)
    .pgPartmanBgwRole("string")
    .pgStatStatementsTrack("string")
    .pgbouncers(DatabasePostgresqlConfigPgbouncerArgs.builder()
        .autodbIdleTimeout(0)
        .autodbMaxDbConnections(0)
        .autodbPoolMode("string")
        .autodbPoolSize(0)
        .ignoreStartupParameters("string")
        .minPoolSize(0)
        .serverIdleTimeout(0)
        .serverLifetime(0)
        .serverResetQueryAlways(false)
        .build())
    .sharedBuffersPercentage(0)
    .tempFileLimit(0)
    .timescaledbs(DatabasePostgresqlConfigTimescaledbArgs.builder()
        .maxBackgroundWorkers(0)
        .build())
    .timezone("string")
    .trackActivityQuerySize(0)
    .trackCommitTimestamp("string")
    .trackFunctions("string")
    .trackIoTiming("string")
    .walSenderTimeout(0)
    .walWriterDelay(0)
    .workMem(0)
    .build());
database_postgresql_config_resource = digitalocean.DatabasePostgresqlConfig("databasePostgresqlConfigResource",
    cluster_id="string",
    autovacuum_analyze_scale_factor=0,
    autovacuum_analyze_threshold=0,
    autovacuum_freeze_max_age=0,
    autovacuum_max_workers=0,
    autovacuum_naptime=0,
    autovacuum_vacuum_cost_delay=0,
    autovacuum_vacuum_cost_limit=0,
    autovacuum_vacuum_scale_factor=0,
    autovacuum_vacuum_threshold=0,
    backup_hour=0,
    backup_minute=0,
    bgwriter_delay=0,
    bgwriter_flush_after=0,
    bgwriter_lru_maxpages=0,
    bgwriter_lru_multiplier=0,
    deadlock_timeout=0,
    default_toast_compression="string",
    idle_in_transaction_session_timeout=0,
    jit=False,
    log_autovacuum_min_duration=0,
    log_error_verbosity="string",
    log_line_prefix="string",
    log_min_duration_statement=0,
    max_files_per_process=0,
    max_locks_per_transaction=0,
    max_logical_replication_workers=0,
    max_parallel_workers=0,
    max_parallel_workers_per_gather=0,
    max_pred_locks_per_transaction=0,
    max_prepared_transactions=0,
    max_replication_slots=0,
    max_stack_depth=0,
    max_standby_archive_delay=0,
    max_standby_streaming_delay=0,
    max_wal_senders=0,
    max_worker_processes=0,
    pg_partman_bgw_interval=0,
    pg_partman_bgw_role="string",
    pg_stat_statements_track="string",
    pgbouncers=[{
        "autodb_idle_timeout": 0,
        "autodb_max_db_connections": 0,
        "autodb_pool_mode": "string",
        "autodb_pool_size": 0,
        "ignore_startup_parameters": ["string"],
        "min_pool_size": 0,
        "server_idle_timeout": 0,
        "server_lifetime": 0,
        "server_reset_query_always": False,
    }],
    shared_buffers_percentage=0,
    temp_file_limit=0,
    timescaledbs=[{
        "max_background_workers": 0,
    }],
    timezone="string",
    track_activity_query_size=0,
    track_commit_timestamp="string",
    track_functions="string",
    track_io_timing="string",
    wal_sender_timeout=0,
    wal_writer_delay=0,
    work_mem=0)
const databasePostgresqlConfigResource = new digitalocean.DatabasePostgresqlConfig("databasePostgresqlConfigResource", {
    clusterId: "string",
    autovacuumAnalyzeScaleFactor: 0,
    autovacuumAnalyzeThreshold: 0,
    autovacuumFreezeMaxAge: 0,
    autovacuumMaxWorkers: 0,
    autovacuumNaptime: 0,
    autovacuumVacuumCostDelay: 0,
    autovacuumVacuumCostLimit: 0,
    autovacuumVacuumScaleFactor: 0,
    autovacuumVacuumThreshold: 0,
    backupHour: 0,
    backupMinute: 0,
    bgwriterDelay: 0,
    bgwriterFlushAfter: 0,
    bgwriterLruMaxpages: 0,
    bgwriterLruMultiplier: 0,
    deadlockTimeout: 0,
    defaultToastCompression: "string",
    idleInTransactionSessionTimeout: 0,
    jit: false,
    logAutovacuumMinDuration: 0,
    logErrorVerbosity: "string",
    logLinePrefix: "string",
    logMinDurationStatement: 0,
    maxFilesPerProcess: 0,
    maxLocksPerTransaction: 0,
    maxLogicalReplicationWorkers: 0,
    maxParallelWorkers: 0,
    maxParallelWorkersPerGather: 0,
    maxPredLocksPerTransaction: 0,
    maxPreparedTransactions: 0,
    maxReplicationSlots: 0,
    maxStackDepth: 0,
    maxStandbyArchiveDelay: 0,
    maxStandbyStreamingDelay: 0,
    maxWalSenders: 0,
    maxWorkerProcesses: 0,
    pgPartmanBgwInterval: 0,
    pgPartmanBgwRole: "string",
    pgStatStatementsTrack: "string",
    pgbouncers: [{
        autodbIdleTimeout: 0,
        autodbMaxDbConnections: 0,
        autodbPoolMode: "string",
        autodbPoolSize: 0,
        ignoreStartupParameters: ["string"],
        minPoolSize: 0,
        serverIdleTimeout: 0,
        serverLifetime: 0,
        serverResetQueryAlways: false,
    }],
    sharedBuffersPercentage: 0,
    tempFileLimit: 0,
    timescaledbs: [{
        maxBackgroundWorkers: 0,
    }],
    timezone: "string",
    trackActivityQuerySize: 0,
    trackCommitTimestamp: "string",
    trackFunctions: "string",
    trackIoTiming: "string",
    walSenderTimeout: 0,
    walWriterDelay: 0,
    workMem: 0,
});
type: digitalocean:DatabasePostgresqlConfig
properties:
    autovacuumAnalyzeScaleFactor: 0
    autovacuumAnalyzeThreshold: 0
    autovacuumFreezeMaxAge: 0
    autovacuumMaxWorkers: 0
    autovacuumNaptime: 0
    autovacuumVacuumCostDelay: 0
    autovacuumVacuumCostLimit: 0
    autovacuumVacuumScaleFactor: 0
    autovacuumVacuumThreshold: 0
    backupHour: 0
    backupMinute: 0
    bgwriterDelay: 0
    bgwriterFlushAfter: 0
    bgwriterLruMaxpages: 0
    bgwriterLruMultiplier: 0
    clusterId: string
    deadlockTimeout: 0
    defaultToastCompression: string
    idleInTransactionSessionTimeout: 0
    jit: false
    logAutovacuumMinDuration: 0
    logErrorVerbosity: string
    logLinePrefix: string
    logMinDurationStatement: 0
    maxFilesPerProcess: 0
    maxLocksPerTransaction: 0
    maxLogicalReplicationWorkers: 0
    maxParallelWorkers: 0
    maxParallelWorkersPerGather: 0
    maxPredLocksPerTransaction: 0
    maxPreparedTransactions: 0
    maxReplicationSlots: 0
    maxStackDepth: 0
    maxStandbyArchiveDelay: 0
    maxStandbyStreamingDelay: 0
    maxWalSenders: 0
    maxWorkerProcesses: 0
    pgPartmanBgwInterval: 0
    pgPartmanBgwRole: string
    pgStatStatementsTrack: string
    pgbouncers:
        - autodbIdleTimeout: 0
          autodbMaxDbConnections: 0
          autodbPoolMode: string
          autodbPoolSize: 0
          ignoreStartupParameters:
            - string
          minPoolSize: 0
          serverIdleTimeout: 0
          serverLifetime: 0
          serverResetQueryAlways: false
    sharedBuffersPercentage: 0
    tempFileLimit: 0
    timescaledbs:
        - maxBackgroundWorkers: 0
    timezone: string
    trackActivityQuerySize: 0
    trackCommitTimestamp: string
    trackFunctions: string
    trackIoTiming: string
    walSenderTimeout: 0
    walWriterDelay: 0
    workMem: 0
DatabasePostgresqlConfig 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 DatabasePostgresqlConfig resource accepts the following input properties:
- ClusterId string
- The ID of the target PostgreSQL cluster.
- AutovacuumAnalyze doubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- AutovacuumNaptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- AutovacuumVacuum doubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- BackupHour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- BackupMinute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- BgwriterDelay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- BgwriterFlush intAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- BgwriterLru intMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- BgwriterLru doubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- DeadlockTimeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- DefaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- Jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- LogError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- LogLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots.
- MaxStack intDepth 
- Maximum depth of the stack in bytes.
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds.
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- PgPartman intBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- PgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- PgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- Pgbouncers
List<Pulumi.Digital Ocean. Inputs. Database Postgresql Config Pgbouncer> 
- PGBouncer connection pooling settings
- double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- Timescaledbs
List<Pulumi.Digital Ocean. Inputs. Database Postgresql Config Timescaledb> 
- TimescaleDB extension configuration values
- Timezone string
- PostgreSQL service timezone
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- TrackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- TrackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- TrackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- WorkMem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- ClusterId string
- The ID of the target PostgreSQL cluster.
- AutovacuumAnalyze float64Scale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- AutovacuumNaptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- AutovacuumVacuum float64Scale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- BackupHour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- BackupMinute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- BgwriterDelay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- BgwriterFlush intAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- BgwriterLru intMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- BgwriterLru float64Multiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- DeadlockTimeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- DefaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- Jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- LogError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- LogLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots.
- MaxStack intDepth 
- Maximum depth of the stack in bytes.
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds.
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- PgPartman intBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- PgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- PgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- Pgbouncers
[]DatabasePostgresql Config Pgbouncer Args 
- PGBouncer connection pooling settings
- float64
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- Timescaledbs
[]DatabasePostgresql Config Timescaledb Args 
- TimescaleDB extension configuration values
- Timezone string
- PostgreSQL service timezone
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- TrackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- TrackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- TrackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- WorkMem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- clusterId String
- The ID of the target PostgreSQL cluster.
- autovacuumAnalyze DoubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze IntegerThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze IntegerMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax IntegerWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime Integer
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum IntegerCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum IntegerCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum DoubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum IntegerThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour Integer
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute Integer
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay Integer
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush IntegerAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru IntegerMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru DoubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- deadlockTimeout Integer
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast StringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn IntegerTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit Boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum IntegerMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError StringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine StringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin IntegerDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles IntegerPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks IntegerPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical IntegerReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel IntegerWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel IntegerWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred IntegerLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared IntegerTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication IntegerSlots 
- PostgreSQL maximum replication slots.
- maxStack IntegerDepth 
- Maximum depth of the stack in bytes.
- maxStandby IntegerArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby IntegerStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal IntegerSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker IntegerProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman IntegerBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman StringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat StringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
List<DatabasePostgresql Config Pgbouncer> 
- PGBouncer connection pooling settings
- Double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile IntegerLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
List<DatabasePostgresql Config Timescaledb> 
- TimescaleDB extension configuration values
- timezone String
- PostgreSQL service timezone
- trackActivity IntegerQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit StringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions String
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo StringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender IntegerTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter IntegerDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem Integer
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- clusterId string
- The ID of the target PostgreSQL cluster.
- autovacuumAnalyze numberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze numberThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze numberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax numberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime number
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum numberCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum numberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum numberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum numberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour number
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute number
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay number
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush numberAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru numberMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru numberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- deadlockTimeout number
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn numberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum numberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin numberDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles numberPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks numberPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical numberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel numberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel numberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred numberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared numberTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication numberSlots 
- PostgreSQL maximum replication slots.
- maxStack numberDepth 
- Maximum depth of the stack in bytes.
- maxStandby numberArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby numberStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal numberSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker numberProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman numberBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
DatabasePostgresql Config Pgbouncer[] 
- PGBouncer connection pooling settings
- number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile numberLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
DatabasePostgresql Config Timescaledb[] 
- TimescaleDB extension configuration values
- timezone string
- PostgreSQL service timezone
- trackActivity numberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender numberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter numberDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem number
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- cluster_id str
- The ID of the target PostgreSQL cluster.
- autovacuum_analyze_ floatscale_ factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuum_analyze_ intthreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuum_freeze_ intmax_ age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuum_max_ intworkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuum_naptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuum_vacuum_ intcost_ delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuum_vacuum_ intcost_ limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuum_vacuum_ floatscale_ factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuum_vacuum_ intthreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backup_hour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backup_minute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriter_delay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriter_flush_ intafter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriter_lru_ intmaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriter_lru_ floatmultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- deadlock_timeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- default_toast_ strcompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idle_in_ inttransaction_ session_ timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- log_autovacuum_ intmin_ duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- log_error_ strverbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- log_line_ strprefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- log_min_ intduration_ statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- max_files_ intper_ process 
- PostgreSQL maximum number of files that can be open per process.
- max_locks_ intper_ transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- max_logical_ intreplication_ workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- max_parallel_ intworkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- max_parallel_ intworkers_ per_ gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- max_pred_ intlocks_ per_ transaction 
- PostgreSQL maximum predicate locks per transaction.
- max_prepared_ inttransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- max_replication_ intslots 
- PostgreSQL maximum replication slots.
- max_stack_ intdepth 
- Maximum depth of the stack in bytes.
- max_standby_ intarchive_ delay 
- Max standby archive delay in milliseconds.
- max_standby_ intstreaming_ delay 
- Max standby streaming delay in milliseconds.
- max_wal_ intsenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- max_worker_ intprocesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pg_partman_ intbgw_ interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pg_partman_ strbgw_ role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pg_stat_ strstatements_ track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
Sequence[DatabasePostgresql Config Pgbouncer Args] 
- PGBouncer connection pooling settings
- float
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- temp_file_ intlimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
Sequence[DatabasePostgresql Config Timescaledb Args] 
- TimescaleDB extension configuration values
- timezone str
- PostgreSQL service timezone
- track_activity_ intquery_ size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- track_commit_ strtimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- track_functions str
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- track_io_ strtiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- wal_sender_ inttimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- wal_writer_ intdelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- work_mem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- clusterId String
- The ID of the target PostgreSQL cluster.
- autovacuumAnalyze NumberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze NumberThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze NumberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax NumberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime Number
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum NumberCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum NumberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum NumberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum NumberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour Number
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute Number
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay Number
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush NumberAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru NumberMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru NumberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- deadlockTimeout Number
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast StringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn NumberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit Boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum NumberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError StringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine StringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin NumberDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles NumberPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks NumberPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical NumberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel NumberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel NumberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred NumberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared NumberTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication NumberSlots 
- PostgreSQL maximum replication slots.
- maxStack NumberDepth 
- Maximum depth of the stack in bytes.
- maxStandby NumberArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby NumberStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal NumberSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker NumberProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman NumberBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman StringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat StringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers List<Property Map>
- PGBouncer connection pooling settings
- Number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile NumberLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs List<Property Map>
- TimescaleDB extension configuration values
- timezone String
- PostgreSQL service timezone
- trackActivity NumberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit StringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions String
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo StringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender NumberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter NumberDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem Number
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
Outputs
All input properties are implicitly available as output properties. Additionally, the DatabasePostgresqlConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DatabasePostgresqlConfig Resource
Get an existing DatabasePostgresqlConfig 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?: DatabasePostgresqlConfigState, opts?: CustomResourceOptions): DatabasePostgresqlConfig@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autovacuum_analyze_scale_factor: Optional[float] = None,
        autovacuum_analyze_threshold: Optional[int] = None,
        autovacuum_freeze_max_age: Optional[int] = None,
        autovacuum_max_workers: Optional[int] = None,
        autovacuum_naptime: Optional[int] = None,
        autovacuum_vacuum_cost_delay: Optional[int] = None,
        autovacuum_vacuum_cost_limit: Optional[int] = None,
        autovacuum_vacuum_scale_factor: Optional[float] = None,
        autovacuum_vacuum_threshold: Optional[int] = None,
        backup_hour: Optional[int] = None,
        backup_minute: Optional[int] = None,
        bgwriter_delay: Optional[int] = None,
        bgwriter_flush_after: Optional[int] = None,
        bgwriter_lru_maxpages: Optional[int] = None,
        bgwriter_lru_multiplier: Optional[float] = None,
        cluster_id: Optional[str] = None,
        deadlock_timeout: Optional[int] = None,
        default_toast_compression: Optional[str] = None,
        idle_in_transaction_session_timeout: Optional[int] = None,
        jit: Optional[bool] = None,
        log_autovacuum_min_duration: Optional[int] = None,
        log_error_verbosity: Optional[str] = None,
        log_line_prefix: Optional[str] = None,
        log_min_duration_statement: Optional[int] = None,
        max_files_per_process: Optional[int] = None,
        max_locks_per_transaction: Optional[int] = None,
        max_logical_replication_workers: Optional[int] = None,
        max_parallel_workers: Optional[int] = None,
        max_parallel_workers_per_gather: Optional[int] = None,
        max_pred_locks_per_transaction: Optional[int] = None,
        max_prepared_transactions: Optional[int] = None,
        max_replication_slots: Optional[int] = None,
        max_stack_depth: Optional[int] = None,
        max_standby_archive_delay: Optional[int] = None,
        max_standby_streaming_delay: Optional[int] = None,
        max_wal_senders: Optional[int] = None,
        max_worker_processes: Optional[int] = None,
        pg_partman_bgw_interval: Optional[int] = None,
        pg_partman_bgw_role: Optional[str] = None,
        pg_stat_statements_track: Optional[str] = None,
        pgbouncers: Optional[Sequence[DatabasePostgresqlConfigPgbouncerArgs]] = None,
        shared_buffers_percentage: Optional[float] = None,
        temp_file_limit: Optional[int] = None,
        timescaledbs: Optional[Sequence[DatabasePostgresqlConfigTimescaledbArgs]] = None,
        timezone: Optional[str] = None,
        track_activity_query_size: Optional[int] = None,
        track_commit_timestamp: Optional[str] = None,
        track_functions: Optional[str] = None,
        track_io_timing: Optional[str] = None,
        wal_sender_timeout: Optional[int] = None,
        wal_writer_delay: Optional[int] = None,
        work_mem: Optional[int] = None) -> DatabasePostgresqlConfigfunc GetDatabasePostgresqlConfig(ctx *Context, name string, id IDInput, state *DatabasePostgresqlConfigState, opts ...ResourceOption) (*DatabasePostgresqlConfig, error)public static DatabasePostgresqlConfig Get(string name, Input<string> id, DatabasePostgresqlConfigState? state, CustomResourceOptions? opts = null)public static DatabasePostgresqlConfig get(String name, Output<String> id, DatabasePostgresqlConfigState state, CustomResourceOptions options)resources:  _:    type: digitalocean:DatabasePostgresqlConfig    get:      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.
- AutovacuumAnalyze doubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- AutovacuumNaptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- AutovacuumVacuum doubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- BackupHour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- BackupMinute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- BgwriterDelay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- BgwriterFlush intAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- BgwriterLru intMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- BgwriterLru doubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- ClusterId string
- The ID of the target PostgreSQL cluster.
- DeadlockTimeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- DefaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- Jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- LogError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- LogLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots.
- MaxStack intDepth 
- Maximum depth of the stack in bytes.
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds.
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- PgPartman intBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- PgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- PgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- Pgbouncers
List<Pulumi.Digital Ocean. Inputs. Database Postgresql Config Pgbouncer> 
- PGBouncer connection pooling settings
- double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- Timescaledbs
List<Pulumi.Digital Ocean. Inputs. Database Postgresql Config Timescaledb> 
- TimescaleDB extension configuration values
- Timezone string
- PostgreSQL service timezone
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- TrackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- TrackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- TrackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- WorkMem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- AutovacuumAnalyze float64Scale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- AutovacuumNaptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- AutovacuumVacuum float64Scale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- BackupHour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- BackupMinute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- BgwriterDelay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- BgwriterFlush intAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- BgwriterLru intMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- BgwriterLru float64Multiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- ClusterId string
- The ID of the target PostgreSQL cluster.
- DeadlockTimeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- DefaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- Jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- LogError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- LogLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots.
- MaxStack intDepth 
- Maximum depth of the stack in bytes.
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds.
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- PgPartman intBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- PgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- PgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- Pgbouncers
[]DatabasePostgresql Config Pgbouncer Args 
- PGBouncer connection pooling settings
- float64
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- Timescaledbs
[]DatabasePostgresql Config Timescaledb Args 
- TimescaleDB extension configuration values
- Timezone string
- PostgreSQL service timezone
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- TrackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- TrackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- TrackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- WorkMem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- autovacuumAnalyze DoubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze IntegerThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze IntegerMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax IntegerWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime Integer
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum IntegerCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum IntegerCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum DoubleScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum IntegerThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour Integer
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute Integer
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay Integer
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush IntegerAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru IntegerMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru DoubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- clusterId String
- The ID of the target PostgreSQL cluster.
- deadlockTimeout Integer
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast StringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn IntegerTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit Boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum IntegerMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError StringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine StringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin IntegerDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles IntegerPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks IntegerPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical IntegerReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel IntegerWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel IntegerWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred IntegerLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared IntegerTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication IntegerSlots 
- PostgreSQL maximum replication slots.
- maxStack IntegerDepth 
- Maximum depth of the stack in bytes.
- maxStandby IntegerArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby IntegerStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal IntegerSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker IntegerProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman IntegerBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman StringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat StringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
List<DatabasePostgresql Config Pgbouncer> 
- PGBouncer connection pooling settings
- Double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile IntegerLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
List<DatabasePostgresql Config Timescaledb> 
- TimescaleDB extension configuration values
- timezone String
- PostgreSQL service timezone
- trackActivity IntegerQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit StringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions String
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo StringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender IntegerTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter IntegerDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem Integer
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- autovacuumAnalyze numberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze numberThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze numberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax numberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime number
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum numberCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum numberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum numberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum numberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour number
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute number
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay number
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush numberAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru numberMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru numberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- clusterId string
- The ID of the target PostgreSQL cluster.
- deadlockTimeout number
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast stringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn numberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum numberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError stringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine stringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin numberDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles numberPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks numberPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical numberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel numberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel numberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred numberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared numberTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication numberSlots 
- PostgreSQL maximum replication slots.
- maxStack numberDepth 
- Maximum depth of the stack in bytes.
- maxStandby numberArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby numberStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal numberSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker numberProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman numberBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman stringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat stringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
DatabasePostgresql Config Pgbouncer[] 
- PGBouncer connection pooling settings
- number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile numberLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
DatabasePostgresql Config Timescaledb[] 
- TimescaleDB extension configuration values
- timezone string
- PostgreSQL service timezone
- trackActivity numberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit stringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions string
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo stringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender numberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter numberDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem number
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- autovacuum_analyze_ floatscale_ factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuum_analyze_ intthreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuum_freeze_ intmax_ age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuum_max_ intworkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuum_naptime int
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuum_vacuum_ intcost_ delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuum_vacuum_ intcost_ limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuum_vacuum_ floatscale_ factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuum_vacuum_ intthreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backup_hour int
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backup_minute int
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriter_delay int
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriter_flush_ intafter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriter_lru_ intmaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriter_lru_ floatmultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- cluster_id str
- The ID of the target PostgreSQL cluster.
- deadlock_timeout int
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- default_toast_ strcompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idle_in_ inttransaction_ session_ timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit bool
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- log_autovacuum_ intmin_ duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- log_error_ strverbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- log_line_ strprefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- log_min_ intduration_ statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- max_files_ intper_ process 
- PostgreSQL maximum number of files that can be open per process.
- max_locks_ intper_ transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- max_logical_ intreplication_ workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- max_parallel_ intworkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- max_parallel_ intworkers_ per_ gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- max_pred_ intlocks_ per_ transaction 
- PostgreSQL maximum predicate locks per transaction.
- max_prepared_ inttransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- max_replication_ intslots 
- PostgreSQL maximum replication slots.
- max_stack_ intdepth 
- Maximum depth of the stack in bytes.
- max_standby_ intarchive_ delay 
- Max standby archive delay in milliseconds.
- max_standby_ intstreaming_ delay 
- Max standby streaming delay in milliseconds.
- max_wal_ intsenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- max_worker_ intprocesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pg_partman_ intbgw_ interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pg_partman_ strbgw_ role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pg_stat_ strstatements_ track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers
Sequence[DatabasePostgresql Config Pgbouncer Args] 
- PGBouncer connection pooling settings
- float
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- temp_file_ intlimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs
Sequence[DatabasePostgresql Config Timescaledb Args] 
- TimescaleDB extension configuration values
- timezone str
- PostgreSQL service timezone
- track_activity_ intquery_ size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- track_commit_ strtimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- track_functions str
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- track_io_ strtiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- wal_sender_ inttimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- wal_writer_ intdelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- work_mem int
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
- autovacuumAnalyze NumberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
- autovacuumAnalyze NumberThreshold 
- Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
- autovacuumFreeze NumberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
- autovacuumMax NumberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
- autovacuumNaptime Number
- Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.
- autovacuumVacuum NumberCost Delay 
- Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.
- autovacuumVacuum NumberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
- autovacuumVacuum NumberScale Factor 
- Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
- autovacuumVacuum NumberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
- backupHour Number
- The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.
- backupMinute Number
- The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.
- bgwriterDelay Number
- Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.
- bgwriterFlush NumberAfter 
- The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
- bgwriterLru NumberMaxpages 
- The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.
- bgwriterLru NumberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
- clusterId String
- The ID of the target PostgreSQL cluster.
- deadlockTimeout Number
- The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
- defaultToast StringCompression 
- Specifies the default TOAST compression method for values of compressible columns (the default is lz4). Supported values are: lz4,pglz.
- idleIn NumberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds
- jit Boolean
- Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum NumberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
- logError StringVerbosity 
- Controls the amount of detail written in the server log for each message that is logged. Supported values are: TERSE,DEFAULT,VERBOSE.
- logLine StringPrefix 
- Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. Supported values are: pid=%p,user=%u,db=%d,app=%a,client=%h,%m [%p] %q[user=%u,db=%d,app=%a],%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h.
- logMin NumberDuration Statement 
- Log statements that take more than this number of milliseconds to run. If -1, disables.
- maxFiles NumberPer Process 
- PostgreSQL maximum number of files that can be open per process.
- maxLocks NumberPer Transaction 
- PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.
- maxLogical NumberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
- maxParallel NumberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries.
- maxParallel NumberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
- maxPred NumberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction.
- maxPrepared NumberTransactions 
- PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.
- maxReplication NumberSlots 
- PostgreSQL maximum replication slots.
- maxStack NumberDepth 
- Maximum depth of the stack in bytes.
- maxStandby NumberArchive Delay 
- Max standby archive delay in milliseconds.
- maxStandby NumberStreaming Delay 
- Max standby streaming delay in milliseconds.
- maxWal NumberSenders 
- PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.
- maxWorker NumberProcesses 
- Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.
- pgPartman NumberBgw Interval 
- Sets the time interval to run pg_partman's scheduled tasks.
- pgPartman StringBgw Role 
- Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- pgStat StringStatements Track 
- Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. Supported values are: all,top,none.
- pgbouncers List<Property Map>
- PGBouncer connection pooling settings
- Number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
- tempFile NumberLimit 
- PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.
- timescaledbs List<Property Map>
- TimescaleDB extension configuration values
- timezone String
- PostgreSQL service timezone
- trackActivity NumberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session.
- trackCommit StringTimestamp 
- Record commit time of transactions. The default value is top. Supported values are: off,on.
- trackFunctions String
- Enables tracking of function call counts and time used. The default value is top. Supported values are: all,pl,none.
- trackIo StringTiming 
- Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. The default value is top. Supported values are: off,on.
- walSender NumberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.
- walWriter NumberDelay 
- WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance
- workMem Number
- The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).
Supporting Types
DatabasePostgresqlConfigPgbouncer, DatabasePostgresqlConfigPgbouncerArgs        
- AutodbIdle intTimeout 
- AutodbMax intDb Connections 
- AutodbPool stringMode 
- AutodbPool intSize 
- IgnoreStartup List<string>Parameters 
- MinPool intSize 
- ServerIdle intTimeout 
- ServerLifetime int
- ServerReset boolQuery Always 
- AutodbIdle intTimeout 
- AutodbMax intDb Connections 
- AutodbPool stringMode 
- AutodbPool intSize 
- IgnoreStartup []stringParameters 
- MinPool intSize 
- ServerIdle intTimeout 
- ServerLifetime int
- ServerReset boolQuery Always 
- autodbIdle IntegerTimeout 
- autodbMax IntegerDb Connections 
- autodbPool StringMode 
- autodbPool IntegerSize 
- ignoreStartup List<String>Parameters 
- minPool IntegerSize 
- serverIdle IntegerTimeout 
- serverLifetime Integer
- serverReset BooleanQuery Always 
- autodbIdle numberTimeout 
- autodbMax numberDb Connections 
- autodbPool stringMode 
- autodbPool numberSize 
- ignoreStartup string[]Parameters 
- minPool numberSize 
- serverIdle numberTimeout 
- serverLifetime number
- serverReset booleanQuery Always 
- autodb_idle_ inttimeout 
- autodb_max_ intdb_ connections 
- autodb_pool_ strmode 
- autodb_pool_ intsize 
- ignore_startup_ Sequence[str]parameters 
- min_pool_ intsize 
- server_idle_ inttimeout 
- server_lifetime int
- server_reset_ boolquery_ always 
- autodbIdle NumberTimeout 
- autodbMax NumberDb Connections 
- autodbPool StringMode 
- autodbPool NumberSize 
- ignoreStartup List<String>Parameters 
- minPool NumberSize 
- serverIdle NumberTimeout 
- serverLifetime Number
- serverReset BooleanQuery Always 
DatabasePostgresqlConfigTimescaledb, DatabasePostgresqlConfigTimescaledbArgs        
- maxBackground IntegerWorkers 
- maxBackground numberWorkers 
- maxBackground NumberWorkers 
Import
A PostgreSQL database cluster’s configuration can be imported using the id the parent cluster, e.g.
bash
$ pulumi import digitalocean:index/databasePostgresqlConfig:DatabasePostgresqlConfig example 52556c07-788e-4d41-b8a7-c796432197d1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the digitaloceanTerraform Provider.