getPg

# PG Data Source

The PG data source provides information about the existing Aiven PostgreSQL service.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var pg = Output.Create(Aiven.GetPg.InvokeAsync(new Aiven.GetPgArgs
        {
            Project = data.Aiven_project.Pr1.Project,
            ServiceName = "my-pg1",
        }));
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := aiven.LookupPg(ctx, &aiven.LookupPgArgs{
            Project:     data.Aiven_project.Pr1.Project,
            ServiceName: "my-pg1",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aiven as aiven

pg = aiven.get_pg(project=data["aiven_project"]["pr1"]["project"],
    service_name="my-pg1")

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

const pg = aiven.getPg({
    project: data.aiven_project.pr1.project,
    serviceName: "my-pg1",
});

Using getPg

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

def get_pg(cloud_name: Optional[str] = None, components: Optional[Sequence[GetPgComponentArgs]] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, pg: Optional[GetPgPgArgs] = None, pg_user_config: Optional[GetPgPgUserConfigArgs] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_host: Optional[str] = None, service_integrations: Optional[Sequence[GetPgServiceIntegrationArgs]] = None, service_name: Optional[str] = None, service_password: Optional[str] = None, service_port: Optional[int] = None, service_type: Optional[str] = None, service_uri: Optional[str] = None, service_username: Optional[str] = None, state: Optional[str] = None, termination_protection: Optional[bool] = None, opts: Optional[InvokeOptions] = None) -> GetPgResult

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

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

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

The following arguments are supported:

Project string: identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
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.
CloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
Components List<GetPgComponentArgs>
MaintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Pg GetPgPgArgs: PostgreSQL specific server provided values.
PgUserConfig GetPgPgUserConfigArgs: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
ProjectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string: PostgreSQL hostname.
ServiceIntegrations List<GetPgServiceIntegrationArgs>
ServicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
ServicePort int: PostgreSQL port.
ServiceType string
ServiceUri string: URI for connecting to the PostgreSQL service.
ServiceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
State string: Service state.
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.

Project string: identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
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.
CloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
Components []GetPgComponent
MaintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Pg GetPgPg: PostgreSQL specific server provided values.
PgUserConfig GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
ProjectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string: PostgreSQL hostname.
ServiceIntegrations []GetPgServiceIntegration
ServicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
ServicePort int: PostgreSQL port.
ServiceType string
ServiceUri string: URI for connecting to the PostgreSQL service.
ServiceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
State string: Service state.
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.

project string: identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
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.
cloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
components GetPgComponent[]
maintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
maintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pg GetPgPg: PostgreSQL specific server provided values.
pgUserConfig GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
projectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string: PostgreSQL hostname.
serviceIntegrations GetPgServiceIntegration[]
servicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
servicePort number: PostgreSQL port.
serviceType string
serviceUri string: URI for connecting to the PostgreSQL service.
serviceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
state string: Service state.
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.

project str: identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
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.
cloud_name str: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
components Sequence[GetPgComponentArgs]
maintenance_window_dow str: day of week when maintenance operations should be performed. On 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 GetPgPgArgs: PostgreSQL specific server provided values.
pg_user_config GetPgPgUserConfigArgs: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
project_vpc_id str: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str: PostgreSQL hostname.
service_integrations Sequence[GetPgServiceIntegrationArgs]
service_password str: Password used for connecting to the PostgreSQL service, if applicable.
service_port int: PostgreSQL port.
service_type str
service_uri str: URI for connecting to the PostgreSQL service.
service_username str: Username used for connecting to the PostgreSQL service, if applicable.
state str: Service state.
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.

getPg Result

The following output properties are available:

Components List<GetPgComponent>
Id string: The provider-assigned unique ID for this managed resource.
Pg GetPgPg: PostgreSQL specific server provided values.
Project string
ServiceHost string: PostgreSQL hostname.
ServiceName string
ServicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
ServicePort int: PostgreSQL port.
ServiceType string
ServiceUri string: URI for connecting to the PostgreSQL service.
ServiceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
State string: Service state.
CloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
MaintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
PgUserConfig GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
ProjectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations List<GetPgServiceIntegration>
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.

Components []GetPgComponent
Id string: The provider-assigned unique ID for this managed resource.
Pg GetPgPg: PostgreSQL specific server provided values.
Project string
ServiceHost string: PostgreSQL hostname.
ServiceName string
ServicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
ServicePort int: PostgreSQL port.
ServiceType string
ServiceUri string: URI for connecting to the PostgreSQL service.
ServiceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
State string: Service state.
CloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
MaintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
PgUserConfig GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
ProjectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations []GetPgServiceIntegration
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.

components GetPgComponent[]
id string: The provider-assigned unique ID for this managed resource.
pg GetPgPg: PostgreSQL specific server provided values.
project string
serviceHost string: PostgreSQL hostname.
serviceName string
servicePassword string: Password used for connecting to the PostgreSQL service, if applicable.
servicePort number: PostgreSQL port.
serviceType string
serviceUri string: URI for connecting to the PostgreSQL service.
serviceUsername string: Username used for connecting to the PostgreSQL service, if applicable.
state string: Service state.
cloudName string: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
maintenanceWindowDow string: day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
maintenanceWindowTime string: time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
pgUserConfig GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
projectVpcId string: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations GetPgServiceIntegration[]
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.

components Sequence[GetPgComponent]
id str: The provider-assigned unique ID for this managed resource.
pg GetPgPg: PostgreSQL specific server provided values.
project str
service_host str: PostgreSQL hostname.
service_name str
service_password str: Password used for connecting to the PostgreSQL service, if applicable.
service_port int: PostgreSQL port.
service_type str
service_uri str: URI for connecting to the PostgreSQL service.
service_username str: Username used for connecting to the PostgreSQL service, if applicable.
state str: Service state.
cloud_name str: defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.
maintenance_window_dow str: day of week when maintenance operations should be performed. On 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_config GetPgPgUserConfig: defines PostgreSQL specific additional configuration options. The following configuration options available:
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 exact options can be seen from the Aiven web console’s Create Service dialog.
project_vpc_id str: optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_integrations Sequence[GetPgServiceIntegration]
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.

Supporting Types

GetPgComponent

Component string
Host string: PostgreSQL master node host IP or name
KafkaAuthenticationMethod string
Port int: PostgreSQL port
Route string
Ssl bool: the server where to migrate data from is secured with SSL.
Usage string

Component string
Host string: PostgreSQL master node host IP or name
KafkaAuthenticationMethod string
Port int: PostgreSQL port
Route string
Ssl bool: the server where to migrate data from is secured with SSL.
Usage string

component string
host string: PostgreSQL master node host IP or name
kafkaAuthenticationMethod string
port number: PostgreSQL port
route string
ssl boolean: the server where to migrate data from is secured with SSL.
usage string

component str
host str: PostgreSQL master node host IP or name
kafka_authentication_method str
port int: PostgreSQL port
route str
ssl bool: the server where to migrate data from is secured with SSL.
usage str

GetPgPg

Dbname string: Primary PostgreSQL database name
Host string: PostgreSQL master node host IP or name
Password string: PostgreSQL admin user password
Port int: PostgreSQL port
ReplicaUri string: PostgreSQL replica URI for services with a replica
Sslmode string: PostgreSQL sslmode setting (currently always require)
Uri string: PostgreSQL master connection URI
User string: PostgreSQL admin user name

Dbname string: Primary PostgreSQL database name
Host string: PostgreSQL master node host IP or name
Password string: PostgreSQL admin user password
Port int: PostgreSQL port
ReplicaUri string: PostgreSQL replica URI for services with a replica
Sslmode string: PostgreSQL sslmode setting (currently always require)
Uri string: PostgreSQL master connection URI
User string: PostgreSQL admin user name

dbname string: Primary PostgreSQL database name
host string: PostgreSQL master node host IP or name
password string: PostgreSQL admin user password
port number: PostgreSQL port
replicaUri string: PostgreSQL replica URI for services with a replica
sslmode string: PostgreSQL sslmode setting (currently always require)
uri string: PostgreSQL master connection URI
user string: PostgreSQL admin user name

dbname str: Primary PostgreSQL database name
host str: PostgreSQL master node host IP or name
password str: PostgreSQL admin user password
port int: PostgreSQL port
replica_uri str: PostgreSQL replica URI for services with a replica
sslmode str: PostgreSQL sslmode setting (currently always require)
uri str: PostgreSQL master connection URI
user str: PostgreSQL admin user name

GetPgPgUserConfig

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.
BackupHour string: the hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.
BackupMinute string: the minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.
IpFilters List<string>: allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
Migration GetPgPgUserConfigMigrationArgs: migrate data from existing server, has the following options:
Pg GetPgPgUserConfigPgArgs: PostgreSQL specific server provided values.
PgReadReplica string: This setting is 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.
PgVersion string: PostgreSQL major version.
Pgbouncer GetPgPgUserConfigPgbouncerArgs: Enable pgbouncer.
Pglookout GetPgPgUserConfigPglookoutArgs: PGLookout settings.
PrivateAccess GetPgPgUserConfigPrivateAccessArgs: Allow access to selected service ports from private networks.
PrivatelinkAccess GetPgPgUserConfigPrivatelinkAccessArgs: 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.
PublicAccess GetPgPgUserConfigPublicAccessArgs: 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.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created.
SharedBuffersPercentage string: Percentage of total RAM that the database server uses for memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. The absolute maximum is 12 GB.
SynchronousReplication string: Synchronous replication type. Note that the service plan also needs to support synchronous replication.
Timescaledb GetPgPgUserConfigTimescaledbArgs: TimescaleDB extension configuration values.
Variant string: Variant of the PostgreSQL service, may affect the features that are exposed by default. Options: aiven or timescale.
WorkMem string: Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).

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.
BackupHour string: the hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.
BackupMinute string: the minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.
IpFilters []string: allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
Migration GetPgPgUserConfigMigration: migrate data from existing server, has the following options:
Pg GetPgPgUserConfigPg: PostgreSQL specific server provided values.
PgReadReplica string: This setting is 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.
PgVersion string: PostgreSQL major version.
Pgbouncer GetPgPgUserConfigPgbouncer: Enable pgbouncer.
Pglookout GetPgPgUserConfigPglookout: PGLookout settings.
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.
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.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created.
SharedBuffersPercentage string: Percentage of total RAM that the database server uses for memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. The absolute maximum is 12 GB.
SynchronousReplication string: Synchronous replication type. Note that the service plan also needs to support synchronous replication.
Timescaledb GetPgPgUserConfigTimescaledb: TimescaleDB extension configuration values.
Variant string: Variant of the PostgreSQL service, may affect the features that are exposed by default. Options: aiven or timescale.
WorkMem string: Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).

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.
backupHour string: the hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.
backupMinute string: the minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.
ipFilters string[]: allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
migration GetPgPgUserConfigMigration: migrate data from existing server, has the following options:
pg GetPgPgUserConfigPg: PostgreSQL specific server provided values.
pgReadReplica string: This setting is 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.
pgVersion string: PostgreSQL major version.
pgbouncer GetPgPgUserConfigPgbouncer: Enable pgbouncer.
pglookout GetPgPgUserConfigPglookout: PGLookout settings.
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.
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.
serviceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created.
sharedBuffersPercentage string: Percentage of total RAM that the database server uses for memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. The absolute maximum is 12 GB.
synchronousReplication string: Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb GetPgPgUserConfigTimescaledb: TimescaleDB extension configuration values.
variant string: Variant of the PostgreSQL service, may affect the features that are exposed by default. Options: aiven or timescale.
workMem string: Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).

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.
backup_hour str: the hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.
backup_minute str: the minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.
ip_filters Sequence[str]: allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
migration GetPgPgUserConfigMigrationArgs: migrate data from existing server, has the following options:
pg GetPgPgUserConfigPgArgs: PostgreSQL specific server provided values.
pg_read_replica str: This setting is 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.
pg_version str: PostgreSQL major version.
pgbouncer GetPgPgUserConfigPgbouncerArgs: Enable pgbouncer.
pglookout GetPgPgUserConfigPglookoutArgs: PGLookout settings.
private_access GetPgPgUserConfigPrivateAccessArgs: Allow access to selected service ports from private networks.
privatelink_access GetPgPgUserConfigPrivatelinkAccessArgs: 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.
public_access GetPgPgUserConfigPublicAccessArgs: 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.
service_to_fork_from str: Name of another service to fork from. This has effect only when a new service is being created.
shared_buffers_percentage str: Percentage of total RAM that the database server uses for memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. The absolute maximum is 12 GB.
synchronous_replication str: Synchronous replication type. Note that the service plan also needs to support synchronous replication.
timescaledb GetPgPgUserConfigTimescaledbArgs: TimescaleDB extension configuration values.
variant str: Variant of the PostgreSQL service, may affect the features that are exposed by default. Options: aiven or timescale.
work_mem str: Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).

GetPgPgUserConfigMigration

Dbname string: Primary PostgreSQL database name
Host string: PostgreSQL master node host IP or name
Password string: PostgreSQL admin user password
Port string: PostgreSQL port
Ssl string: the server where to migrate data from is secured with SSL.
Username string: user name for authentication with the server where to migrate data from.

Dbname string: Primary PostgreSQL database name
Host string: PostgreSQL master node host IP or name
Password string: PostgreSQL admin user password
Port string: PostgreSQL port
Ssl string: the server where to migrate data from is secured with SSL.
Username string: user name for authentication with the server where to migrate data from.

dbname string: Primary PostgreSQL database name
host string: PostgreSQL master node host IP or name
password string: PostgreSQL admin user password
port string: PostgreSQL port
ssl string: the server where to migrate data from is secured with SSL.
username string: user name for authentication with the server where to migrate data from.

dbname str: Primary PostgreSQL database name
host str: PostgreSQL master node host IP or name
password str: PostgreSQL admin user password
port str: PostgreSQL port
ssl str: the server where to migrate data from is secured with SSL.
username str: user name for authentication with the server where to migrate data from.

GetPgPgUserConfigPg

AutovacuumAnalyzeScaleFactor string: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
AutovacuumAnalyzeThreshold string: specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
AutovacuumFreezeMaxAge string: specifies the maximum age (in transactions) that a table’s pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
AutovacuumMaxWorkers string: specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
AutovacuumNaptime string: specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
AutovacuumVacuumCostDelay string: 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 value is 20 milliseconds.
AutovacuumVacuumCostLimit string: specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
AutovacuumVacuumScaleFactor string: specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
AutovacuumVacuumThreshold string: specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples
DeadlockTimeout string: this is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
IdleInTransactionSessionTimeout string: Time out sessions with open transactions after this number of milliseconds.
Jit string: Controls system-wide use of Just-in-Time Compilation (JIT).
LogAutovacuumMinDuration string: Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
LogErrorVerbosity string: Controls the amount of detail written in the server log for each message that is logged. Possible values: TERSE, DEFAULT and VERBOSE.
LogMinDurationStatement string: Log statements that take more than this number of milliseconds to run, -1 disables
MaxFilesPerProcess string: PostgreSQL maximum number of files that can be open per process
MaxLocksPerTransaction string: PostgreSQL maximum locks per transaction
MaxLogicalReplicationWorkers string: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)
MaxParallelWorkers string: Sets the maximum number of workers that the system can support for parallel queries.
MaxParallelWorkersPerGather string: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
MaxPredLocksPerTransaction string: PostgreSQL maximum predicate locks per transaction
MaxPreparedTransactions string: PostgreSQL maximum prepared transactions
MaxReplicationSlots string: PostgreSQL maximum replication slots
MaxStackDepth string: Maximum depth of the stack in bytes
MaxStandbyArchiveDelay string: Max standby archive delay in milliseconds
MaxStandbyStreamingDelay string: Max standby streaming delay in milliseconds
MaxWalSenders string: PostgreSQL maximum WAL senders
MaxWorkerProcesses string: Sets the maximum number of background processes that the system can support * pg_partman_bgw.interval - Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
PgPartmanBgwDotInterval string
PgPartmanBgwDotRole string
PgStatStatementsDotTrack string
TempFileLimit string: PostgreSQL temporary file limit in KiB, -1 for unlimited
Timezone string: PostgreSQL service timezone
TrackActivityQuerySize string: Specifies the number of bytes reserved to track the currently executing command for each active session.
TrackCommitTimestamp string: Record commit time of transactions
TrackFunctions string: Enables tracking of function call counts and time used.
WalSenderTimeout string: Terminate replication connections that are inactive for longer than this amount of time, in milliseconds.
WalWriterDelay string: WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance

AutovacuumAnalyzeScaleFactor string: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
AutovacuumAnalyzeThreshold string: specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
AutovacuumFreezeMaxAge string: specifies the maximum age (in transactions) that a table’s pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
AutovacuumMaxWorkers string: specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
AutovacuumNaptime string: specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
AutovacuumVacuumCostDelay string: 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 value is 20 milliseconds.
AutovacuumVacuumCostLimit string: specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
AutovacuumVacuumScaleFactor string: specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
AutovacuumVacuumThreshold string: specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples
DeadlockTimeout string: this is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
IdleInTransactionSessionTimeout string: Time out sessions with open transactions after this number of milliseconds.
Jit string: Controls system-wide use of Just-in-Time Compilation (JIT).
LogAutovacuumMinDuration string: Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
LogErrorVerbosity string: Controls the amount of detail written in the server log for each message that is logged. Possible values: TERSE, DEFAULT and VERBOSE.
LogMinDurationStatement string: Log statements that take more than this number of milliseconds to run, -1 disables
MaxFilesPerProcess string: PostgreSQL maximum number of files that can be open per process
MaxLocksPerTransaction string: PostgreSQL maximum locks per transaction
MaxLogicalReplicationWorkers string: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)
MaxParallelWorkers string: Sets the maximum number of workers that the system can support for parallel queries.
MaxParallelWorkersPerGather string: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
MaxPredLocksPerTransaction string: PostgreSQL maximum predicate locks per transaction
MaxPreparedTransactions string: PostgreSQL maximum prepared transactions
MaxReplicationSlots string: PostgreSQL maximum replication slots
MaxStackDepth string: Maximum depth of the stack in bytes
MaxStandbyArchiveDelay string: Max standby archive delay in milliseconds
MaxStandbyStreamingDelay string: Max standby streaming delay in milliseconds
MaxWalSenders string: PostgreSQL maximum WAL senders
MaxWorkerProcesses string: Sets the maximum number of background processes that the system can support * pg_partman_bgw.interval - Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
PgPartmanBgwDotInterval string
PgPartmanBgwDotRole string
PgStatStatementsDotTrack string
TempFileLimit string: PostgreSQL temporary file limit in KiB, -1 for unlimited
Timezone string: PostgreSQL service timezone
TrackActivityQuerySize string: Specifies the number of bytes reserved to track the currently executing command for each active session.
TrackCommitTimestamp string: Record commit time of transactions
TrackFunctions string: Enables tracking of function call counts and time used.
WalSenderTimeout string: Terminate replication connections that are inactive for longer than this amount of time, in milliseconds.
WalWriterDelay string: WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance

autovacuumAnalyzeScaleFactor string: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuumAnalyzeThreshold string: specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
autovacuumFreezeMaxAge string: specifies the maximum age (in transactions) that a table’s pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
autovacuumMaxWorkers string: specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
autovacuumNaptime string: specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuumVacuumCostDelay string: 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 value is 20 milliseconds.
autovacuumVacuumCostLimit string: specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
autovacuumVacuumScaleFactor string: specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuumVacuumThreshold string: specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples
deadlockTimeout string: this is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
idleInTransactionSessionTimeout string: Time out sessions with open transactions after this number of milliseconds.
jit string: Controls system-wide use of Just-in-Time Compilation (JIT).
logAutovacuumMinDuration string: Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
logErrorVerbosity string: Controls the amount of detail written in the server log for each message that is logged. Possible values: TERSE, DEFAULT and VERBOSE.
logMinDurationStatement string: Log statements that take more than this number of milliseconds to run, -1 disables
maxFilesPerProcess string: PostgreSQL maximum number of files that can be open per process
maxLocksPerTransaction string: PostgreSQL maximum locks per transaction
maxLogicalReplicationWorkers string: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)
maxParallelWorkers string: Sets the maximum number of workers that the system can support for parallel queries.
maxParallelWorkersPerGather string: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
maxPredLocksPerTransaction string: PostgreSQL maximum predicate locks per transaction
maxPreparedTransactions string: PostgreSQL maximum prepared transactions
maxReplicationSlots string: PostgreSQL maximum replication slots
maxStackDepth string: Maximum depth of the stack in bytes
maxStandbyArchiveDelay string: Max standby archive delay in milliseconds
maxStandbyStreamingDelay string: Max standby streaming delay in milliseconds
maxWalSenders string: PostgreSQL maximum WAL senders
maxWorkerProcesses string: Sets the maximum number of background processes that the system can support * pg_partman_bgw.interval - Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
pgPartmanBgwDotInterval string
pgPartmanBgwDotRole string
pgStatStatementsDotTrack string
tempFileLimit string: PostgreSQL temporary file limit in KiB, -1 for unlimited
timezone string: PostgreSQL service timezone
trackActivityQuerySize string: Specifies the number of bytes reserved to track the currently executing command for each active session.
trackCommitTimestamp string: Record commit time of transactions
trackFunctions string: Enables tracking of function call counts and time used.
walSenderTimeout string: Terminate replication connections that are inactive for longer than this amount of time, in milliseconds.
walWriterDelay string: WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance

autovacuum_analyze_scale_factor str: Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
autovacuum_analyze_threshold str: specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
autovacuum_freeze_max_age str: specifies the maximum age (in transactions) that a table’s pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
autovacuum_max_workers str: specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
autovacuum_naptime str: specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
autovacuum_vacuum_cost_delay str: 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 value is 20 milliseconds.
autovacuum_vacuum_cost_limit str: specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
autovacuum_vacuum_scale_factor str: specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
autovacuum_vacuum_threshold str: specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples
deadlock_timeout str: this is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
idle_in_transaction_session_timeout str: Time out sessions with open transactions after this number of milliseconds.
jit str: Controls system-wide use of Just-in-Time Compilation (JIT).
log_autovacuum_min_duration str: Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
log_error_verbosity str: Controls the amount of detail written in the server log for each message that is logged. Possible values: TERSE, DEFAULT and VERBOSE.
log_min_duration_statement str: Log statements that take more than this number of milliseconds to run, -1 disables
max_files_per_process str: PostgreSQL maximum number of files that can be open per process
max_locks_per_transaction str: PostgreSQL maximum locks per transaction
max_logical_replication_workers str: PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)
max_parallel_workers str: Sets the maximum number of workers that the system can support for parallel queries.
max_parallel_workers_per_gather str: Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
max_pred_locks_per_transaction str: PostgreSQL maximum predicate locks per transaction
max_prepared_transactions str: PostgreSQL maximum prepared transactions
max_replication_slots str: PostgreSQL maximum replication slots
max_stack_depth str: Maximum depth of the stack in bytes
max_standby_archive_delay str: Max standby archive delay in milliseconds
max_standby_streaming_delay str: Max standby streaming delay in milliseconds
max_wal_senders str: PostgreSQL maximum WAL senders
max_worker_processes str: Sets the maximum number of background processes that the system can support * pg_partman_bgw.interval - Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
pg_partman_bgw_dot_interval str
pg_partman_bgw_dot_role str
pg_stat_statements_dot_track str
temp_file_limit str: PostgreSQL temporary file limit in KiB, -1 for unlimited
timezone str: PostgreSQL service timezone
track_activity_query_size str: Specifies the number of bytes reserved to track the currently executing command for each active session.
track_commit_timestamp str: Record commit time of transactions
track_functions str: Enables tracking of function call counts and time used.
wal_sender_timeout str: Terminate replication connections that are inactive for longer than this amount of time, in milliseconds.
wal_writer_delay str: WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance

GetPgPgUserConfigPgbouncer

AutodbIdleTimeout string: If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled.
AutodbMaxDbConnections string: Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.
AutodbPoolMode string: PGBouncer pool mode
AutodbPoolSize string: If non-zero then create automatically a pool of that size per user when a pool doesn’t exist.
IgnoreStartupParameters List<string>: Enum of parameters to ignore when given in startup packet.
MinPoolSize string: 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.
ServerIdleTimeout string: If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled.
ServerLifetime string: The pooler will close an unused server connection that has been connected longer than this.
ServerResetQueryAlways string: Run server_reset_query (DISCARD ALL) in all pooling modes.

AutodbIdleTimeout string: If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled.
AutodbMaxDbConnections string: Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.
AutodbPoolMode string: PGBouncer pool mode
AutodbPoolSize string: If non-zero then create automatically a pool of that size per user when a pool doesn’t exist.
IgnoreStartupParameters []string: Enum of parameters to ignore when given in startup packet.
MinPoolSize string: 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.
ServerIdleTimeout string: If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled.
ServerLifetime string: The pooler will close an unused server connection that has been connected longer than this.
ServerResetQueryAlways string: Run server_reset_query (DISCARD ALL) in all pooling modes.

autodbIdleTimeout string: If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled.
autodbMaxDbConnections string: Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.
autodbPoolMode string: PGBouncer pool mode
autodbPoolSize string: If non-zero then create automatically a pool of that size per user when a pool doesn’t exist.
ignoreStartupParameters string[]: Enum of parameters to ignore when given in startup packet.
minPoolSize string: 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.
serverIdleTimeout string: If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled.
serverLifetime string: The pooler will close an unused server connection that has been connected longer than this.
serverResetQueryAlways string: Run server_reset_query (DISCARD ALL) in all pooling modes.

autodb_idle_timeout str: If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled.
autodb_max_db_connections str: Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.
autodb_pool_mode str: PGBouncer pool mode
autodb_pool_size str: If non-zero then create automatically a pool of that size per user when a pool doesn’t exist.
ignore_startup_parameters Sequence[str]: Enum of parameters to ignore when given in startup packet.
min_pool_size str: 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.
server_idle_timeout str: If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled.
server_lifetime str: The pooler will close an unused server connection that has been connected longer than this.
server_reset_query_always str: Run server_reset_query (DISCARD ALL) in all pooling modes.

GetPgPgUserConfigPglookout

MaxFailoverReplicationTimeLag string: Number of seconds of master unavailability before triggering database failover to standby

MaxFailoverReplicationTimeLag string: Number of seconds of master unavailability before triggering database failover to standby

maxFailoverReplicationTimeLag string: Number of seconds of master unavailability before triggering database failover to standby

max_failover_replication_time_lag str: Number of seconds of master unavailability before triggering database failover to standby

GetPgPgUserConfigPrivateAccess

Pg string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.
Prometheus string: 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 string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.
Prometheus string: 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 string: PostgreSQL specific server provided values.
pgbouncer string: Enable pgbouncer.
prometheus string: 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 str: PostgreSQL specific server provided values.
pgbouncer str: Enable pgbouncer.
prometheus str: 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

GetPgPgUserConfigPrivatelinkAccess

Pg string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.

Pg string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.

pg string: PostgreSQL specific server provided values.
pgbouncer string: Enable pgbouncer.

pg str: PostgreSQL specific server provided values.
pgbouncer str: Enable pgbouncer.

GetPgPgUserConfigPublicAccess

Pg string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.
Prometheus string: 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 string: PostgreSQL specific server provided values.
Pgbouncer string: Enable pgbouncer.
Prometheus string: 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 string: PostgreSQL specific server provided values.
pgbouncer string: Enable pgbouncer.
prometheus string: 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 str: PostgreSQL specific server provided values.
pgbouncer str: Enable pgbouncer.
prometheus str: 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 string: 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.

MaxBackgroundWorkers string: 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.

maxBackgroundWorkers string: 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.

max_background_workers str: 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.

GetPgServiceIntegration

IntegrationType string
SourceServiceName string

IntegrationType string
SourceServiceName string

integrationType string
sourceServiceName string

integration_type str
source_service_name str

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

getPg

# PG Data Source

Example Usage

Using getPg

getPg Result

Supporting Types

GetPgComponent

GetPgPg

GetPgPgUserConfig

GetPgPgUserConfigMigration

GetPgPgUserConfigPg

GetPgPgUserConfigPgbouncer

GetPgPgUserConfigPglookout

GetPgPgUserConfigPrivateAccess

GetPgPgUserConfigPrivatelinkAccess

GetPgPgUserConfigPublicAccess

GetPgPgUserConfigTimescaledb

GetPgServiceIntegration

Package Details

On This Page