Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Pg

Create a Pg Resource

new Pg(name: string, args: PgArgs, opts?: CustomResourceOptions);
def Pg(resource_name: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, pg: Optional[PgPgArgs] = None, pg_user_config: Optional[PgPgUserConfigArgs] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_integrations: Optional[Sequence[PgServiceIntegrationArgs]] = None, service_name: Optional[str] = None, termination_protection: Optional[bool] = None)
func NewPg(ctx *Context, name string, args PgArgs, opts ...ResourceOption) (*Pg, error)
public Pg(string name, PgArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PgArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PgArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PgArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Pg Resource Properties

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

Inputs

The Pg resource accepts the following input properties:

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.

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.

PgServer PgPgArgs

Enable pg.

PgUserConfig PgPgUserConfigArgs

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<PgServiceIntegrationArgs>

Service integrations to specify when creating a service. Not applied after initial service creation

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.

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 PgPg

Enable pg.

PgUserConfig PgPgUserConfig

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 []PgServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

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.

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 PgPg

Enable pg.

pgUserConfig PgPgUserConfig

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 PgServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

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.

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 PgPgArgs

Enable pg.

pg_user_config PgPgUserConfigArgs

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[PgServiceIntegrationArgs]

Service integrations to specify when creating a service. Not applied after initial service creation

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.

Outputs

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

Components List<PgComponent>

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

PostgreSQL hostname.

ServicePassword string

Password used for connecting to the PostgreSQL service, if applicable.

ServicePort int

PostgreSQL port.

ServiceType string

Aiven internal service type code

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.

Components []PgComponent

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

PostgreSQL hostname.

ServicePassword string

Password used for connecting to the PostgreSQL service, if applicable.

ServicePort int

PostgreSQL port.

ServiceType string

Aiven internal service type code

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.

components PgComponent[]

Service component information objects

id string
The provider-assigned unique ID for this managed resource.
serviceHost string

PostgreSQL hostname.

servicePassword string

Password used for connecting to the PostgreSQL service, if applicable.

servicePort number

PostgreSQL port.

serviceType string

Aiven internal service type code

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.

components Sequence[PgComponent]

Service component information objects

id str
The provider-assigned unique ID for this managed resource.
service_host str

PostgreSQL hostname.

service_password str

Password used for connecting to the PostgreSQL service, if applicable.

service_port int

PostgreSQL port.

service_type str

Aiven internal service type code

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.

Look up an Existing Pg Resource

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

public static get(name: string, id: Input<ID>, state?: PgState, opts?: CustomResourceOptions): Pg
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, components: Optional[Sequence[PgComponentArgs]] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, pg: Optional[PgPgArgs] = None, pg_user_config: Optional[PgPgUserConfigArgs] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_host: Optional[str] = None, service_integrations: Optional[Sequence[PgServiceIntegrationArgs]] = None, service_name: Optional[str] = None, service_password: Optional[str] = None, service_port: Optional[int] = None, service_type: Optional[str] = None, service_uri: Optional[str] = None, service_username: Optional[str] = None, state: Optional[str] = None, termination_protection: Optional[bool] = None) -> Pg
func GetPg(ctx *Context, name string, id IDInput, state *PgState, opts ...ResourceOption) (*Pg, error)
public static Pg Get(string name, Input<string> id, PgState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

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<PgComponentArgs>

Service component information objects

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.

PgServer PgPgArgs

Enable pg.

PgUserConfig PgPgUserConfigArgs

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.

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.

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<PgServiceIntegrationArgs>

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 PostgreSQL service, if applicable.

ServicePort int

PostgreSQL port.

ServiceType string

Aiven internal service type code

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.

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 []PgComponent

Service component information objects

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 PgPg

Enable pg.

PgUserConfig PgPgUserConfig

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.

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.

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 []PgServiceIntegration

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 PostgreSQL service, if applicable.

ServicePort int

PostgreSQL port.

ServiceType string

Aiven internal service type code

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.

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 PgComponent[]

Service component information objects

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 PgPg

Enable pg.

pgUserConfig PgPgUserConfig

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.

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.

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 PgServiceIntegration[]

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 PostgreSQL service, if applicable.

servicePort number

PostgreSQL port.

serviceType string

Aiven internal service type code

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.

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[PgComponentArgs]

Service component information objects

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 PgPgArgs

Enable pg.

pg_user_config PgPgUserConfigArgs

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

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[PgServiceIntegrationArgs]

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 PostgreSQL service, if applicable.

service_port int

PostgreSQL port.

service_type str

Aiven internal service type code

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.

Supporting Types

PgComponent

Component string
Host string

hostname or IP address of the server where to migrate data from.

KafkaAuthenticationMethod string
Port int

port number of the server where to migrate data from.

Route string
Ssl bool

the server where to migrate data from is secured with SSL.

Usage string
Component string
Host string

hostname or IP address of the server where to migrate data from.

KafkaAuthenticationMethod string
Port int

port number of the server where to migrate data from.

Route string
Ssl bool

the server where to migrate data from is secured with SSL.

Usage string
component string
host string

hostname or IP address of the server where to migrate data from.

kafkaAuthenticationMethod string
port number

port number of the server where to migrate data from.

route string
ssl boolean

the server where to migrate data from is secured with SSL.

usage string
component str
host str

hostname or IP address of the server where to migrate data from.

kafka_authentication_method str
port int

port number of the server where to migrate data from.

route str
ssl bool

the server where to migrate data from is secured with SSL.

usage str

PgPg

Dbname string

database name for bootstrapping the initial connection.

Host string

hostname or IP address of the server where to migrate data from.

Password string

password for authentication with the server where to migrate data from.

Port int

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

Host string

hostname or IP address of the server where to migrate data from.

Password string

password for authentication with the server where to migrate data from.

Port int

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

host string

hostname or IP address of the server where to migrate data from.

password string

password for authentication with the server where to migrate data from.

port number

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

host str

hostname or IP address of the server where to migrate data from.

password str

password for authentication with the server where to migrate data from.

port int

port number of the server where to migrate data from.

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

PgPgUserConfig

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 PgPgUserConfigMigrationArgs

migrate data from existing server, has the following options:

Pg PgPgUserConfigPgArgs

Enable pg.

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 PgPgUserConfigPgbouncerArgs

Enable pgbouncer.

Pglookout PgPgUserConfigPglookoutArgs

PGLookout settings.

PrivateAccess PgPgUserConfigPrivateAccessArgs

Allow access to selected service ports from private networks.

PrivatelinkAccess PgPgUserConfigPrivatelinkAccessArgs

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 PgPgUserConfigPublicAccessArgs

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 PgPgUserConfigTimescaledbArgs

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 PgPgUserConfigMigration

migrate data from existing server, has the following options:

Pg PgPgUserConfigPg

Enable pg.

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 PgPgUserConfigPgbouncer

Enable pgbouncer.

Pglookout PgPgUserConfigPglookout

PGLookout settings.

PrivateAccess PgPgUserConfigPrivateAccess

Allow access to selected service ports from private networks.

PrivatelinkAccess PgPgUserConfigPrivatelinkAccess

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 PgPgUserConfigPublicAccess

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 PgPgUserConfigTimescaledb

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 PgPgUserConfigMigration

migrate data from existing server, has the following options:

pg PgPgUserConfigPg

Enable pg.

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 PgPgUserConfigPgbouncer

Enable pgbouncer.

pglookout PgPgUserConfigPglookout

PGLookout settings.

privateAccess PgPgUserConfigPrivateAccess

Allow access to selected service ports from private networks.

privatelinkAccess PgPgUserConfigPrivatelinkAccess

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 PgPgUserConfigPublicAccess

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 PgPgUserConfigTimescaledb

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 PgPgUserConfigMigrationArgs

migrate data from existing server, has the following options:

pg PgPgUserConfigPgArgs

Enable pg.

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 PgPgUserConfigPgbouncerArgs

Enable pgbouncer.

pglookout PgPgUserConfigPglookoutArgs

PGLookout settings.

private_access PgPgUserConfigPrivateAccessArgs

Allow access to selected service ports from private networks.

privatelink_access PgPgUserConfigPrivatelinkAccessArgs

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 PgPgUserConfigPublicAccessArgs

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 PgPgUserConfigTimescaledbArgs

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).

PgPgUserConfigMigration

Dbname string

database name for bootstrapping the initial connection.

Host string

hostname or IP address of the server where to migrate data from.

Password string

password for authentication with the server where to migrate data from.

Port string

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

Host string

hostname or IP address of the server where to migrate data from.

Password string

password for authentication with the server where to migrate data from.

Port string

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

host string

hostname or IP address of the server where to migrate data from.

password string

password for authentication with the server where to migrate data from.

port string

port number of the server where to migrate data from.

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

database name for bootstrapping the initial connection.

host str

hostname or IP address of the server where to migrate data from.

password str

password for authentication with the server where to migrate data from.

port str

port number of the server where to migrate data from.

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.

PgPgUserConfigPg

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 - (Optional) Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - (Optional) Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - (Optional) 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 - (Optional) Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - (Optional) Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - (Optional) 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 - (Optional) Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - (Optional) Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - (Optional) 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 - (Optional) Sets the time interval to run pg_partman’s scheduled tasks * pg_partman_bgw.role - (Optional) Controls which role to use for pg_partman’s scheduled background tasks. * pg_stat_statements.track - (Optional) 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

PgPgUserConfigPgbouncer

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.

PgPgUserConfigPglookout

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

PgPgUserConfigPrivateAccess

Pg string

Enable pg.

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

Enable pg.

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

Enable pg.

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

Enable pg.

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

PgPgUserConfigPrivatelinkAccess

Pg string

Enable pg.

Pgbouncer string

Enable pgbouncer.

Pg string

Enable pg.

Pgbouncer string

Enable pgbouncer.

pg string

Enable pg.

pgbouncer string

Enable pgbouncer.

pg str

Enable pg.

pgbouncer str

Enable pgbouncer.

PgPgUserConfigPublicAccess

Pg string

Enable pg.

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

Enable pg.

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

Enable pg.

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

Enable pg.

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

PgPgUserConfigTimescaledb

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.

PgServiceIntegration

Package Details

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