Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. Pg
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.Pg

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

Creates and manages an Aiven for PostgreSQL® service.

Create Pg Resource

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

Constructor syntax

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

@overload
def Pg(resource_name: str,
       opts: Optional[ResourceOptions] = None,
       plan: Optional[str] = None,
       project: Optional[str] = None,
       maintenance_window_time: Optional[str] = None,
       project_vpc_id: Optional[str] = None,
       additional_disk_space: Optional[str] = None,
       pg: Optional[PgPgArgs] = None,
       pg_user_config: Optional[PgPgUserConfigArgs] = None,
       disk_space: Optional[str] = None,
       cloud_name: Optional[str] = None,
       maintenance_window_dow: Optional[str] = None,
       service_integrations: Optional[Sequence[PgServiceIntegrationArgs]] = None,
       service_name: Optional[str] = None,
       static_ips: Optional[Sequence[str]] = None,
       tags: Optional[Sequence[PgTagArgs]] = None,
       tech_emails: Optional[Sequence[PgTechEmailArgs]] = None,
       termination_protection: Optional[bool] = None)
func NewPg(ctx *Context, name string, args PgArgs, opts ...ResourceOption) (*Pg, error)
public Pg(string name, PgArgs args, CustomResourceOptions? opts = null)
public Pg(String name, PgArgs args)
public Pg(String name, PgArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PgArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PgArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PgArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PgArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PgArgs
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 pgResource = new Aiven.Pg("pgResource", new()
{
    Plan = "string",
    Project = "string",
    MaintenanceWindowTime = "string",
    ProjectVpcId = "string",
    AdditionalDiskSpace = "string",
    PgServer = new Aiven.Inputs.PgPgArgs
    {
        Dbname = "string",
        Host = "string",
        MaxConnections = 0,
        Params = new[]
        {
            new Aiven.Inputs.PgPgParamArgs
            {
                DatabaseName = "string",
                Host = "string",
                Password = "string",
                Port = 0,
                Sslmode = "string",
                User = "string",
            },
        },
        Password = "string",
        Port = 0,
        ReplicaUri = "string",
        Sslmode = "string",
        StandbyUris = new[]
        {
            "string",
        },
        SyncingUris = new[]
        {
            "string",
        },
        Uri = "string",
        Uris = new[]
        {
            "string",
        },
        User = "string",
    },
    PgUserConfig = new Aiven.Inputs.PgPgUserConfigArgs
    {
        AdditionalBackupRegions = "string",
        AdminPassword = "string",
        AdminUsername = "string",
        BackupHour = 0,
        BackupMinute = 0,
        EnableIpv6 = false,
        IpFilterObjects = new[]
        {
            new Aiven.Inputs.PgPgUserConfigIpFilterObjectArgs
            {
                Network = "string",
                Description = "string",
            },
        },
        IpFilterStrings = new[]
        {
            "string",
        },
        Migration = new Aiven.Inputs.PgPgUserConfigMigrationArgs
        {
            Host = "string",
            Port = 0,
            Dbname = "string",
            IgnoreDbs = "string",
            IgnoreRoles = "string",
            Method = "string",
            Password = "string",
            Ssl = false,
            Username = "string",
        },
        Pg = new Aiven.Inputs.PgPgUserConfigPgArgs
        {
            AutovacuumAnalyzeScaleFactor = 0,
            AutovacuumAnalyzeThreshold = 0,
            AutovacuumFreezeMaxAge = 0,
            AutovacuumMaxWorkers = 0,
            AutovacuumNaptime = 0,
            AutovacuumVacuumCostDelay = 0,
            AutovacuumVacuumCostLimit = 0,
            AutovacuumVacuumScaleFactor = 0,
            AutovacuumVacuumThreshold = 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,
            LogTempFiles = 0,
            MaxFilesPerProcess = 0,
            MaxLocksPerTransaction = 0,
            MaxLogicalReplicationWorkers = 0,
            MaxParallelWorkers = 0,
            MaxParallelWorkersPerGather = 0,
            MaxPredLocksPerTransaction = 0,
            MaxPreparedTransactions = 0,
            MaxReplicationSlots = 0,
            MaxSlotWalKeepSize = 0,
            MaxStackDepth = 0,
            MaxStandbyArchiveDelay = 0,
            MaxStandbyStreamingDelay = 0,
            MaxWalSenders = 0,
            MaxWorkerProcesses = 0,
            PasswordEncryption = "string",
            PgPartmanBgwDotInterval = 0,
            PgPartmanBgwDotRole = "string",
            PgStatMonitorDotPgsmEnableQueryPlan = false,
            PgStatMonitorDotPgsmMaxBuckets = 0,
            PgStatStatementsDotTrack = "string",
            TempFileLimit = 0,
            Timezone = "string",
            TrackActivityQuerySize = 0,
            TrackCommitTimestamp = "string",
            TrackFunctions = "string",
            TrackIoTiming = "string",
            WalSenderTimeout = 0,
            WalWriterDelay = 0,
        },
        PgReadReplica = false,
        PgServiceToForkFrom = "string",
        PgStatMonitorEnable = false,
        PgVersion = "string",
        Pgbouncer = new Aiven.Inputs.PgPgUserConfigPgbouncerArgs
        {
            AutodbIdleTimeout = 0,
            AutodbMaxDbConnections = 0,
            AutodbPoolMode = "string",
            AutodbPoolSize = 0,
            IgnoreStartupParameters = new[]
            {
                "string",
            },
            MaxPreparedStatements = 0,
            MinPoolSize = 0,
            ServerIdleTimeout = 0,
            ServerLifetime = 0,
            ServerResetQueryAlways = false,
        },
        Pglookout = new Aiven.Inputs.PgPgUserConfigPglookoutArgs
        {
            MaxFailoverReplicationTimeLag = 0,
        },
        PrivateAccess = new Aiven.Inputs.PgPgUserConfigPrivateAccessArgs
        {
            Pg = false,
            Pgbouncer = false,
            Prometheus = false,
        },
        PrivatelinkAccess = new Aiven.Inputs.PgPgUserConfigPrivatelinkAccessArgs
        {
            Pg = false,
            Pgbouncer = false,
            Prometheus = false,
        },
        ProjectToForkFrom = "string",
        PublicAccess = new Aiven.Inputs.PgPgUserConfigPublicAccessArgs
        {
            Pg = false,
            Pgbouncer = false,
            Prometheus = false,
        },
        RecoveryTargetTime = "string",
        ServiceLog = false,
        ServiceToForkFrom = "string",
        SharedBuffersPercentage = 0,
        StaticIps = false,
        SynchronousReplication = "string",
        Timescaledb = new Aiven.Inputs.PgPgUserConfigTimescaledbArgs
        {
            MaxBackgroundWorkers = 0,
        },
        Variant = "string",
        WorkMem = 0,
    },
    CloudName = "string",
    MaintenanceWindowDow = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.PgServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    ServiceName = "string",
    StaticIps = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Aiven.Inputs.PgTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TechEmails = new[]
    {
        new Aiven.Inputs.PgTechEmailArgs
        {
            Email = "string",
        },
    },
    TerminationProtection = false,
});
Copy
example, err := aiven.NewPg(ctx, "pgResource", &aiven.PgArgs{
	Plan:                  pulumi.String("string"),
	Project:               pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	AdditionalDiskSpace:   pulumi.String("string"),
	Pg: &aiven.PgPgArgs{
		Dbname:         pulumi.String("string"),
		Host:           pulumi.String("string"),
		MaxConnections: pulumi.Int(0),
		Params: aiven.PgPgParamArray{
			&aiven.PgPgParamArgs{
				DatabaseName: pulumi.String("string"),
				Host:         pulumi.String("string"),
				Password:     pulumi.String("string"),
				Port:         pulumi.Int(0),
				Sslmode:      pulumi.String("string"),
				User:         pulumi.String("string"),
			},
		},
		Password:   pulumi.String("string"),
		Port:       pulumi.Int(0),
		ReplicaUri: pulumi.String("string"),
		Sslmode:    pulumi.String("string"),
		StandbyUris: pulumi.StringArray{
			pulumi.String("string"),
		},
		SyncingUris: pulumi.StringArray{
			pulumi.String("string"),
		},
		Uri: pulumi.String("string"),
		Uris: pulumi.StringArray{
			pulumi.String("string"),
		},
		User: pulumi.String("string"),
	},
	PgUserConfig: &aiven.PgPgUserConfigArgs{
		AdditionalBackupRegions: pulumi.String("string"),
		AdminPassword:           pulumi.String("string"),
		AdminUsername:           pulumi.String("string"),
		BackupHour:              pulumi.Int(0),
		BackupMinute:            pulumi.Int(0),
		EnableIpv6:              pulumi.Bool(false),
		IpFilterObjects: aiven.PgPgUserConfigIpFilterObjectArray{
			&aiven.PgPgUserConfigIpFilterObjectArgs{
				Network:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
		IpFilterStrings: pulumi.StringArray{
			pulumi.String("string"),
		},
		Migration: &aiven.PgPgUserConfigMigrationArgs{
			Host:        pulumi.String("string"),
			Port:        pulumi.Int(0),
			Dbname:      pulumi.String("string"),
			IgnoreDbs:   pulumi.String("string"),
			IgnoreRoles: pulumi.String("string"),
			Method:      pulumi.String("string"),
			Password:    pulumi.String("string"),
			Ssl:         pulumi.Bool(false),
			Username:    pulumi.String("string"),
		},
		Pg: &aiven.PgPgUserConfigPgArgs{
			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),
			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),
			LogTempFiles:                        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),
			MaxSlotWalKeepSize:                  pulumi.Int(0),
			MaxStackDepth:                       pulumi.Int(0),
			MaxStandbyArchiveDelay:              pulumi.Int(0),
			MaxStandbyStreamingDelay:            pulumi.Int(0),
			MaxWalSenders:                       pulumi.Int(0),
			MaxWorkerProcesses:                  pulumi.Int(0),
			PasswordEncryption:                  pulumi.String("string"),
			PgPartmanBgwDotInterval:             pulumi.Int(0),
			PgPartmanBgwDotRole:                 pulumi.String("string"),
			PgStatMonitorDotPgsmEnableQueryPlan: pulumi.Bool(false),
			PgStatMonitorDotPgsmMaxBuckets:      pulumi.Int(0),
			PgStatStatementsDotTrack:            pulumi.String("string"),
			TempFileLimit:                       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),
		},
		PgReadReplica:       pulumi.Bool(false),
		PgServiceToForkFrom: pulumi.String("string"),
		PgStatMonitorEnable: pulumi.Bool(false),
		PgVersion:           pulumi.String("string"),
		Pgbouncer: &aiven.PgPgUserConfigPgbouncerArgs{
			AutodbIdleTimeout:      pulumi.Int(0),
			AutodbMaxDbConnections: pulumi.Int(0),
			AutodbPoolMode:         pulumi.String("string"),
			AutodbPoolSize:         pulumi.Int(0),
			IgnoreStartupParameters: pulumi.StringArray{
				pulumi.String("string"),
			},
			MaxPreparedStatements:  pulumi.Int(0),
			MinPoolSize:            pulumi.Int(0),
			ServerIdleTimeout:      pulumi.Int(0),
			ServerLifetime:         pulumi.Int(0),
			ServerResetQueryAlways: pulumi.Bool(false),
		},
		Pglookout: &aiven.PgPgUserConfigPglookoutArgs{
			MaxFailoverReplicationTimeLag: pulumi.Int(0),
		},
		PrivateAccess: &aiven.PgPgUserConfigPrivateAccessArgs{
			Pg:         pulumi.Bool(false),
			Pgbouncer:  pulumi.Bool(false),
			Prometheus: pulumi.Bool(false),
		},
		PrivatelinkAccess: &aiven.PgPgUserConfigPrivatelinkAccessArgs{
			Pg:         pulumi.Bool(false),
			Pgbouncer:  pulumi.Bool(false),
			Prometheus: pulumi.Bool(false),
		},
		ProjectToForkFrom: pulumi.String("string"),
		PublicAccess: &aiven.PgPgUserConfigPublicAccessArgs{
			Pg:         pulumi.Bool(false),
			Pgbouncer:  pulumi.Bool(false),
			Prometheus: pulumi.Bool(false),
		},
		RecoveryTargetTime:      pulumi.String("string"),
		ServiceLog:              pulumi.Bool(false),
		ServiceToForkFrom:       pulumi.String("string"),
		SharedBuffersPercentage: pulumi.Float64(0),
		StaticIps:               pulumi.Bool(false),
		SynchronousReplication:  pulumi.String("string"),
		Timescaledb: &aiven.PgPgUserConfigTimescaledbArgs{
			MaxBackgroundWorkers: pulumi.Int(0),
		},
		Variant: pulumi.String("string"),
		WorkMem: pulumi.Int(0),
	},
	CloudName:            pulumi.String("string"),
	MaintenanceWindowDow: pulumi.String("string"),
	ServiceIntegrations: aiven.PgServiceIntegrationArray{
		&aiven.PgServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	ServiceName: pulumi.String("string"),
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: aiven.PgTagArray{
		&aiven.PgTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TechEmails: aiven.PgTechEmailArray{
		&aiven.PgTechEmailArgs{
			Email: pulumi.String("string"),
		},
	},
	TerminationProtection: pulumi.Bool(false),
})
Copy
var pgResource = new Pg("pgResource", PgArgs.builder()
    .plan("string")
    .project("string")
    .maintenanceWindowTime("string")
    .projectVpcId("string")
    .additionalDiskSpace("string")
    .pg(PgPgArgs.builder()
        .dbname("string")
        .host("string")
        .maxConnections(0)
        .params(PgPgParamArgs.builder()
            .databaseName("string")
            .host("string")
            .password("string")
            .port(0)
            .sslmode("string")
            .user("string")
            .build())
        .password("string")
        .port(0)
        .replicaUri("string")
        .sslmode("string")
        .standbyUris("string")
        .syncingUris("string")
        .uri("string")
        .uris("string")
        .user("string")
        .build())
    .pgUserConfig(PgPgUserConfigArgs.builder()
        .additionalBackupRegions("string")
        .adminPassword("string")
        .adminUsername("string")
        .backupHour(0)
        .backupMinute(0)
        .enableIpv6(false)
        .ipFilterObjects(PgPgUserConfigIpFilterObjectArgs.builder()
            .network("string")
            .description("string")
            .build())
        .ipFilterStrings("string")
        .migration(PgPgUserConfigMigrationArgs.builder()
            .host("string")
            .port(0)
            .dbname("string")
            .ignoreDbs("string")
            .ignoreRoles("string")
            .method("string")
            .password("string")
            .ssl(false)
            .username("string")
            .build())
        .pg(PgPgUserConfigPgArgs.builder()
            .autovacuumAnalyzeScaleFactor(0)
            .autovacuumAnalyzeThreshold(0)
            .autovacuumFreezeMaxAge(0)
            .autovacuumMaxWorkers(0)
            .autovacuumNaptime(0)
            .autovacuumVacuumCostDelay(0)
            .autovacuumVacuumCostLimit(0)
            .autovacuumVacuumScaleFactor(0)
            .autovacuumVacuumThreshold(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)
            .logTempFiles(0)
            .maxFilesPerProcess(0)
            .maxLocksPerTransaction(0)
            .maxLogicalReplicationWorkers(0)
            .maxParallelWorkers(0)
            .maxParallelWorkersPerGather(0)
            .maxPredLocksPerTransaction(0)
            .maxPreparedTransactions(0)
            .maxReplicationSlots(0)
            .maxSlotWalKeepSize(0)
            .maxStackDepth(0)
            .maxStandbyArchiveDelay(0)
            .maxStandbyStreamingDelay(0)
            .maxWalSenders(0)
            .maxWorkerProcesses(0)
            .passwordEncryption("string")
            .pgPartmanBgwDotInterval(0)
            .pgPartmanBgwDotRole("string")
            .pgStatMonitorDotPgsmEnableQueryPlan(false)
            .pgStatMonitorDotPgsmMaxBuckets(0)
            .pgStatStatementsDotTrack("string")
            .tempFileLimit(0)
            .timezone("string")
            .trackActivityQuerySize(0)
            .trackCommitTimestamp("string")
            .trackFunctions("string")
            .trackIoTiming("string")
            .walSenderTimeout(0)
            .walWriterDelay(0)
            .build())
        .pgReadReplica(false)
        .pgServiceToForkFrom("string")
        .pgStatMonitorEnable(false)
        .pgVersion("string")
        .pgbouncer(PgPgUserConfigPgbouncerArgs.builder()
            .autodbIdleTimeout(0)
            .autodbMaxDbConnections(0)
            .autodbPoolMode("string")
            .autodbPoolSize(0)
            .ignoreStartupParameters("string")
            .maxPreparedStatements(0)
            .minPoolSize(0)
            .serverIdleTimeout(0)
            .serverLifetime(0)
            .serverResetQueryAlways(false)
            .build())
        .pglookout(PgPgUserConfigPglookoutArgs.builder()
            .maxFailoverReplicationTimeLag(0)
            .build())
        .privateAccess(PgPgUserConfigPrivateAccessArgs.builder()
            .pg(false)
            .pgbouncer(false)
            .prometheus(false)
            .build())
        .privatelinkAccess(PgPgUserConfigPrivatelinkAccessArgs.builder()
            .pg(false)
            .pgbouncer(false)
            .prometheus(false)
            .build())
        .projectToForkFrom("string")
        .publicAccess(PgPgUserConfigPublicAccessArgs.builder()
            .pg(false)
            .pgbouncer(false)
            .prometheus(false)
            .build())
        .recoveryTargetTime("string")
        .serviceLog(false)
        .serviceToForkFrom("string")
        .sharedBuffersPercentage(0)
        .staticIps(false)
        .synchronousReplication("string")
        .timescaledb(PgPgUserConfigTimescaledbArgs.builder()
            .maxBackgroundWorkers(0)
            .build())
        .variant("string")
        .workMem(0)
        .build())
    .cloudName("string")
    .maintenanceWindowDow("string")
    .serviceIntegrations(PgServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .serviceName("string")
    .staticIps("string")
    .tags(PgTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .techEmails(PgTechEmailArgs.builder()
        .email("string")
        .build())
    .terminationProtection(false)
    .build());
Copy
pg_resource = aiven.Pg("pgResource",
    plan="string",
    project="string",
    maintenance_window_time="string",
    project_vpc_id="string",
    additional_disk_space="string",
    pg={
        "dbname": "string",
        "host": "string",
        "max_connections": 0,
        "params": [{
            "database_name": "string",
            "host": "string",
            "password": "string",
            "port": 0,
            "sslmode": "string",
            "user": "string",
        }],
        "password": "string",
        "port": 0,
        "replica_uri": "string",
        "sslmode": "string",
        "standby_uris": ["string"],
        "syncing_uris": ["string"],
        "uri": "string",
        "uris": ["string"],
        "user": "string",
    },
    pg_user_config={
        "additional_backup_regions": "string",
        "admin_password": "string",
        "admin_username": "string",
        "backup_hour": 0,
        "backup_minute": 0,
        "enable_ipv6": False,
        "ip_filter_objects": [{
            "network": "string",
            "description": "string",
        }],
        "ip_filter_strings": ["string"],
        "migration": {
            "host": "string",
            "port": 0,
            "dbname": "string",
            "ignore_dbs": "string",
            "ignore_roles": "string",
            "method": "string",
            "password": "string",
            "ssl": False,
            "username": "string",
        },
        "pg": {
            "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,
            "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,
            "log_temp_files": 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_slot_wal_keep_size": 0,
            "max_stack_depth": 0,
            "max_standby_archive_delay": 0,
            "max_standby_streaming_delay": 0,
            "max_wal_senders": 0,
            "max_worker_processes": 0,
            "password_encryption": "string",
            "pg_partman_bgw_dot_interval": 0,
            "pg_partman_bgw_dot_role": "string",
            "pg_stat_monitor_dot_pgsm_enable_query_plan": False,
            "pg_stat_monitor_dot_pgsm_max_buckets": 0,
            "pg_stat_statements_dot_track": "string",
            "temp_file_limit": 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,
        },
        "pg_read_replica": False,
        "pg_service_to_fork_from": "string",
        "pg_stat_monitor_enable": False,
        "pg_version": "string",
        "pgbouncer": {
            "autodb_idle_timeout": 0,
            "autodb_max_db_connections": 0,
            "autodb_pool_mode": "string",
            "autodb_pool_size": 0,
            "ignore_startup_parameters": ["string"],
            "max_prepared_statements": 0,
            "min_pool_size": 0,
            "server_idle_timeout": 0,
            "server_lifetime": 0,
            "server_reset_query_always": False,
        },
        "pglookout": {
            "max_failover_replication_time_lag": 0,
        },
        "private_access": {
            "pg": False,
            "pgbouncer": False,
            "prometheus": False,
        },
        "privatelink_access": {
            "pg": False,
            "pgbouncer": False,
            "prometheus": False,
        },
        "project_to_fork_from": "string",
        "public_access": {
            "pg": False,
            "pgbouncer": False,
            "prometheus": False,
        },
        "recovery_target_time": "string",
        "service_log": False,
        "service_to_fork_from": "string",
        "shared_buffers_percentage": 0,
        "static_ips": False,
        "synchronous_replication": "string",
        "timescaledb": {
            "max_background_workers": 0,
        },
        "variant": "string",
        "work_mem": 0,
    },
    cloud_name="string",
    maintenance_window_dow="string",
    service_integrations=[{
        "integration_type": "string",
        "source_service_name": "string",
    }],
    service_name="string",
    static_ips=["string"],
    tags=[{
        "key": "string",
        "value": "string",
    }],
    tech_emails=[{
        "email": "string",
    }],
    termination_protection=False)
Copy
const pgResource = new aiven.Pg("pgResource", {
    plan: "string",
    project: "string",
    maintenanceWindowTime: "string",
    projectVpcId: "string",
    additionalDiskSpace: "string",
    pg: {
        dbname: "string",
        host: "string",
        maxConnections: 0,
        params: [{
            databaseName: "string",
            host: "string",
            password: "string",
            port: 0,
            sslmode: "string",
            user: "string",
        }],
        password: "string",
        port: 0,
        replicaUri: "string",
        sslmode: "string",
        standbyUris: ["string"],
        syncingUris: ["string"],
        uri: "string",
        uris: ["string"],
        user: "string",
    },
    pgUserConfig: {
        additionalBackupRegions: "string",
        adminPassword: "string",
        adminUsername: "string",
        backupHour: 0,
        backupMinute: 0,
        enableIpv6: false,
        ipFilterObjects: [{
            network: "string",
            description: "string",
        }],
        ipFilterStrings: ["string"],
        migration: {
            host: "string",
            port: 0,
            dbname: "string",
            ignoreDbs: "string",
            ignoreRoles: "string",
            method: "string",
            password: "string",
            ssl: false,
            username: "string",
        },
        pg: {
            autovacuumAnalyzeScaleFactor: 0,
            autovacuumAnalyzeThreshold: 0,
            autovacuumFreezeMaxAge: 0,
            autovacuumMaxWorkers: 0,
            autovacuumNaptime: 0,
            autovacuumVacuumCostDelay: 0,
            autovacuumVacuumCostLimit: 0,
            autovacuumVacuumScaleFactor: 0,
            autovacuumVacuumThreshold: 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,
            logTempFiles: 0,
            maxFilesPerProcess: 0,
            maxLocksPerTransaction: 0,
            maxLogicalReplicationWorkers: 0,
            maxParallelWorkers: 0,
            maxParallelWorkersPerGather: 0,
            maxPredLocksPerTransaction: 0,
            maxPreparedTransactions: 0,
            maxReplicationSlots: 0,
            maxSlotWalKeepSize: 0,
            maxStackDepth: 0,
            maxStandbyArchiveDelay: 0,
            maxStandbyStreamingDelay: 0,
            maxWalSenders: 0,
            maxWorkerProcesses: 0,
            passwordEncryption: "string",
            pgPartmanBgwDotInterval: 0,
            pgPartmanBgwDotRole: "string",
            pgStatMonitorDotPgsmEnableQueryPlan: false,
            pgStatMonitorDotPgsmMaxBuckets: 0,
            pgStatStatementsDotTrack: "string",
            tempFileLimit: 0,
            timezone: "string",
            trackActivityQuerySize: 0,
            trackCommitTimestamp: "string",
            trackFunctions: "string",
            trackIoTiming: "string",
            walSenderTimeout: 0,
            walWriterDelay: 0,
        },
        pgReadReplica: false,
        pgServiceToForkFrom: "string",
        pgStatMonitorEnable: false,
        pgVersion: "string",
        pgbouncer: {
            autodbIdleTimeout: 0,
            autodbMaxDbConnections: 0,
            autodbPoolMode: "string",
            autodbPoolSize: 0,
            ignoreStartupParameters: ["string"],
            maxPreparedStatements: 0,
            minPoolSize: 0,
            serverIdleTimeout: 0,
            serverLifetime: 0,
            serverResetQueryAlways: false,
        },
        pglookout: {
            maxFailoverReplicationTimeLag: 0,
        },
        privateAccess: {
            pg: false,
            pgbouncer: false,
            prometheus: false,
        },
        privatelinkAccess: {
            pg: false,
            pgbouncer: false,
            prometheus: false,
        },
        projectToForkFrom: "string",
        publicAccess: {
            pg: false,
            pgbouncer: false,
            prometheus: false,
        },
        recoveryTargetTime: "string",
        serviceLog: false,
        serviceToForkFrom: "string",
        sharedBuffersPercentage: 0,
        staticIps: false,
        synchronousReplication: "string",
        timescaledb: {
            maxBackgroundWorkers: 0,
        },
        variant: "string",
        workMem: 0,
    },
    cloudName: "string",
    maintenanceWindowDow: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    serviceName: "string",
    staticIps: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    techEmails: [{
        email: "string",
    }],
    terminationProtection: false,
});
Copy
type: aiven:Pg
properties:
    additionalDiskSpace: string
    cloudName: string
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    pg:
        dbname: string
        host: string
        maxConnections: 0
        params:
            - databaseName: string
              host: string
              password: string
              port: 0
              sslmode: string
              user: string
        password: string
        port: 0
        replicaUri: string
        sslmode: string
        standbyUris:
            - string
        syncingUris:
            - string
        uri: string
        uris:
            - string
        user: string
    pgUserConfig:
        additionalBackupRegions: string
        adminPassword: string
        adminUsername: string
        backupHour: 0
        backupMinute: 0
        enableIpv6: false
        ipFilterObjects:
            - description: string
              network: string
        ipFilterStrings:
            - string
        migration:
            dbname: string
            host: string
            ignoreDbs: string
            ignoreRoles: string
            method: string
            password: string
            port: 0
            ssl: false
            username: string
        pg:
            autovacuumAnalyzeScaleFactor: 0
            autovacuumAnalyzeThreshold: 0
            autovacuumFreezeMaxAge: 0
            autovacuumMaxWorkers: 0
            autovacuumNaptime: 0
            autovacuumVacuumCostDelay: 0
            autovacuumVacuumCostLimit: 0
            autovacuumVacuumScaleFactor: 0
            autovacuumVacuumThreshold: 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
            logTempFiles: 0
            maxFilesPerProcess: 0
            maxLocksPerTransaction: 0
            maxLogicalReplicationWorkers: 0
            maxParallelWorkers: 0
            maxParallelWorkersPerGather: 0
            maxPredLocksPerTransaction: 0
            maxPreparedTransactions: 0
            maxReplicationSlots: 0
            maxSlotWalKeepSize: 0
            maxStackDepth: 0
            maxStandbyArchiveDelay: 0
            maxStandbyStreamingDelay: 0
            maxWalSenders: 0
            maxWorkerProcesses: 0
            passwordEncryption: string
            pgPartmanBgwDotInterval: 0
            pgPartmanBgwDotRole: string
            pgStatMonitorDotPgsmEnableQueryPlan: false
            pgStatMonitorDotPgsmMaxBuckets: 0
            pgStatStatementsDotTrack: string
            tempFileLimit: 0
            timezone: string
            trackActivityQuerySize: 0
            trackCommitTimestamp: string
            trackFunctions: string
            trackIoTiming: string
            walSenderTimeout: 0
            walWriterDelay: 0
        pgReadReplica: false
        pgServiceToForkFrom: string
        pgStatMonitorEnable: false
        pgVersion: string
        pgbouncer:
            autodbIdleTimeout: 0
            autodbMaxDbConnections: 0
            autodbPoolMode: string
            autodbPoolSize: 0
            ignoreStartupParameters:
                - string
            maxPreparedStatements: 0
            minPoolSize: 0
            serverIdleTimeout: 0
            serverLifetime: 0
            serverResetQueryAlways: false
        pglookout:
            maxFailoverReplicationTimeLag: 0
        privateAccess:
            pg: false
            pgbouncer: false
            prometheus: false
        privatelinkAccess:
            pg: false
            pgbouncer: false
            prometheus: false
        projectToForkFrom: string
        publicAccess:
            pg: false
            pgbouncer: false
            prometheus: false
        recoveryTargetTime: string
        serviceLog: false
        serviceToForkFrom: string
        sharedBuffersPercentage: 0
        staticIps: false
        synchronousReplication: string
        timescaledb:
            maxBackgroundWorkers: 0
        variant: string
        workMem: 0
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    tags:
        - key: string
          value: string
    techEmails:
        - email: string
    terminationProtection: false
Copy

Pg 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 Pg resource accepts the following input properties:

Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
PgServer PgPg
Values provided by the PostgreSQL server.
PgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations List<PgServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<PgTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<PgTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Pg PgPgArgs
Values provided by the PostgreSQL server.
PgUserConfig PgPgUserConfigArgs
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations []PgServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []PgTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []PgTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPg
Values provided by the PostgreSQL server.
pgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<PgServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<PgTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<PgTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPg
Values provided by the PostgreSQL server.
pgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations PgServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags PgTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails PgTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPgArgs
Values provided by the PostgreSQL server.
pg_user_config PgPgUserConfigArgs
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_integrations Sequence[PgServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name Changes to this property will trigger replacement. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[PgTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[PgTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg Property Map
Values provided by the PostgreSQL server.
pgUserConfig Property Map
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Outputs

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

Components List<PgComponent>
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
Components []PgComponent
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
components List<PgComponent>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
components PgComponent[]
Service component information objects
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id string
The provider-assigned unique ID for this managed resource.
serviceHost string
The hostname of the service.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
components Sequence[PgComponent]
Service component information objects
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id str
The provider-assigned unique ID for this managed resource.
service_host str
The hostname of the service.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
components List<Property Map>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String

Look up Existing Pg Resource

Get an existing Pg 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?: PgState, opts?: CustomResourceOptions): Pg
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_disk_space: Optional[str] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[PgComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        pg: Optional[PgPgArgs] = None,
        pg_user_config: Optional[PgPgUserConfigArgs] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[PgServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PgTagArgs]] = None,
        tech_emails: Optional[Sequence[PgTechEmailArgs]] = None,
        termination_protection: Optional[bool] = None) -> Pg
func GetPg(ctx *Context, name string, id IDInput, state *PgState, opts ...ResourceOption) (*Pg, error)
public static Pg Get(string name, Input<string> id, PgState? state, CustomResourceOptions? opts = null)
public static Pg get(String name, Output<String> id, PgState state, CustomResourceOptions options)
resources:  _:    type: aiven:Pg    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<PgComponent>
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
PgServer PgPg
Values provided by the PostgreSQL server.
PgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<PgServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<PgTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<PgTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []PgComponentArgs
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Pg PgPgArgs
Values provided by the PostgreSQL server.
PgUserConfig PgPgUserConfigArgs
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations []PgServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []PgTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []PgTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<PgComponent>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPg
Values provided by the PostgreSQL server.
pgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<PgServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<PgTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<PgTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components PgComponent[]
Service component information objects
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPg
Values provided by the PostgreSQL server.
pgUserConfig PgPgUserConfig
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string
The hostname of the service.
serviceIntegrations PgServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags PgTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails PgTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[PgComponentArgs]
Service component information objects
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg PgPgArgs
Values provided by the PostgreSQL server.
pg_user_config PgPgUserConfigArgs
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str
The hostname of the service.
service_integrations Sequence[PgServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name Changes to this property will trigger replacement. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[PgTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[PgTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg Property Map
Values provided by the PostgreSQL server.
pgUserConfig Property Map
Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

PgComponent
, PgComponentArgs

Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Integer
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name
component string
Service component name
connectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
host string
Host name for connecting to the service component
kafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
port number
Port number for connecting to the service component
route string
Network access route
ssl boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage string
DNS usage name
component str
Service component name
connection_uri str
Connection info for connecting to the service component. This is a combination of host and port.
host str
Host name for connecting to the service component
kafka_authentication_method str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str
Kafka certificate used. The possible values are letsencrypt and project_ca.
port int
Port number for connecting to the service component
route str
Network access route
ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage str
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Number
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name

PgPg
, PgPgArgs

Bouncer string
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

Dbname string
Primary PostgreSQL database name.
Host string
PostgreSQL primary node host IP or name.
MaxConnections int
The number of allowed connections. Varies based on the service plan.
Params List<PgPgParam>
PostgreSQL connection parameters.
Password string
PostgreSQL admin user password.
Port int
PostgreSQL port.
ReplicaUri string
PostgreSQL replica URI for services with a replica.
Sslmode string
PostgreSQL SSL mode setting.
StandbyUris List<string>
PostgreSQL standby connection URIs.
SyncingUris List<string>
PostgreSQL syncing connection URIs.
Uri string
PostgreSQL primary connection URI.
Uris List<string>
PostgreSQL primary connection URIs.
User string
PostgreSQL admin user name.
Bouncer string
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

Dbname string
Primary PostgreSQL database name.
Host string
PostgreSQL primary node host IP or name.
MaxConnections int
The number of allowed connections. Varies based on the service plan.
Params []PgPgParam
PostgreSQL connection parameters.
Password string
PostgreSQL admin user password.
Port int
PostgreSQL port.
ReplicaUri string
PostgreSQL replica URI for services with a replica.
Sslmode string
PostgreSQL SSL mode setting.
StandbyUris []string
PostgreSQL standby connection URIs.
SyncingUris []string
PostgreSQL syncing connection URIs.
Uri string
PostgreSQL primary connection URI.
Uris []string
PostgreSQL primary connection URIs.
User string
PostgreSQL admin user name.
bouncer String
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

dbname String
Primary PostgreSQL database name.
host String
PostgreSQL primary node host IP or name.
maxConnections Integer
The number of allowed connections. Varies based on the service plan.
params List<PgPgParam>
PostgreSQL connection parameters.
password String
PostgreSQL admin user password.
port Integer
PostgreSQL port.
replicaUri String
PostgreSQL replica URI for services with a replica.
sslmode String
PostgreSQL SSL mode setting.
standbyUris List<String>
PostgreSQL standby connection URIs.
syncingUris List<String>
PostgreSQL syncing connection URIs.
uri String
PostgreSQL primary connection URI.
uris List<String>
PostgreSQL primary connection URIs.
user String
PostgreSQL admin user name.
bouncer string
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

dbname string
Primary PostgreSQL database name.
host string
PostgreSQL primary node host IP or name.
maxConnections number
The number of allowed connections. Varies based on the service plan.
params PgPgParam[]
PostgreSQL connection parameters.
password string
PostgreSQL admin user password.
port number
PostgreSQL port.
replicaUri string
PostgreSQL replica URI for services with a replica.
sslmode string
PostgreSQL SSL mode setting.
standbyUris string[]
PostgreSQL standby connection URIs.
syncingUris string[]
PostgreSQL syncing connection URIs.
uri string
PostgreSQL primary connection URI.
uris string[]
PostgreSQL primary connection URIs.
user string
PostgreSQL admin user name.
bouncer str
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

dbname str
Primary PostgreSQL database name.
host str
PostgreSQL primary node host IP or name.
max_connections int
The number of allowed connections. Varies based on the service plan.
params Sequence[PgPgParam]
PostgreSQL connection parameters.
password str
PostgreSQL admin user password.
port int
PostgreSQL port.
replica_uri str
PostgreSQL replica URI for services with a replica.
sslmode str
PostgreSQL SSL mode setting.
standby_uris Sequence[str]
PostgreSQL standby connection URIs.
syncing_uris Sequence[str]
PostgreSQL syncing connection URIs.
uri str
PostgreSQL primary connection URI.
uris Sequence[str]
PostgreSQL primary connection URIs.
user str
PostgreSQL admin user name.
bouncer String
PgBouncer connection details for connection pooling.

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

dbname String
Primary PostgreSQL database name.
host String
PostgreSQL primary node host IP or name.
maxConnections Number
The number of allowed connections. Varies based on the service plan.
params List<Property Map>
PostgreSQL connection parameters.
password String
PostgreSQL admin user password.
port Number
PostgreSQL port.
replicaUri String
PostgreSQL replica URI for services with a replica.
sslmode String
PostgreSQL SSL mode setting.
standbyUris List<String>
PostgreSQL standby connection URIs.
syncingUris List<String>
PostgreSQL syncing connection URIs.
uri String
PostgreSQL primary connection URI.
uris List<String>
PostgreSQL primary connection URIs.
user String
PostgreSQL admin user name.

PgPgParam
, PgPgParamArgs

DatabaseName string
Primary PostgreSQL database name.
Host string
PostgreSQL host IP or name.
Password string
PostgreSQL admin user password.
Port int
PostgreSQL port.
Sslmode string
PostgreSQL SSL mode setting.
User string
PostgreSQL admin user name.
DatabaseName string
Primary PostgreSQL database name.
Host string
PostgreSQL host IP or name.
Password string
PostgreSQL admin user password.
Port int
PostgreSQL port.
Sslmode string
PostgreSQL SSL mode setting.
User string
PostgreSQL admin user name.
databaseName String
Primary PostgreSQL database name.
host String
PostgreSQL host IP or name.
password String
PostgreSQL admin user password.
port Integer
PostgreSQL port.
sslmode String
PostgreSQL SSL mode setting.
user String
PostgreSQL admin user name.
databaseName string
Primary PostgreSQL database name.
host string
PostgreSQL host IP or name.
password string
PostgreSQL admin user password.
port number
PostgreSQL port.
sslmode string
PostgreSQL SSL mode setting.
user string
PostgreSQL admin user name.
database_name str
Primary PostgreSQL database name.
host str
PostgreSQL host IP or name.
password str
PostgreSQL admin user password.
port int
PostgreSQL port.
sslmode str
PostgreSQL SSL mode setting.
user str
PostgreSQL admin user name.
databaseName String
Primary PostgreSQL database name.
host String
PostgreSQL host IP or name.
password String
PostgreSQL admin user password.
port Number
PostgreSQL port.
sslmode String
PostgreSQL SSL mode setting.
user String
PostgreSQL admin user name.

PgPgUserConfig
, PgPgUserConfigArgs

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
AdminPassword Changes to this property will trigger replacement. string
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
AdminUsername Changes to this property will trigger replacement. string
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
BackupHour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
EnableIpv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
IpFilterObjects List<PgPgUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

Migration PgPgUserConfigMigration
Migrate data from existing server
Pg PgPgUserConfigPg
postgresql.conf configuration values
PgQualstats PgPgUserConfigPgQualstats
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

PgReadReplica bool
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
PgServiceToForkFrom Changes to this property will trigger replacement. string
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
PgStatMonitorEnable bool
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
PgVersion string
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
Pgaudit PgPgUserConfigPgaudit
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

Pgbouncer PgPgUserConfigPgbouncer
PGBouncer connection pooling settings
Pglookout PgPgUserConfigPglookout
System-wide settings for pglookout
PrivateAccess PgPgUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess PgPgUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess PgPgUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryTargetTime Changes to this property will trigger replacement. string
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
SharedBuffersPercentage 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. Example: 41.5.
StaticIps bool
Use static public IP addresses.
SynchronousReplication string
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
Timescaledb PgPgUserConfigTimescaledb
System-wide settings for the timescaledb extension
Variant string
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
WorkMem int
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.
AdminPassword Changes to this property will trigger replacement. string
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
AdminUsername Changes to this property will trigger replacement. string
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
BackupHour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
EnableIpv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
IpFilterObjects []PgPgUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

Migration PgPgUserConfigMigration
Migrate data from existing server
Pg PgPgUserConfigPg
postgresql.conf configuration values
PgQualstats PgPgUserConfigPgQualstats
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

PgReadReplica bool
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
PgServiceToForkFrom Changes to this property will trigger replacement. string
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
PgStatMonitorEnable bool
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
PgVersion string
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
Pgaudit PgPgUserConfigPgaudit
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

Pgbouncer PgPgUserConfigPgbouncer
PGBouncer connection pooling settings
Pglookout PgPgUserConfigPglookout
System-wide settings for pglookout
PrivateAccess PgPgUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess PgPgUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
ProjectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess PgPgUserConfigPublicAccess
Allow access to selected service ports from the public Internet
RecoveryTargetTime Changes to this property will trigger replacement. string
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
SharedBuffersPercentage 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. Example: 41.5.
StaticIps bool
Use static public IP addresses.
SynchronousReplication string
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
Timescaledb PgPgUserConfigTimescaledb
System-wide settings for the timescaledb extension
Variant string
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
WorkMem int
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
adminPassword Changes to this property will trigger replacement. String
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername Changes to this property will trigger replacement. String
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
backupHour Integer
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Integer
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 Boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
ipFilterObjects List<PgPgUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration PgPgUserConfigMigration
Migrate data from existing server
pg PgPgUserConfigPg
postgresql.conf configuration values
pgQualstats PgPgUserConfigPgQualstats
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

pgReadReplica Boolean
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
pgServiceToForkFrom Changes to this property will trigger replacement. String
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable Boolean
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
pgVersion String
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
pgaudit PgPgUserConfigPgaudit
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

pgbouncer PgPgUserConfigPgbouncer
PGBouncer connection pooling settings
pglookout PgPgUserConfigPglookout
System-wide settings for pglookout
privateAccess PgPgUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess PgPgUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess PgPgUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryTargetTime Changes to this property will trigger replacement. String
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
sharedBuffersPercentage 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. Example: 41.5.
staticIps Boolean
Use static public IP addresses.
synchronousReplication String
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb PgPgUserConfigTimescaledb
System-wide settings for the timescaledb extension
variant String
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
workMem Integer
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.
adminPassword Changes to this property will trigger replacement. string
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername Changes to this property will trigger replacement. string
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
backupHour number
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute number
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
ipFilterObjects PgPgUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration PgPgUserConfigMigration
Migrate data from existing server
pg PgPgUserConfigPg
postgresql.conf configuration values
pgQualstats PgPgUserConfigPgQualstats
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

pgReadReplica boolean
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
pgServiceToForkFrom Changes to this property will trigger replacement. string
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable boolean
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
pgVersion string
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
pgaudit PgPgUserConfigPgaudit
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

pgbouncer PgPgUserConfigPgbouncer
PGBouncer connection pooling settings
pglookout PgPgUserConfigPglookout
System-wide settings for pglookout
privateAccess PgPgUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess PgPgUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. string
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess PgPgUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recoveryTargetTime Changes to this property will trigger replacement. string
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. string
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
sharedBuffersPercentage 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. Example: 41.5.
staticIps boolean
Use static public IP addresses.
synchronousReplication string
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb PgPgUserConfigTimescaledb
System-wide settings for the timescaledb extension
variant string
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
workMem number
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
additional_backup_regions str
Additional Cloud Regions for Backup Replication.
admin_password Changes to this property will trigger replacement. str
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
admin_username Changes to this property will trigger replacement. str
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
backup_hour int
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backup_minute int
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enable_ipv6 bool
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
ip_filter_objects Sequence[PgPgUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration PgPgUserConfigMigration
Migrate data from existing server
pg PgPgUserConfigPg
postgresql.conf configuration values
pg_qualstats PgPgUserConfigPgQualstats
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

pg_read_replica bool
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
pg_service_to_fork_from Changes to this property will trigger replacement. str
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
pg_stat_monitor_enable bool
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
pg_version str
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
pgaudit PgPgUserConfigPgaudit
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

pgbouncer PgPgUserConfigPgbouncer
PGBouncer connection pooling settings
pglookout PgPgUserConfigPglookout
System-wide settings for pglookout
private_access PgPgUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelink_access PgPgUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
project_to_fork_from Changes to this property will trigger replacement. str
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
public_access PgPgUserConfigPublicAccess
Allow access to selected service ports from the public Internet
recovery_target_time Changes to this property will trigger replacement. str
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
service_to_fork_from Changes to this property will trigger replacement. str
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
shared_buffers_percentage 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. Example: 41.5.
static_ips bool
Use static public IP addresses.
synchronous_replication str
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb PgPgUserConfigTimescaledb
System-wide settings for the timescaledb extension
variant str
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
work_mem int
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.
adminPassword Changes to this property will trigger replacement. String
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername Changes to this property will trigger replacement. String
Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
backupHour Number
The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Number
The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
enableIpv6 Boolean
Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

migration Property Map
Migrate data from existing server
pg Property Map
postgresql.conf configuration values
pgQualstats Property Map
System-wide settings for the pg*qualstats extension

Deprecated: This property is deprecated.

pgReadReplica Boolean
Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
pgServiceToForkFrom Changes to this property will trigger replacement. String
Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable Boolean
Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. Default: false.
pgVersion String
Enum: 10, 11, 12, 13, 14, 15, 16, 17, and newer. PostgreSQL major version.
pgaudit Property Map
System-wide settings for the pgaudit extension

Deprecated: This property is deprecated.

pgbouncer Property Map
PGBouncer connection pooling settings
pglookout Property Map
System-wide settings for pglookout
privateAccess Property Map
Allow access to selected service ports from private networks
privatelinkAccess Property Map
Allow access to selected service components through Privatelink
projectToForkFrom Changes to this property will trigger replacement. String
Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess Property Map
Allow access to selected service ports from the public Internet
recoveryTargetTime Changes to this property will trigger replacement. String
Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom Changes to this property will trigger replacement. String
Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
sharedBuffersPercentage 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. Example: 41.5.
staticIps Boolean
Use static public IP addresses.
synchronousReplication String
Enum: off, quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb Property Map
System-wide settings for the timescaledb extension
variant String
Enum: aiven, timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
workMem Number
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

PgPgUserConfigIpFilterObject
, PgPgUserConfigIpFilterObjectArgs

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

PgPgUserConfigMigration
, PgPgUserConfigMigrationArgs

Host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
Dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
IgnoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
IgnoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
Method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
Password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
Ssl bool
The server where to migrate data from is secured with SSL. Default: true.
Username string
User name for authentication with the server where to migrate data from. Example: myname.
Host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
Dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
IgnoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
IgnoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
Method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
Password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
Ssl bool
The server where to migrate data from is secured with SSL. Default: true.
Username string
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. String
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. Integer
Port number of the server where to migrate data from. Example: 1234.
dbname String
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs String
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles String
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method String
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password String
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl Boolean
The server where to migrate data from is secured with SSL. Default: true.
username String
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. string
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. number
Port number of the server where to migrate data from. Example: 1234.
dbname string
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs string
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles string
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method string
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password string
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl boolean
The server where to migrate data from is secured with SSL. Default: true.
username string
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. str
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. int
Port number of the server where to migrate data from. Example: 1234.
dbname str
Database name for bootstrapping the initial connection. Example: defaultdb.
ignore_dbs str
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignore_roles str
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method str
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password str
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl bool
The server where to migrate data from is secured with SSL. Default: true.
username str
User name for authentication with the server where to migrate data from. Example: myname.
host This property is required. String
Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port This property is required. Number
Port number of the server where to migrate data from. Example: 1234.
dbname String
Database name for bootstrapping the initial connection. Example: defaultdb.
ignoreDbs String
Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment). Example: db1,db2.
ignoreRoles String
Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment). Example: role1,role2.
method String
Enum: dump, replication. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
password String
Password for authentication with the server where to migrate data from. Example: jjKk45Nnd.
ssl Boolean
The server where to migrate data from is secured with SSL. Default: true.
username String
User name for authentication with the server where to migrate data from. Example: myname.

PgPgUserConfigPg
, PgPgUserConfigPgArgs

AutovacuumAnalyzeScaleFactor double
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
AutovacuumAnalyzeThreshold int
Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
AutovacuumFreezeMaxAge int
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. Example: 200000000.
AutovacuumMaxWorkers int
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
AutovacuumVacuumCostDelay int
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
AutovacuumVacuumCostLimit int
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
AutovacuumVacuumScaleFactor double
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
AutovacuumVacuumThreshold int
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
BgwriterDelay int
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
BgwriterFlushAfter int
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
BgwriterLruMaxpages int
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
BgwriterLruMultiplier double
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
DeadlockTimeout int
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
DefaultToastCompression string
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
IdleInTransactionSessionTimeout int
Time out sessions with open transactions after this number of milliseconds.
Jit bool
Controls system-wide use of Just-in-Time Compilation (JIT).
LogAutovacuumMinDuration int
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.
LogErrorVerbosity string
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
LogLinePrefix string
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
LogMinDurationStatement int
Log statements that take more than this number of milliseconds to run, -1 disables.
LogTempFiles int
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
MaxFilesPerProcess int
PostgreSQL maximum number of files that can be open per process.
MaxLocksPerTransaction int
PostgreSQL maximum locks per transaction.
MaxLogicalReplicationWorkers int
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
MaxParallelWorkers int
Sets the maximum number of workers that the system can support for parallel queries.
MaxParallelWorkersPerGather int
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
MaxPredLocksPerTransaction int
PostgreSQL maximum predicate locks per transaction.
MaxPreparedTransactions int
PostgreSQL maximum prepared transactions.
MaxReplicationSlots int
PostgreSQL maximum replication slots.
MaxSlotWalKeepSize int
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
MaxStackDepth int
Maximum depth of the stack in bytes.
MaxStandbyArchiveDelay int
Max standby archive delay in milliseconds.
MaxStandbyStreamingDelay int
Max standby streaming delay in milliseconds.
MaxWalSenders int
PostgreSQL maximum WAL senders.
MaxWorkerProcesses int
Sets the maximum number of background processes that the system can support.
PasswordEncryption string
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
PgPartmanBgwDotInterval int
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
PgPartmanBgwDotRole string
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
PgStatMonitorDotPgsmEnableQueryPlan bool
Enables or disables query plan monitoring.
PgStatMonitorDotPgsmMaxBuckets int
Sets the maximum number of buckets. Example: 10.
PgStatStatementsDotTrack string
Enum: all, none, top. 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.
TempFileLimit int
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
Timezone string
PostgreSQL service timezone. Example: Europe/Helsinki.
TrackActivityQuerySize int
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
TrackCommitTimestamp string
Enum: off, on. Record commit time of transactions.
TrackFunctions string
Enum: all, none, pl. Enables tracking of function call counts and time used.
TrackIoTiming string
Enum: off, on. 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.
WalSenderTimeout int
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
WalWriterDelay int
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
AutovacuumAnalyzeScaleFactor float64
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
AutovacuumAnalyzeThreshold int
Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
AutovacuumFreezeMaxAge int
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. Example: 200000000.
AutovacuumMaxWorkers int
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
AutovacuumVacuumCostDelay int
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
AutovacuumVacuumCostLimit int
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
AutovacuumVacuumScaleFactor float64
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
AutovacuumVacuumThreshold int
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
BgwriterDelay int
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
BgwriterFlushAfter int
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
BgwriterLruMaxpages int
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
BgwriterLruMultiplier float64
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
DeadlockTimeout int
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
DefaultToastCompression string
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
IdleInTransactionSessionTimeout int
Time out sessions with open transactions after this number of milliseconds.
Jit bool
Controls system-wide use of Just-in-Time Compilation (JIT).
LogAutovacuumMinDuration int
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.
LogErrorVerbosity string
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
LogLinePrefix string
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
LogMinDurationStatement int
Log statements that take more than this number of milliseconds to run, -1 disables.
LogTempFiles int
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
MaxFilesPerProcess int
PostgreSQL maximum number of files that can be open per process.
MaxLocksPerTransaction int
PostgreSQL maximum locks per transaction.
MaxLogicalReplicationWorkers int
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
MaxParallelWorkers int
Sets the maximum number of workers that the system can support for parallel queries.
MaxParallelWorkersPerGather int
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
MaxPredLocksPerTransaction int
PostgreSQL maximum predicate locks per transaction.
MaxPreparedTransactions int
PostgreSQL maximum prepared transactions.
MaxReplicationSlots int
PostgreSQL maximum replication slots.
MaxSlotWalKeepSize int
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
MaxStackDepth int
Maximum depth of the stack in bytes.
MaxStandbyArchiveDelay int
Max standby archive delay in milliseconds.
MaxStandbyStreamingDelay int
Max standby streaming delay in milliseconds.
MaxWalSenders int
PostgreSQL maximum WAL senders.
MaxWorkerProcesses int
Sets the maximum number of background processes that the system can support.
PasswordEncryption string
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
PgPartmanBgwDotInterval int
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
PgPartmanBgwDotRole string
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
PgStatMonitorDotPgsmEnableQueryPlan bool
Enables or disables query plan monitoring.
PgStatMonitorDotPgsmMaxBuckets int
Sets the maximum number of buckets. Example: 10.
PgStatStatementsDotTrack string
Enum: all, none, top. 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.
TempFileLimit int
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
Timezone string
PostgreSQL service timezone. Example: Europe/Helsinki.
TrackActivityQuerySize int
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
TrackCommitTimestamp string
Enum: off, on. Record commit time of transactions.
TrackFunctions string
Enum: all, none, pl. Enables tracking of function call counts and time used.
TrackIoTiming string
Enum: off, on. 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.
WalSenderTimeout int
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
WalWriterDelay int
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
autovacuumAnalyzeScaleFactor Double
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuumAnalyzeThreshold Integer
Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
autovacuumFreezeMaxAge Integer
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. Example: 200000000.
autovacuumMaxWorkers Integer
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuumVacuumCostDelay Integer
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
autovacuumVacuumCostLimit Integer
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
autovacuumVacuumScaleFactor Double
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuumVacuumThreshold Integer
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
bgwriterDelay Integer
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
bgwriterFlushAfter Integer
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
bgwriterLruMaxpages Integer
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
bgwriterLruMultiplier Double
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
deadlockTimeout Integer
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
defaultToastCompression String
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
idleInTransactionSessionTimeout Integer
Time out sessions with open transactions after this number of milliseconds.
jit Boolean
Controls system-wide use of Just-in-Time Compilation (JIT).
logAutovacuumMinDuration Integer
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.
logErrorVerbosity String
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
logLinePrefix String
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
logMinDurationStatement Integer
Log statements that take more than this number of milliseconds to run, -1 disables.
logTempFiles Integer
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
maxFilesPerProcess Integer
PostgreSQL maximum number of files that can be open per process.
maxLocksPerTransaction Integer
PostgreSQL maximum locks per transaction.
maxLogicalReplicationWorkers Integer
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
maxParallelWorkers Integer
Sets the maximum number of workers that the system can support for parallel queries.
maxParallelWorkersPerGather Integer
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
maxPredLocksPerTransaction Integer
PostgreSQL maximum predicate locks per transaction.
maxPreparedTransactions Integer
PostgreSQL maximum prepared transactions.
maxReplicationSlots Integer
PostgreSQL maximum replication slots.
maxSlotWalKeepSize Integer
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
maxStackDepth Integer
Maximum depth of the stack in bytes.
maxStandbyArchiveDelay Integer
Max standby archive delay in milliseconds.
maxStandbyStreamingDelay Integer
Max standby streaming delay in milliseconds.
maxWalSenders Integer
PostgreSQL maximum WAL senders.
maxWorkerProcesses Integer
Sets the maximum number of background processes that the system can support.
passwordEncryption String
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval Integer
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
pgPartmanBgwDotRole String
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
pgStatMonitorDotPgsmEnableQueryPlan Boolean
Enables or disables query plan monitoring.
pgStatMonitorDotPgsmMaxBuckets Integer
Sets the maximum number of buckets. Example: 10.
pgStatStatementsDotTrack String
Enum: all, none, top. 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.
tempFileLimit Integer
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
timezone String
PostgreSQL service timezone. Example: Europe/Helsinki.
trackActivityQuerySize Integer
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
trackCommitTimestamp String
Enum: off, on. Record commit time of transactions.
trackFunctions String
Enum: all, none, pl. Enables tracking of function call counts and time used.
trackIoTiming String
Enum: off, on. 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.
walSenderTimeout Integer
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
walWriterDelay Integer
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
autovacuumAnalyzeScaleFactor number
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuumAnalyzeThreshold number
Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
autovacuumFreezeMaxAge number
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. Example: 200000000.
autovacuumMaxWorkers number
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuumVacuumCostDelay number
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
autovacuumVacuumCostLimit number
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
autovacuumVacuumScaleFactor number
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuumVacuumThreshold number
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
bgwriterDelay number
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
bgwriterFlushAfter number
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
bgwriterLruMaxpages number
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
bgwriterLruMultiplier number
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
deadlockTimeout number
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
defaultToastCompression string
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
idleInTransactionSessionTimeout number
Time out sessions with open transactions after this number of milliseconds.
jit boolean
Controls system-wide use of Just-in-Time Compilation (JIT).
logAutovacuumMinDuration number
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.
logErrorVerbosity string
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
logLinePrefix string
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
logMinDurationStatement number
Log statements that take more than this number of milliseconds to run, -1 disables.
logTempFiles number
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
maxFilesPerProcess number
PostgreSQL maximum number of files that can be open per process.
maxLocksPerTransaction number
PostgreSQL maximum locks per transaction.
maxLogicalReplicationWorkers number
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
maxParallelWorkers number
Sets the maximum number of workers that the system can support for parallel queries.
maxParallelWorkersPerGather number
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
maxPredLocksPerTransaction number
PostgreSQL maximum predicate locks per transaction.
maxPreparedTransactions number
PostgreSQL maximum prepared transactions.
maxReplicationSlots number
PostgreSQL maximum replication slots.
maxSlotWalKeepSize number
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
maxStackDepth number
Maximum depth of the stack in bytes.
maxStandbyArchiveDelay number
Max standby archive delay in milliseconds.
maxStandbyStreamingDelay number
Max standby streaming delay in milliseconds.
maxWalSenders number
PostgreSQL maximum WAL senders.
maxWorkerProcesses number
Sets the maximum number of background processes that the system can support.
passwordEncryption string
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval number
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
pgPartmanBgwDotRole string
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
pgStatMonitorDotPgsmEnableQueryPlan boolean
Enables or disables query plan monitoring.
pgStatMonitorDotPgsmMaxBuckets number
Sets the maximum number of buckets. Example: 10.
pgStatStatementsDotTrack string
Enum: all, none, top. 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.
tempFileLimit number
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
timezone string
PostgreSQL service timezone. Example: Europe/Helsinki.
trackActivityQuerySize number
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
trackCommitTimestamp string
Enum: off, on. Record commit time of transactions.
trackFunctions string
Enum: all, none, pl. Enables tracking of function call counts and time used.
trackIoTiming string
Enum: off, on. 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.
walSenderTimeout number
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
walWriterDelay number
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
autovacuum_analyze_scale_factor float
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuum_analyze_threshold int
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_max_age int
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. Example: 200000000.
autovacuum_max_workers int
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuum_vacuum_cost_delay int
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
autovacuum_vacuum_cost_limit int
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
autovacuum_vacuum_scale_factor float
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuum_vacuum_threshold int
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
bgwriter_delay int
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
bgwriter_flush_after int
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
bgwriter_lru_maxpages int
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
bgwriter_lru_multiplier float
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
deadlock_timeout int
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
default_toast_compression str
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
idle_in_transaction_session_timeout int
Time out sessions with open transactions after this number of milliseconds.
jit bool
Controls system-wide use of Just-in-Time Compilation (JIT).
log_autovacuum_min_duration int
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_verbosity str
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
log_line_prefix str
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
log_min_duration_statement int
Log statements that take more than this number of milliseconds to run, -1 disables.
log_temp_files int
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
max_files_per_process int
PostgreSQL maximum number of files that can be open per process.
max_locks_per_transaction int
PostgreSQL maximum locks per transaction.
max_logical_replication_workers int
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
max_parallel_workers int
Sets the maximum number of workers that the system can support for parallel queries.
max_parallel_workers_per_gather int
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
max_pred_locks_per_transaction int
PostgreSQL maximum predicate locks per transaction.
max_prepared_transactions int
PostgreSQL maximum prepared transactions.
max_replication_slots int
PostgreSQL maximum replication slots.
max_slot_wal_keep_size int
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
max_stack_depth int
Maximum depth of the stack in bytes.
max_standby_archive_delay int
Max standby archive delay in milliseconds.
max_standby_streaming_delay int
Max standby streaming delay in milliseconds.
max_wal_senders int
PostgreSQL maximum WAL senders.
max_worker_processes int
Sets the maximum number of background processes that the system can support.
password_encryption str
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pg_partman_bgw_dot_interval int
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
pg_partman_bgw_dot_role str
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
pg_stat_monitor_dot_pgsm_enable_query_plan bool
Enables or disables query plan monitoring.
pg_stat_monitor_dot_pgsm_max_buckets int
Sets the maximum number of buckets. Example: 10.
pg_stat_statements_dot_track str
Enum: all, none, top. 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.
temp_file_limit int
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
timezone str
PostgreSQL service timezone. Example: Europe/Helsinki.
track_activity_query_size int
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
track_commit_timestamp str
Enum: off, on. Record commit time of transactions.
track_functions str
Enum: all, none, pl. Enables tracking of function call counts and time used.
track_io_timing str
Enum: off, on. 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.
wal_sender_timeout int
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
wal_writer_delay int
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
autovacuumAnalyzeScaleFactor Number
Specifies a fraction of the table size to add to autovacuumanalyzethreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuumAnalyzeThreshold Number
Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
autovacuumFreezeMaxAge Number
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. Example: 200000000.
autovacuumMaxWorkers Number
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 between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuumVacuumCostDelay Number
Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumcostdelay value will be used. The default value is 20 milliseconds.
autovacuumVacuumCostLimit Number
Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumcostlimit value will be used.
autovacuumVacuumScaleFactor Number
Specifies a fraction of the table size to add to autovacuumvacuumthreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuumVacuumThreshold Number
Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
bgwriterDelay Number
Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
bgwriterFlushAfter Number
Whenever more than bgwriterflushafter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. Example: 512.
bgwriterLruMaxpages Number
In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
bgwriterLruMultiplier Number
The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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. Example: 2.0.
deadlockTimeout Number
This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
defaultToastCompression String
Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
idleInTransactionSessionTimeout Number
Time out sessions with open transactions after this number of milliseconds.
jit Boolean
Controls system-wide use of Just-in-Time Compilation (JIT).
logAutovacuumMinDuration Number
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.
logErrorVerbosity String
Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
logLinePrefix String
Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
logMinDurationStatement Number
Log statements that take more than this number of milliseconds to run, -1 disables.
logTempFiles Number
Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
maxFilesPerProcess Number
PostgreSQL maximum number of files that can be open per process.
maxLocksPerTransaction Number
PostgreSQL maximum locks per transaction.
maxLogicalReplicationWorkers Number
PostgreSQL maximum logical replication workers (taken from the pool of maxparallelworkers).
maxParallelWorkers Number
Sets the maximum number of workers that the system can support for parallel queries.
maxParallelWorkersPerGather Number
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
maxPredLocksPerTransaction Number
PostgreSQL maximum predicate locks per transaction.
maxPreparedTransactions Number
PostgreSQL maximum prepared transactions.
maxReplicationSlots Number
PostgreSQL maximum replication slots.
maxSlotWalKeepSize Number
PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walkeepsize minimum WAL size setting takes precedence over this.
maxStackDepth Number
Maximum depth of the stack in bytes.
maxStandbyArchiveDelay Number
Max standby archive delay in milliseconds.
maxStandbyStreamingDelay Number
Max standby streaming delay in milliseconds.
maxWalSenders Number
PostgreSQL maximum WAL senders.
maxWorkerProcesses Number
Sets the maximum number of background processes that the system can support.
passwordEncryption String
Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval Number
Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
pgPartmanBgwDotRole String
Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
pgStatMonitorDotPgsmEnableQueryPlan Boolean
Enables or disables query plan monitoring.
pgStatMonitorDotPgsmMaxBuckets Number
Sets the maximum number of buckets. Example: 10.
pgStatStatementsDotTrack String
Enum: all, none, top. 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.
tempFileLimit Number
PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
timezone String
PostgreSQL service timezone. Example: Europe/Helsinki.
trackActivityQuerySize Number
Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
trackCommitTimestamp String
Enum: off, on. Record commit time of transactions.
trackFunctions String
Enum: all, none, pl. Enables tracking of function call counts and time used.
trackIoTiming String
Enum: off, on. 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.
walSenderTimeout Number
Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
walWriterDelay Number
WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.

PgPgUserConfigPgQualstats
, PgPgUserConfigPgQualstatsArgs

Enabled bool
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

MinErrEstimateNum int
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

MinErrEstimateRatio int
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

TrackConstants bool
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

TrackPgCatalog bool
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

Enabled bool
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

MinErrEstimateNum int
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

MinErrEstimateRatio int
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

TrackConstants bool
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

TrackPgCatalog bool
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

enabled Boolean
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

minErrEstimateNum Integer
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

minErrEstimateRatio Integer
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

trackConstants Boolean
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

trackPgCatalog Boolean
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

enabled boolean
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

minErrEstimateNum number
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

minErrEstimateRatio number
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

trackConstants boolean
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

trackPgCatalog boolean
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

enabled bool
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

min_err_estimate_num int
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

min_err_estimate_ratio int
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

track_constants bool
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

track_pg_catalog bool
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

enabled Boolean
Enable / Disable pg_qualstats. Default: false.

Deprecated: This property is deprecated.

minErrEstimateNum Number
Error estimation num threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

minErrEstimateRatio Number
Error estimation ratio threshold to save quals. Default: 0.

Deprecated: This property is deprecated.

trackConstants Boolean
Enable / Disable pg_qualstats constants tracking. Default: true.

Deprecated: This property is deprecated.

trackPgCatalog Boolean
Track quals on system catalogs too. Default: false.

Deprecated: This property is deprecated.

PgPgUserConfigPgaudit
, PgPgUserConfigPgauditArgs

FeatureEnabled bool
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

LogCatalog bool
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

LogClient bool
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

LogLevel string
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

LogMaxStringLength int
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

LogNestedStatements bool
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

LogParameter bool
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

LogParameterMaxSize int
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

LogRelation bool
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

LogRows bool
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

LogStatement bool
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

LogStatementOnce bool
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

Logs List<string>
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

Role string
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

FeatureEnabled bool
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

LogCatalog bool
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

LogClient bool
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

LogLevel string
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

LogMaxStringLength int
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

LogNestedStatements bool
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

LogParameter bool
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

LogParameterMaxSize int
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

LogRelation bool
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

LogRows bool
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

LogStatement bool
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

LogStatementOnce bool
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

Logs []string
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

Role string
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

featureEnabled Boolean
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

logCatalog Boolean
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

logClient Boolean
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

logLevel String
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

logMaxStringLength Integer
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

logNestedStatements Boolean
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

logParameter Boolean
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

logParameterMaxSize Integer
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

logRelation Boolean
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

logRows Boolean
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

logStatement Boolean
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

logStatementOnce Boolean
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

logs List<String>
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

role String
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

featureEnabled boolean
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

logCatalog boolean
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

logClient boolean
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

logLevel string
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

logMaxStringLength number
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

logNestedStatements boolean
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

logParameter boolean
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

logParameterMaxSize number
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

logRelation boolean
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

logRows boolean
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

logStatement boolean
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

logStatementOnce boolean
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

logs string[]
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

role string
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

feature_enabled bool
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

log_catalog bool
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

log_client bool
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

log_level str
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

log_max_string_length int
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

log_nested_statements bool
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

log_parameter bool
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

log_parameter_max_size int
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

log_relation bool
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

log_rows bool
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

log_statement bool
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

log_statement_once bool
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

logs Sequence[str]
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

role str
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

featureEnabled Boolean
Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.

Deprecated: This property is deprecated.

logCatalog Boolean
Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.

Deprecated: This property is deprecated.

logClient Boolean
Specifies whether log messages will be visible to a client process such as psql. Default: false.

Deprecated: This property is deprecated.

logLevel String
Enum: debug1, debug2, debug3, debug4, debug5, info, notice, warning, log. Specifies the log level that will be used for log entries. Default: log.

Deprecated: This property is deprecated.

logMaxStringLength Number
Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.

Deprecated: This property is deprecated.

logNestedStatements Boolean
This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.

Deprecated: This property is deprecated.

logParameter Boolean
Specifies that audit logging should include the parameters that were passed with the statement. Default: false.

Deprecated: This property is deprecated.

logParameterMaxSize Number
Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with \n\n. Default: 0.

Deprecated: This property is deprecated.

logRelation Boolean
Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.

Deprecated: This property is deprecated.

logRows Boolean
Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. Default: false.

Deprecated: This property is deprecated.

logStatement Boolean
Specifies whether logging will include the statement text and parameters (if enabled). Default: true.

Deprecated: This property is deprecated.

logStatementOnce Boolean
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.

Deprecated: This property is deprecated.

logs List<String>
Specifies which classes of statements will be logged by session audit logging.

Deprecated: This property is deprecated.

role String
Specifies the master role to use for object audit logging.

Deprecated: This property is deprecated.

PgPgUserConfigPgbouncer
, PgPgUserConfigPgbouncerArgs

AutodbIdleTimeout int
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
AutodbMaxDbConnections int
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
AutodbPoolMode string
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
AutodbPoolSize int
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
IgnoreStartupParameters List<string>
List of parameters to ignore when given in startup packet.
MaxPreparedStatements int
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
MinPoolSize int
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
ServerIdleTimeout int
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
ServerLifetime int
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
ServerResetQueryAlways bool
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.
AutodbIdleTimeout int
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
AutodbMaxDbConnections int
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
AutodbPoolMode string
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
AutodbPoolSize int
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
IgnoreStartupParameters []string
List of parameters to ignore when given in startup packet.
MaxPreparedStatements int
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
MinPoolSize int
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
ServerIdleTimeout int
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
ServerLifetime int
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
ServerResetQueryAlways bool
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.
autodbIdleTimeout Integer
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
autodbMaxDbConnections Integer
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
autodbPoolMode String
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
autodbPoolSize Integer
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
ignoreStartupParameters List<String>
List of parameters to ignore when given in startup packet.
maxPreparedStatements Integer
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
minPoolSize Integer
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
serverIdleTimeout Integer
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
serverLifetime Integer
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
serverResetQueryAlways Boolean
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.
autodbIdleTimeout number
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
autodbMaxDbConnections number
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
autodbPoolMode string
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
autodbPoolSize number
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
ignoreStartupParameters string[]
List of parameters to ignore when given in startup packet.
maxPreparedStatements number
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
minPoolSize number
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
serverIdleTimeout number
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
serverLifetime number
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
serverResetQueryAlways boolean
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.
autodb_idle_timeout int
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
autodb_max_db_connections int
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
autodb_pool_mode str
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
autodb_pool_size int
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
ignore_startup_parameters Sequence[str]
List of parameters to ignore when given in startup packet.
max_prepared_statements int
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
min_pool_size int
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
server_idle_timeout int
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
server_lifetime int
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
server_reset_query_always bool
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.
autodbIdleTimeout Number
If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
autodbMaxDbConnections Number
Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
autodbPoolMode String
Enum: session, statement, transaction. PGBouncer pool mode. Default: transaction.
autodbPoolSize Number
If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
ignoreStartupParameters List<String>
List of parameters to ignore when given in startup packet.
maxPreparedStatements Number
PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when maxpreparedstatements is set to a non-zero value. Setting it to 0 disables prepared statements. maxpreparedstatements defaults to 100, and its maximum is 3000. Default: 100.
minPoolSize Number
Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
serverIdleTimeout Number
If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
serverLifetime Number
The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
serverResetQueryAlways Boolean
Run serverresetquery (DISCARD ALL) in all pooling modes. Default: false.

PgPgUserConfigPglookout
, PgPgUserConfigPglookoutArgs

MaxFailoverReplicationTimeLag int
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
MaxFailoverReplicationTimeLag int
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
maxFailoverReplicationTimeLag Integer
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
maxFailoverReplicationTimeLag number
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
max_failover_replication_time_lag int
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
maxFailoverReplicationTimeLag Number
Number of seconds of master unavailability before triggering database failover to standby. Default: 60.

PgPgUserConfigPrivateAccess
, PgPgUserConfigPrivateAccessArgs

Pg bool
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Pgbouncer bool
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Pg bool
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Pgbouncer bool
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pg Boolean
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pgbouncer Boolean
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pg boolean
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pgbouncer boolean
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pg bool
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pgbouncer bool
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus bool
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pg Boolean
Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
pgbouncer Boolean
Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean
Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

PgPgUserConfigPrivatelinkAccess
, PgPgUserConfigPrivatelinkAccessArgs

Pg bool
Enable pg.
Pgbouncer bool
Enable pgbouncer.
Prometheus bool
Enable prometheus.
Pg bool
Enable pg.
Pgbouncer bool
Enable pgbouncer.
Prometheus bool
Enable prometheus.
pg Boolean
Enable pg.
pgbouncer Boolean
Enable pgbouncer.
prometheus Boolean
Enable prometheus.
pg boolean
Enable pg.
pgbouncer boolean
Enable pgbouncer.
prometheus boolean
Enable prometheus.
pg bool
Enable pg.
pgbouncer bool
Enable pgbouncer.
prometheus bool
Enable prometheus.
pg Boolean
Enable pg.
pgbouncer Boolean
Enable pgbouncer.
prometheus Boolean
Enable prometheus.

PgPgUserConfigPublicAccess
, PgPgUserConfigPublicAccessArgs

Pg bool
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
Pgbouncer bool
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
Prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
Pg bool
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
Pgbouncer bool
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
Prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
pg Boolean
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
pgbouncer Boolean
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
pg boolean
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
pgbouncer boolean
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
pg bool
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
pgbouncer bool
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus bool
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
pg Boolean
Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
pgbouncer Boolean
Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

PgPgUserConfigTimescaledb
, PgPgUserConfigTimescaledbArgs

MaxBackgroundWorkers int
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.
MaxBackgroundWorkers int
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.
maxBackgroundWorkers Integer
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.
maxBackgroundWorkers number
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.
max_background_workers int
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.
maxBackgroundWorkers Number
The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Default: 16.

PgServiceIntegration
, PgServiceIntegrationArgs

IntegrationType This property is required. string
Type of the service integration. The possible values are read_replica and disaster_recovery.
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration. The possible values are read_replica and disaster_recovery.
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration. The possible values are read_replica and disaster_recovery.
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName This property is required. String
Name of the source service

PgTag
, PgTagArgs

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

PgTechEmail
, PgTechEmailArgs

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

Import

$ pulumi import aiven:index/pg:Pg example_postgres PROJECT/SERVICE_NAME
Copy

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

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven