Aiven v6.40.0, Jun 24 25

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

aiven.getPg

Explore with Pulumi AI

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

Example Usage

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

const examplePostgres = aiven.getPg({
    project: exampleProject.project,
    serviceName: "example-postgres-service",
});

import pulumi
import pulumi_aiven as aiven

example_postgres = aiven.get_pg(project=example_project["project"],
    service_name="example-postgres-service")

package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupPg(ctx, &aiven.LookupPgArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-postgres-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var examplePostgres = Aiven.GetPg.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-postgres-service",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetPgArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var examplePostgres = AivenFunctions.getPg(GetPgArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-postgres-service")
            .build());

    }
}

variables:
  examplePostgres:
    fn::invoke:
      function: aiven:getPg
      arguments:
        project: ${exampleProject.project}
        serviceName: example-postgres-service

Using getPg

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPg(args: GetPgArgs, opts?: InvokeOptions): Promise<GetPgResult>
function getPgOutput(args: GetPgOutputArgs, opts?: InvokeOptions): Output<GetPgResult>

def get_pg(project: Optional[str] = None,
           service_name: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> GetPgResult
def get_pg_output(project: Optional[pulumi.Input[str]] = None,
           service_name: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[GetPgResult]

func LookupPg(ctx *Context, args *LookupPgArgs, opts ...InvokeOption) (*LookupPgResult, error)
func LookupPgOutput(ctx *Context, args *LookupPgOutputArgs, opts ...InvokeOption) LookupPgResultOutput

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

public static class GetPg 
{
    public static Task<GetPgResult> InvokeAsync(GetPgArgs args, InvokeOptions? opts = null)
    public static Output<GetPgResult> Invoke(GetPgInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPgResult> getPg(GetPgArgs args, InvokeOptions options)
public static Output<GetPgResult> getPg(GetPgArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getPg:getPg
  arguments:
    # arguments dictionary

The following arguments are supported:

Project 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.
ServiceName 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.

Project 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.
ServiceName 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.

project 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.
serviceName 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.

project 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.
serviceName 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.

project 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.
service_name 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.

project 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.
serviceName 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.

getPg Result

The following output properties are available:

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<GetPgComponent>: 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.
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
Id string: The provider-assigned unique ID for this managed resource.
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.
PgUserConfigs List<GetPgPgUserConfig>: Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Pgs List<GetPgPg>: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
ServiceHost string: The hostname of the service.
ServiceIntegrations List<GetPgServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName 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<GetPgTag>: Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetPgTechEmail>: 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 []GetPgComponent: 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.
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
Id string: The provider-assigned unique ID for this managed resource.
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.
PgUserConfigs []GetPgPgUserConfig: Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Pgs []GetPgPg: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
ServiceHost string: The hostname of the service.
ServiceIntegrations []GetPgServiceIntegration: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName 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 []GetPgTag: Tags are key-value pairs that allow you to categorize services.
TechEmails []GetPgTechEmail: 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<GetPgComponent>: 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.
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
id String: The provider-assigned unique ID for this managed resource.
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.
pgUserConfigs List<GetPgPgUserConfig>: Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
pgs List<GetPgPg>: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
serviceHost String: The hostname of the service.
serviceIntegrations List<GetPgServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName 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<GetPgTag>: Tags are key-value pairs that allow you to categorize services.
techEmails List<GetPgTechEmail>: 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 GetPgComponent[]: 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.
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
id string: The provider-assigned unique ID for this managed resource.
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.
pgUserConfigs GetPgPgUserConfig[]: Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
pgs GetPgPg[]: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
serviceHost string: The hostname of the service.
serviceIntegrations GetPgServiceIntegration[]: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName 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 GetPgTag[]: Tags are key-value pairs that allow you to categorize services.
techEmails GetPgTechEmail[]: 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[GetPgComponent]: 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.
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
id str: The provider-assigned unique ID for this managed resource.
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_user_configs Sequence[GetPgPgUserConfig]: Pg user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
pgs Sequence[GetPgPg]: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a 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[GetPgServiceIntegration]: Service integrations to specify when creating a service. Not applied after initial service creation
service_name 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[GetPgTag]: Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetPgTechEmail]: 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.
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
id String: The provider-assigned unique ID for this managed resource.
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.
pgUserConfigs List<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
pgs List<Property Map>: Values provided by the PostgreSQL server.
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 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 runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a 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 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

GetPgComponent

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

GetPgPg

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<GetPgPgParam>: 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 []GetPgPgParam: 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<GetPgPgParam>: 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 GetPgPgParam[]: 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[GetPgPgParam]: 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.

GetPgPgParam

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.

GetPgPgUserConfig

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
AdminPassword string: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
AdminUsername 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<GetPgPgUserConfigIpFilterObject>: 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 GetPgPgUserConfigMigration: Migrate data from existing server
Pg GetPgPgUserConfigPg: postgresql.conf configuration values
PgQualstats GetPgPgUserConfigPgQualstats: 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 string: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
PgStatMonitorEnable bool: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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 GetPgPgUserConfigPgaudit: System-wide settings for the pgaudit extension
Pgbouncer GetPgPgUserConfigPgbouncer: PGBouncer connection pooling settings
Pglookout GetPgPgUserConfigPglookout: System-wide settings for pglookout
PrivateAccess GetPgPgUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetPgPgUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetPgPgUserConfigPublicAccess: Allow access to selected service ports from the public Internet
RecoveryTargetTime 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 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. Changing this parameter causes a service restart. 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 GetPgPgUserConfigTimescaledb: 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. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
AdminPassword string: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
AdminUsername 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 []GetPgPgUserConfigIpFilterObject: 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 GetPgPgUserConfigMigration: Migrate data from existing server
Pg GetPgPgUserConfigPg: postgresql.conf configuration values
PgQualstats GetPgPgUserConfigPgQualstats: 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 string: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
PgStatMonitorEnable bool: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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 GetPgPgUserConfigPgaudit: System-wide settings for the pgaudit extension
Pgbouncer GetPgPgUserConfigPgbouncer: PGBouncer connection pooling settings
Pglookout GetPgPgUserConfigPglookout: System-wide settings for pglookout
PrivateAccess GetPgPgUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetPgPgUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetPgPgUserConfigPublicAccess: Allow access to selected service ports from the public Internet
RecoveryTargetTime 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 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. Changing this parameter causes a service restart. 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 GetPgPgUserConfigTimescaledb: 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. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
adminPassword String: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername 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<GetPgPgUserConfigIpFilterObject>: 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 GetPgPgUserConfigMigration: Migrate data from existing server
pg GetPgPgUserConfigPg: postgresql.conf configuration values
pgQualstats GetPgPgUserConfigPgQualstats: 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 String: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable Boolean: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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 GetPgPgUserConfigPgaudit: System-wide settings for the pgaudit extension
pgbouncer GetPgPgUserConfigPgbouncer: PGBouncer connection pooling settings
pglookout GetPgPgUserConfigPglookout: System-wide settings for pglookout
privateAccess GetPgPgUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetPgPgUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetPgPgUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recoveryTargetTime 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 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. Changing this parameter causes a service restart. 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 GetPgPgUserConfigTimescaledb: 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. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

additionalBackupRegions string: Additional Cloud Regions for Backup Replication.
adminPassword string: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername 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 GetPgPgUserConfigIpFilterObject[]: 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 GetPgPgUserConfigMigration: Migrate data from existing server
pg GetPgPgUserConfigPg: postgresql.conf configuration values
pgQualstats GetPgPgUserConfigPgQualstats: 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 string: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable boolean: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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 GetPgPgUserConfigPgaudit: System-wide settings for the pgaudit extension
pgbouncer GetPgPgUserConfigPgbouncer: PGBouncer connection pooling settings
pglookout GetPgPgUserConfigPglookout: System-wide settings for pglookout
privateAccess GetPgPgUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetPgPgUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetPgPgUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recoveryTargetTime 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 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. Changing this parameter causes a service restart. 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 GetPgPgUserConfigTimescaledb: 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. The 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 str: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
admin_username 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[GetPgPgUserConfigIpFilterObject]: 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 GetPgPgUserConfigMigration: Migrate data from existing server
pg GetPgPgUserConfigPg: postgresql.conf configuration values
pg_qualstats GetPgPgUserConfigPgQualstats: 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 str: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
pg_stat_monitor_enable bool: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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 GetPgPgUserConfigPgaudit: System-wide settings for the pgaudit extension
pgbouncer GetPgPgUserConfigPgbouncer: PGBouncer connection pooling settings
pglookout GetPgPgUserConfigPglookout: System-wide settings for pglookout
private_access GetPgPgUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelink_access GetPgPgUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
project_to_fork_from 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 GetPgPgUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recovery_target_time 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 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. Changing this parameter causes a service restart. 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 GetPgPgUserConfigTimescaledb: 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. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
adminPassword String: Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
adminUsername 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 String: Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
pgStatMonitorEnable Boolean: Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements 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
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 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 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 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. Changing this parameter causes a service restart. 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. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.

GetPgPgUserConfigIpFilterObject

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

network string: CIDR address block. Example: 10.20.0.0/16.
description string: Description for IP filter list entry. Example: Production service IP range.

network str: CIDR address block. Example: 10.20.0.0/16.
description str: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

GetPgPgUserConfigMigration

Host string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port 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 string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
Port 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 String: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 string: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 str: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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 String: Hostname or IP address of the server where to migrate data from. Example: my.server.com.
port 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.

GetPgPgUserConfigPg

AutovacuumAnalyzeScaleFactor double: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
AutovacuumNaptime int: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
AutovacuumVacuumCostDelay int: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
AutovacuumVacuumCostLimit int: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
AutovacuumVacuumScaleFactor double: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
AutovacuumVacuumThreshold int: Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
BgwriterDelay int: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
BgwriterFlushAfter int: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
BgwriterLruMultiplier double: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
DefaultToastCompression string: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
MaxLocksPerTransaction int: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
MaxLogicalReplicationWorkers int: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
MaxParallelWorkers int: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
MaxParallelWorkersPerGather int: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
MaxPredLocksPerTransaction int: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
MaxPreparedTransactions int: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
MaxReplicationSlots int: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
MaxSlotWalKeepSize int: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
MaxStackDepth int: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
MaxStandbyArchiveDelay int: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
MaxStandbyStreamingDelay int: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
MaxWalSenders int: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
MaxWorkerProcesses int: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
PasswordEncryption string: Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
PgPartmanBgwDotInterval int: Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
PgStatMonitorDotPgsmMaxBuckets int: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
TrackCommitTimestamp string: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

AutovacuumAnalyzeScaleFactor float64: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
AutovacuumNaptime int: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
AutovacuumVacuumCostDelay int: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
AutovacuumVacuumCostLimit int: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
AutovacuumVacuumScaleFactor float64: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
AutovacuumVacuumThreshold int: Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
BgwriterDelay int: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
BgwriterFlushAfter int: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
BgwriterLruMultiplier float64: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
DefaultToastCompression string: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
MaxLocksPerTransaction int: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
MaxLogicalReplicationWorkers int: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
MaxParallelWorkers int: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
MaxParallelWorkersPerGather int: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
MaxPredLocksPerTransaction int: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
MaxPreparedTransactions int: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
MaxReplicationSlots int: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
MaxSlotWalKeepSize int: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
MaxStackDepth int: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
MaxStandbyArchiveDelay int: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
MaxStandbyStreamingDelay int: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
MaxWalSenders int: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
MaxWorkerProcesses int: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
PasswordEncryption string: Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
PgPartmanBgwDotInterval int: Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
PgStatMonitorDotPgsmMaxBuckets int: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
TrackCommitTimestamp string: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

autovacuumAnalyzeScaleFactor Double: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
autovacuumNaptime Integer: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
autovacuumVacuumCostDelay Integer: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
autovacuumVacuumCostLimit Integer: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
autovacuumVacuumScaleFactor Double: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
autovacuumVacuumThreshold Integer: Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
bgwriterDelay Integer: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
bgwriterFlushAfter Integer: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
bgwriterLruMultiplier Double: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
defaultToastCompression String: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
maxLocksPerTransaction Integer: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
maxLogicalReplicationWorkers Integer: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
maxParallelWorkers Integer: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
maxParallelWorkersPerGather Integer: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
maxPredLocksPerTransaction Integer: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
maxPreparedTransactions Integer: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
maxReplicationSlots Integer: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
maxSlotWalKeepSize Integer: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
maxStackDepth Integer: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
maxStandbyArchiveDelay Integer: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
maxStandbyStreamingDelay Integer: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
maxWalSenders Integer: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
maxWorkerProcesses Integer: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
passwordEncryption String: Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval Integer: Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
pgStatMonitorDotPgsmMaxBuckets Integer: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
trackCommitTimestamp String: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

autovacuumAnalyzeScaleFactor number: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
autovacuumNaptime number: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
autovacuumVacuumCostDelay number: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
autovacuumVacuumCostLimit number: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
autovacuumVacuumScaleFactor number: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
autovacuumVacuumThreshold number: Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
bgwriterDelay number: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
bgwriterFlushAfter number: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
bgwriterLruMultiplier number: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
defaultToastCompression string: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
maxLocksPerTransaction number: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
maxLogicalReplicationWorkers number: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
maxParallelWorkers number: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
maxParallelWorkersPerGather number: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
maxPredLocksPerTransaction number: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
maxPreparedTransactions number: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
maxReplicationSlots number: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
maxSlotWalKeepSize number: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
maxStackDepth number: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
maxStandbyArchiveDelay number: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
maxStandbyStreamingDelay number: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
maxWalSenders number: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
maxWorkerProcesses number: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
passwordEncryption string: Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval number: Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
pgStatMonitorDotPgsmMaxBuckets number: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
trackCommitTimestamp string: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

autovacuum_analyze_scale_factor float: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
autovacuum_naptime int: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
autovacuum_vacuum_cost_delay int: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
autovacuum_vacuum_cost_limit int: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
autovacuum_vacuum_scale_factor float: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
bgwriter_delay int: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
bgwriter_flush_after int: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
bgwriter_lru_multiplier float: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
default_toast_compression str: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
max_locks_per_transaction int: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
max_logical_replication_workers int: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
max_parallel_workers int: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
max_parallel_workers_per_gather int: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
max_pred_locks_per_transaction int: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
max_prepared_transactions int: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
max_replication_slots int: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
max_slot_wal_keep_size int: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
max_stack_depth int: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
max_standby_archive_delay int: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
max_standby_streaming_delay int: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
max_wal_senders int: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
max_worker_processes int: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
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 in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
pg_stat_monitor_dot_pgsm_max_buckets int: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
track_commit_timestamp str: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

autovacuumAnalyzeScaleFactor Number: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.
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.
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. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart. 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 3. Changing this parameter causes a service restart.
autovacuumNaptime Number: Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
autovacuumVacuumCostDelay Number: Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).
autovacuumVacuumCostLimit Number: Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).
autovacuumVacuumScaleFactor Number: Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.
autovacuumVacuumThreshold Number: Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
bgwriterDelay Number: Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example: 200.
bgwriterFlushAfter Number: Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. 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. The default is 100. Example: 100.
bgwriterLruMultiplier Number: The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. 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. The default is 1000 (upstream default). Example: 1000.
defaultToastCompression String: Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.
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 disables logging autovacuum actions. The default is 1000.
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. The default is 1000 (upstream default). Changing this parameter causes a service restart.
maxLocksPerTransaction Number: PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
maxLogicalReplicationWorkers Number: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.
maxParallelWorkers Number: Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).
maxParallelWorkersPerGather Number: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).
maxPredLocksPerTransaction Number: PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.
maxPreparedTransactions Number: PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
maxReplicationSlots Number: PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
maxSlotWalKeepSize Number: PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
maxStackDepth Number: Maximum depth of the stack in bytes. The default is 2097152 (upstream default).
maxStandbyArchiveDelay Number: Max standby archive delay in milliseconds. The default is 30000 (upstream default).
maxStandbyStreamingDelay Number: Max standby streaming delay in milliseconds. The default is 30000 (upstream default).
maxWalSenders Number: PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
maxWorkerProcesses Number: Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
passwordEncryption String: Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
pgPartmanBgwDotInterval Number: Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. 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. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.
pgStatMonitorDotPgsmMaxBuckets Number: Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+. 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 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. Changing this parameter causes a service restart. Example: 1024.
trackCommitTimestamp String: Enum: off, on. Record commit time of transactions. Changing this parameter causes a service restart.
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. The default is off. When on, 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. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example: 50.

GetPgPgUserConfigPgQualstats

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.

GetPgPgUserConfigPgaudit

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.
LogCatalog bool: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
LogClient bool: Specifies whether log messages will be visible to a client process such as psql. Default: false.
LogLevel string: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
LogMaxStringLength int: Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
LogNestedStatements bool: This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
LogParameter bool: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
LogParameterMaxSize int: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
LogStatement bool: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
Logs List<string>: Specifies which classes of statements will be logged by session audit logging.
Role string: Specifies the master role to use for object audit logging.

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.
LogCatalog bool: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
LogClient bool: Specifies whether log messages will be visible to a client process such as psql. Default: false.
LogLevel string: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
LogMaxStringLength int: Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
LogNestedStatements bool: This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
LogParameter bool: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
LogParameterMaxSize int: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
LogStatement bool: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
Logs []string: Specifies which classes of statements will be logged by session audit logging.
Role string: Specifies the master role to use for object audit logging.

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.
logCatalog Boolean: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
logClient Boolean: Specifies whether log messages will be visible to a client process such as psql. Default: false.
logLevel String: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
logMaxStringLength Integer: Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
logNestedStatements Boolean: This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
logParameter Boolean: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
logParameterMaxSize Integer: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
logStatement Boolean: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
logs List<String>: Specifies which classes of statements will be logged by session audit logging.
role String: Specifies the master role to use for object audit logging.

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.
logCatalog boolean: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
logClient boolean: Specifies whether log messages will be visible to a client process such as psql. Default: false.
logLevel string: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
logMaxStringLength number: Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
logNestedStatements boolean: This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
logParameter boolean: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
logParameterMaxSize number: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
logStatement boolean: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
logs string[]: Specifies which classes of statements will be logged by session audit logging.
role string: Specifies the master role to use for object audit logging.

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.
log_catalog bool: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
log_client bool: Specifies whether log messages will be visible to a client process such as psql. Default: false.
log_level str: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
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.
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.
log_parameter bool: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
log_parameter_max_size int: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
log_statement bool: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
logs Sequence[str]: Specifies which classes of statements will be logged by session audit logging.
role str: Specifies the master role to use for object audit logging.

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.
logCatalog Boolean: Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog. Default: true.
logClient Boolean: Specifies whether log messages will be visible to a client process such as psql. Default: false.
logLevel String: Enum: debug1, debug2, debug3, debug4, debug5, info, log, notice, warning. Specifies the log level that will be used for log entries. Default: log.
logMaxStringLength Number: Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
logNestedStatements Boolean: This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
logParameter Boolean: Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
logParameterMaxSize Number: Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
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.
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.
logStatement Boolean: Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
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.
logs List<String>: Specifies which classes of statements will be logged by session audit logging.
role String: Specifies the master role to use for object audit logging.

GetPgPgUserConfigPgbouncer

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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (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 max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements 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 server_reset_query (DISCARD ALL) in all pooling modes. Default: false.

GetPgPgUserConfigPglookout

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.

GetPgPgUserConfigPrivateAccess

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.

GetPgPgUserConfigPrivatelinkAccess

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.

GetPgPgUserConfigPublicAccess

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.

GetPgPgUserConfigTimescaledb

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. Changing this parameter causes a service restart. 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. Changing this parameter causes a service restart. 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. Changing this parameter causes a service restart. 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. Changing this parameter causes a service restart. 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. Changing this parameter causes a service restart. 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. Changing this parameter causes a service restart. Default: 16.

GetPgServiceIntegration

IntegrationType string: Type of the service integration. The possible values are read_replica and disaster_recovery.
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration. The possible values are read_replica and disaster_recovery.
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration. The possible values are read_replica and disaster_recovery.
source_service_name str: Name of the source service

integrationType String: Type of the service integration. The possible values are read_replica and disaster_recovery.
sourceServiceName String: Name of the source service

GetPgTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetPgTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email String: An email address to contact for technical issues

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

pulumi/pulumi-aiven

aiven.getPg

On this page

On this page

Example Usage

Using getPg

getPg Result

Supporting Types

GetPgComponent

GetPgPg

GetPgPgParam

GetPgPgUserConfig

GetPgPgUserConfigIpFilterObject

GetPgPgUserConfigMigration

GetPgPgUserConfigPg

GetPgPgUserConfigPgQualstats

GetPgPgUserConfigPgaudit

GetPgPgUserConfigPgbouncer

GetPgPgUserConfigPglookout

GetPgPgUserConfigPrivateAccess

GetPgPgUserConfigPrivatelinkAccess

GetPgPgUserConfigPublicAccess

GetPgPgUserConfigTimescaledb

GetPgServiceIntegration

GetPgTag

GetPgTechEmail

Package Details

On this page

On this page