aiven.getAlloydbomni
Gets information about an Aiven for AlloyDB Omni service.
This resource is in the beta stage and may change without notice. Set
the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource.
!> End of life notice Aiven for AlloyDB Omni is entering its end-of-life cycle. From 5 September 2025, you can no longer create new Aiven for AlloyDB Omni services. Existing services continue to operate until the end of life (EOL) date but you cannot change plans for these services. On 5 December 2025, all active Aiven for AlloyDB Omni services are powered off and deleted, making data from these services inaccessible. The recommended alternatives to Aiven for AlloyDB Omni are: Aiven for PostgreSQL®, Aiven for ClickHouse®, and Aiven for MySQL®. To ensure uninterrupted service, complete your migration before December 5, 2025. For further assistance, contact the Aiven support team or your account team.
Using getAlloydbomni
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAlloydbomni(args: GetAlloydbomniArgs, opts?: InvokeOptions): Promise<GetAlloydbomniResult>
function getAlloydbomniOutput(args: GetAlloydbomniOutputArgs, opts?: InvokeOptions): Output<GetAlloydbomniResult>def get_alloydbomni(project: Optional[str] = None,
                    service_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAlloydbomniResult
def get_alloydbomni_output(project: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAlloydbomniResult]func LookupAlloydbomni(ctx *Context, args *LookupAlloydbomniArgs, opts ...InvokeOption) (*LookupAlloydbomniResult, error)
func LookupAlloydbomniOutput(ctx *Context, args *LookupAlloydbomniOutputArgs, opts ...InvokeOption) LookupAlloydbomniResultOutput> Note: This function is named LookupAlloydbomni in the Go SDK.
public static class GetAlloydbomni 
{
    public static Task<GetAlloydbomniResult> InvokeAsync(GetAlloydbomniArgs args, InvokeOptions? opts = null)
    public static Output<GetAlloydbomniResult> Invoke(GetAlloydbomniInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAlloydbomniResult> getAlloydbomni(GetAlloydbomniArgs args, InvokeOptions options)
public static Output<GetAlloydbomniResult> getAlloydbomni(GetAlloydbomniArgs args, InvokeOptions options)
fn::invoke:
  function: aiven:index/getAlloydbomni:getAlloydbomni
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ServiceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ServiceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName String
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- service_name str
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName String
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
getAlloydbomni Result
The following output properties are available:
- AdditionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- AlloydbomniUser List<GetConfigs Alloydbomni Alloydbomni User Config> 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Alloydbomnis
List<GetAlloydbomni Alloydbomni> 
- Values provided by the AlloyDB Omni server.
- CloudName string
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- Components
List<GetAlloydbomni Component> 
- Service component information objects
- DiskSpace string
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- DiskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- DiskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- DiskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- DiskSpace stringUsed 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- Id string
- The provider-assigned unique ID for this managed resource.
- MaintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- MaintenanceWindow boolEnabled 
- Indicates whether the maintenance window is currently enabled for this service.
- MaintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ProjectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- ServiceAccount stringCredentials 
- Your Google service account key in JSON format.
- ServiceHost string
- The hostname of the service.
- ServiceIntegrations List<GetAlloydbomni Service Integration> 
- Service integrations to specify when creating a service. Not applied after initial service creation
- ServiceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- ServicePassword string
- Password used for connecting to the service, if applicable
- ServicePort int
- The port of the service
- ServiceType string
- Aiven internal service type code
- ServiceUri string
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- ServiceUsername string
- Username used for connecting to the service, if applicable
- State string
- StaticIps List<string>
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
List<GetAlloydbomni Tag> 
- Tags are key-value pairs that allow you to categorize services.
- TechEmails List<GetAlloydbomni Tech Email> 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- TerminationProtection bool
- Prevents the service from being deleted. It is recommended to set this to truefor 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.
- AdditionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- AlloydbomniUser []GetConfigs Alloydbomni Alloydbomni User Config 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Alloydbomnis
[]GetAlloydbomni Alloydbomni 
- Values provided by the AlloyDB Omni server.
- CloudName string
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- Components
[]GetAlloydbomni Component 
- Service component information objects
- DiskSpace string
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- DiskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- DiskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- DiskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- DiskSpace stringUsed 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- Id string
- The provider-assigned unique ID for this managed resource.
- MaintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- MaintenanceWindow boolEnabled 
- Indicates whether the maintenance window is currently enabled for this service.
- MaintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ProjectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- ServiceAccount stringCredentials 
- Your Google service account key in JSON format.
- ServiceHost string
- The hostname of the service.
- ServiceIntegrations []GetAlloydbomni Service Integration 
- Service integrations to specify when creating a service. Not applied after initial service creation
- ServiceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- ServicePassword string
- Password used for connecting to the service, if applicable
- ServicePort int
- The port of the service
- ServiceType string
- Aiven internal service type code
- ServiceUri string
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- ServiceUsername string
- Username used for connecting to the service, if applicable
- State string
- StaticIps []string
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
[]GetAlloydbomni Tag 
- Tags are key-value pairs that allow you to categorize services.
- TechEmails []GetAlloydbomni Tech Email 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- TerminationProtection bool
- Prevents the service from being deleted. It is recommended to set this to truefor 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.
- additionalDisk StringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- alloydbomniUser List<GetConfigs Alloydbomni Alloydbomni User Config> 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- alloydbomnis
List<GetAlloydbomni Alloydbomni> 
- Values provided by the AlloyDB Omni server.
- cloudName String
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- components
List<GetAlloydbomni Component> 
- Service component information objects
- diskSpace String
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- diskSpace StringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace StringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace StringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace StringUsed 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- id String
- The provider-assigned unique ID for this managed resource.
- maintenanceWindow StringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow BooleanEnabled 
- Indicates whether the maintenance window is currently enabled for this service.
- maintenanceWindow StringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc StringId 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- serviceAccount StringCredentials 
- Your Google service account key in JSON format.
- serviceHost String
- The hostname of the service.
- serviceIntegrations List<GetAlloydbomni Service Integration> 
- Service integrations to specify when creating a service. Not applied after initial service creation
- serviceName String
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- servicePassword String
- Password used for connecting to the service, if applicable
- servicePort Integer
- The port of the service
- serviceType String
- Aiven internal service type code
- serviceUri String
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- serviceUsername String
- Username used for connecting to the service, if applicable
- state String
- staticIps List<String>
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
List<GetAlloydbomni Tag> 
- Tags are key-value pairs that allow you to categorize services.
- techEmails List<GetAlloydbomni Tech Email> 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- terminationProtection Boolean
- Prevents the service from being deleted. It is recommended to set this to truefor 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.
- additionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- alloydbomniUser GetConfigs Alloydbomni Alloydbomni User Config[] 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- alloydbomnis
GetAlloydbomni Alloydbomni[] 
- Values provided by the AlloyDB Omni server.
- cloudName string
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- components
GetAlloydbomni Component[] 
- Service component information objects
- diskSpace string
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- diskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace stringUsed 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- id string
- The provider-assigned unique ID for this managed resource.
- maintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow booleanEnabled 
- Indicates whether the maintenance window is currently enabled for this service.
- maintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- serviceAccount stringCredentials 
- Your Google service account key in JSON format.
- serviceHost string
- The hostname of the service.
- serviceIntegrations GetAlloydbomni Service Integration[] 
- Service integrations to specify when creating a service. Not applied after initial service creation
- serviceName string
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- servicePassword string
- Password used for connecting to the service, if applicable
- servicePort number
- The port of the service
- serviceType string
- Aiven internal service type code
- serviceUri string
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- serviceUsername string
- Username used for connecting to the service, if applicable
- state string
- staticIps string[]
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
GetAlloydbomni Tag[] 
- Tags are key-value pairs that allow you to categorize services.
- techEmails GetAlloydbomni Tech Email[] 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- terminationProtection boolean
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional_disk_ strspace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- alloydbomni_user_ Sequence[Getconfigs Alloydbomni Alloydbomni User Config] 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- alloydbomnis
Sequence[GetAlloydbomni Alloydbomni] 
- Values provided by the AlloyDB Omni server.
- cloud_name str
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- components
Sequence[GetAlloydbomni Component] 
- Service component information objects
- disk_space str
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- disk_space_ strcap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_space_ strdefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- disk_space_ strstep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- disk_space_ strused 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- id str
- The provider-assigned unique ID for this managed resource.
- maintenance_window_ strdow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_window_ boolenabled 
- Indicates whether the maintenance window is currently enabled for this service.
- maintenance_window_ strtime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- project_vpc_ strid 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service_account_ strcredentials 
- Your Google service account key in JSON format.
- service_host str
- The hostname of the service.
- service_integrations Sequence[GetAlloydbomni Service Integration] 
- Service integrations to specify when creating a service. Not applied after initial service creation
- service_name str
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_password str
- Password used for connecting to the service, if applicable
- service_port int
- The port of the service
- service_type str
- Aiven internal service type code
- service_uri str
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_username str
- Username used for connecting to the service, if applicable
- state str
- static_ips Sequence[str]
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
Sequence[GetAlloydbomni Tag] 
- Tags are key-value pairs that allow you to categorize services.
- tech_emails Sequence[GetAlloydbomni Tech Email] 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- termination_protection bool
- Prevents the service from being deleted. It is recommended to set this to truefor 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.
- additionalDisk StringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- alloydbomniUser List<Property Map>Configs 
- Alloydbomni user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- alloydbomnis List<Property Map>
- Values provided by the AlloyDB Omni server.
- cloudName String
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- components List<Property Map>
- Service component information objects
- diskSpace String
- Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. Please use additional_disk_spaceto specify the space to be added to the default disk space defined by the plan.
- diskSpace StringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace StringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace StringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace StringUsed 
- The disk space that the service is currently using. This is the sum of disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB).
- id String
- The provider-assigned unique ID for this managed resource.
- maintenanceWindow StringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow BooleanEnabled 
- Indicates whether the maintenance window is currently enabled for this service.
- maintenanceWindow StringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- 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-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc StringId 
- Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. When set, the value should be given as a reference to set up dependencies correctly, and the VPC must be in the same cloud and region as the service itself. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- serviceAccount StringCredentials 
- Your Google service account key in JSON format.
- serviceHost String
- The hostname of the service.
- serviceIntegrations List<Property Map>
- Service integrations to specify when creating a service. Not applied after initial service creation
- serviceName String
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- servicePassword String
- Password used for connecting to the service, if applicable
- servicePort Number
- The port of the service
- serviceType String
- Aiven internal service type code
- serviceUri String
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- serviceUsername String
- Username used for connecting to the service, if applicable
- state String
- staticIps List<String>
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- techEmails List<Property Map>
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- terminationProtection Boolean
- Prevents the service from being deleted. It is recommended to set this to truefor 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
GetAlloydbomniAlloydbomni  
- Bouncer string
- PgBouncer connection details for connection pooling.
- Dbname string
- Primary AlloyDB Omni database name.
- Host string
- AlloyDB Omni primary node host IP or name.
- MaxConnections int
- The number of allowed connections. Varies based on the service plan.
- Params
List<GetAlloydbomni Alloydbomni Param> 
- AlloyDB Omni connection parameters.
- Password string
- AlloyDB Omni admin user password.
- Port int
- AlloyDB Omni port.
- ReplicaUri string
- AlloyDB Omni replica URI for services with a replica.
- Sslmode string
- AlloyDB Omni SSL mode setting.
- StandbyUris List<string>
- AlloyDB Omni standby connection URIs.
- SyncingUris List<string>
- AlloyDB Omni syncing connection URIs.
- Uri string
- AlloyDB Omni primary connection URI.
- Uris List<string>
- AlloyDB Omni primary connection URIs.
- User string
- AlloyDB Omni admin user name.
- Bouncer string
- PgBouncer connection details for connection pooling.
- Dbname string
- Primary AlloyDB Omni database name.
- Host string
- AlloyDB Omni primary node host IP or name.
- MaxConnections int
- The number of allowed connections. Varies based on the service plan.
- Params
[]GetAlloydbomni Alloydbomni Param 
- AlloyDB Omni connection parameters.
- Password string
- AlloyDB Omni admin user password.
- Port int
- AlloyDB Omni port.
- ReplicaUri string
- AlloyDB Omni replica URI for services with a replica.
- Sslmode string
- AlloyDB Omni SSL mode setting.
- StandbyUris []string
- AlloyDB Omni standby connection URIs.
- SyncingUris []string
- AlloyDB Omni syncing connection URIs.
- Uri string
- AlloyDB Omni primary connection URI.
- Uris []string
- AlloyDB Omni primary connection URIs.
- User string
- AlloyDB Omni admin user name.
- bouncer String
- PgBouncer connection details for connection pooling.
- dbname String
- Primary AlloyDB Omni database name.
- host String
- AlloyDB Omni primary node host IP or name.
- maxConnections Integer
- The number of allowed connections. Varies based on the service plan.
- params
List<GetAlloydbomni Alloydbomni Param> 
- AlloyDB Omni connection parameters.
- password String
- AlloyDB Omni admin user password.
- port Integer
- AlloyDB Omni port.
- replicaUri String
- AlloyDB Omni replica URI for services with a replica.
- sslmode String
- AlloyDB Omni SSL mode setting.
- standbyUris List<String>
- AlloyDB Omni standby connection URIs.
- syncingUris List<String>
- AlloyDB Omni syncing connection URIs.
- uri String
- AlloyDB Omni primary connection URI.
- uris List<String>
- AlloyDB Omni primary connection URIs.
- user String
- AlloyDB Omni admin user name.
- bouncer string
- PgBouncer connection details for connection pooling.
- dbname string
- Primary AlloyDB Omni database name.
- host string
- AlloyDB Omni primary node host IP or name.
- maxConnections number
- The number of allowed connections. Varies based on the service plan.
- params
GetAlloydbomni Alloydbomni Param[] 
- AlloyDB Omni connection parameters.
- password string
- AlloyDB Omni admin user password.
- port number
- AlloyDB Omni port.
- replicaUri string
- AlloyDB Omni replica URI for services with a replica.
- sslmode string
- AlloyDB Omni SSL mode setting.
- standbyUris string[]
- AlloyDB Omni standby connection URIs.
- syncingUris string[]
- AlloyDB Omni syncing connection URIs.
- uri string
- AlloyDB Omni primary connection URI.
- uris string[]
- AlloyDB Omni primary connection URIs.
- user string
- AlloyDB Omni admin user name.
- bouncer str
- PgBouncer connection details for connection pooling.
- dbname str
- Primary AlloyDB Omni database name.
- host str
- AlloyDB Omni primary node host IP or name.
- max_connections int
- The number of allowed connections. Varies based on the service plan.
- params
Sequence[GetAlloydbomni Alloydbomni Param] 
- AlloyDB Omni connection parameters.
- password str
- AlloyDB Omni admin user password.
- port int
- AlloyDB Omni port.
- replica_uri str
- AlloyDB Omni replica URI for services with a replica.
- sslmode str
- AlloyDB Omni SSL mode setting.
- standby_uris Sequence[str]
- AlloyDB Omni standby connection URIs.
- syncing_uris Sequence[str]
- AlloyDB Omni syncing connection URIs.
- uri str
- AlloyDB Omni primary connection URI.
- uris Sequence[str]
- AlloyDB Omni primary connection URIs.
- user str
- AlloyDB Omni admin user name.
- bouncer String
- PgBouncer connection details for connection pooling.
- dbname String
- Primary AlloyDB Omni database name.
- host String
- AlloyDB Omni primary node host IP or name.
- maxConnections Number
- The number of allowed connections. Varies based on the service plan.
- params List<Property Map>
- AlloyDB Omni connection parameters.
- password String
- AlloyDB Omni admin user password.
- port Number
- AlloyDB Omni port.
- replicaUri String
- AlloyDB Omni replica URI for services with a replica.
- sslmode String
- AlloyDB Omni SSL mode setting.
- standbyUris List<String>
- AlloyDB Omni standby connection URIs.
- syncingUris List<String>
- AlloyDB Omni syncing connection URIs.
- uri String
- AlloyDB Omni primary connection URI.
- uris List<String>
- AlloyDB Omni primary connection URIs.
- user String
- AlloyDB Omni admin user name.
GetAlloydbomniAlloydbomniParam   
GetAlloydbomniAlloydbomniUserConfig    
- AdditionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- AdminPassword string
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- AdminUsername string
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- AlloydbomniVersion string
- Enum: 15, and newer. PostgreSQL major version.
- BackupHour int
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- BackupMinute int
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- EnableIpv6 bool
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- GoogleColumnar boolEngine Enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- GoogleColumnar intEngine Memory Size Percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- IpFilter List<GetObjects Alloydbomni Alloydbomni User Config Ip Filter Object> 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- IpFilter List<string>Strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- IpFilters List<string>
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- NodeCount int
- Number of nodes for the service. Example: 3.
- Pg
GetAlloydbomni Alloydbomni User Config Pg 
- postgresql.conf configuration values
- PgRead boolReplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- PgService stringTo Fork From 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- PgVersion string
- Enum: 15, and newer. PostgreSQL major version.
- Pgaudit
GetAlloydbomni Alloydbomni User Config Pgaudit 
- System-wide settings for the pgaudit extension
- Pgbouncer
GetAlloydbomni Alloydbomni User Config Pgbouncer 
- PGBouncer connection pooling settings
- Pglookout
GetAlloydbomni Alloydbomni User Config Pglookout 
- System-wide settings for pglookout
- PrivateAccess GetAlloydbomni Alloydbomni User Config Private Access 
- Allow access to selected service ports from private networks
- PrivatelinkAccess GetAlloydbomni Alloydbomni User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- ProjectTo stringFork From 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- PublicAccess GetAlloydbomni Alloydbomni User Config Public Access 
- Allow access to selected service ports from the public Internet
- RecoveryTarget stringTime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- ServiceLog bool
- Store logs for the service so that they are available in the HTTP API and console.
- ServiceTo stringFork From 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- StaticIps bool
- Use static public IP addresses.
- SynchronousReplication string
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- Variant string
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- WorkMem int
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
- AdditionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- AdminPassword string
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- AdminUsername string
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- AlloydbomniVersion string
- Enum: 15, and newer. PostgreSQL major version.
- BackupHour int
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- BackupMinute int
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- EnableIpv6 bool
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- GoogleColumnar boolEngine Enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- GoogleColumnar intEngine Memory Size Percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- IpFilter []GetObjects Alloydbomni Alloydbomni User Config Ip Filter Object 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- IpFilter []stringStrings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- IpFilters []string
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- NodeCount int
- Number of nodes for the service. Example: 3.
- Pg
GetAlloydbomni Alloydbomni User Config Pg 
- postgresql.conf configuration values
- PgRead boolReplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- PgService stringTo Fork From 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- PgVersion string
- Enum: 15, and newer. PostgreSQL major version.
- Pgaudit
GetAlloydbomni Alloydbomni User Config Pgaudit 
- System-wide settings for the pgaudit extension
- Pgbouncer
GetAlloydbomni Alloydbomni User Config Pgbouncer 
- PGBouncer connection pooling settings
- Pglookout
GetAlloydbomni Alloydbomni User Config Pglookout 
- System-wide settings for pglookout
- PrivateAccess GetAlloydbomni Alloydbomni User Config Private Access 
- Allow access to selected service ports from private networks
- PrivatelinkAccess GetAlloydbomni Alloydbomni User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- ProjectTo stringFork From 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- PublicAccess GetAlloydbomni Alloydbomni User Config Public Access 
- Allow access to selected service ports from the public Internet
- RecoveryTarget stringTime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- ServiceLog bool
- Store logs for the service so that they are available in the HTTP API and console.
- ServiceTo stringFork From 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- float64
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- StaticIps bool
- Use static public IP addresses.
- SynchronousReplication string
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- Variant string
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- WorkMem int
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
- additionalBackup StringRegions 
- Additional Cloud Regions for Backup Replication.
- adminPassword String
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- adminUsername String
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- alloydbomniVersion String
- Enum: 15, and newer. PostgreSQL major version.
- backupHour Integer
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- backupMinute Integer
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- enableIpv6 Boolean
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- googleColumnar BooleanEngine Enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- googleColumnar IntegerEngine Memory Size Percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- ipFilter List<GetObjects Alloydbomni Alloydbomni User Config Ip Filter Object> 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter List<String>Strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- ipFilters List<String>
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- nodeCount Integer
- Number of nodes for the service. Example: 3.
- pg
GetAlloydbomni Alloydbomni User Config Pg 
- postgresql.conf configuration values
- pgRead BooleanReplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- pgService StringTo Fork From 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- pgVersion String
- Enum: 15, and newer. PostgreSQL major version.
- pgaudit
GetAlloydbomni Alloydbomni User Config Pgaudit 
- System-wide settings for the pgaudit extension
- pgbouncer
GetAlloydbomni Alloydbomni User Config Pgbouncer 
- PGBouncer connection pooling settings
- pglookout
GetAlloydbomni Alloydbomni User Config Pglookout 
- System-wide settings for pglookout
- privateAccess GetAlloydbomni Alloydbomni User Config Private Access 
- Allow access to selected service ports from private networks
- privatelinkAccess GetAlloydbomni Alloydbomni User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- projectTo StringFork From 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- publicAccess GetAlloydbomni Alloydbomni User Config Public Access 
- Allow access to selected service ports from the public Internet
- recoveryTarget StringTime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- serviceLog Boolean
- Store logs for the service so that they are available in the HTTP API and console.
- serviceTo StringFork From 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- Double
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- staticIps Boolean
- Use static public IP addresses.
- synchronousReplication String
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- variant String
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- workMem Integer
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
- additionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- adminPassword string
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- adminUsername string
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- alloydbomniVersion string
- Enum: 15, and newer. PostgreSQL major version.
- backupHour number
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- backupMinute number
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- enableIpv6 boolean
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- googleColumnar booleanEngine Enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- googleColumnar numberEngine Memory Size Percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- ipFilter GetObjects Alloydbomni Alloydbomni User Config Ip Filter Object[] 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter string[]Strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- ipFilters string[]
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- nodeCount number
- Number of nodes for the service. Example: 3.
- pg
GetAlloydbomni Alloydbomni User Config Pg 
- postgresql.conf configuration values
- pgRead booleanReplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- pgService stringTo Fork From 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- pgVersion string
- Enum: 15, and newer. PostgreSQL major version.
- pgaudit
GetAlloydbomni Alloydbomni User Config Pgaudit 
- System-wide settings for the pgaudit extension
- pgbouncer
GetAlloydbomni Alloydbomni User Config Pgbouncer 
- PGBouncer connection pooling settings
- pglookout
GetAlloydbomni Alloydbomni User Config Pglookout 
- System-wide settings for pglookout
- privateAccess GetAlloydbomni Alloydbomni User Config Private Access 
- Allow access to selected service ports from private networks
- privatelinkAccess GetAlloydbomni Alloydbomni User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- projectTo stringFork From 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- publicAccess GetAlloydbomni Alloydbomni User Config Public Access 
- Allow access to selected service ports from the public Internet
- recoveryTarget stringTime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- serviceLog boolean
- Store logs for the service so that they are available in the HTTP API and console.
- serviceTo stringFork From 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- staticIps boolean
- Use static public IP addresses.
- synchronousReplication string
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- variant string
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- workMem number
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
- additional_backup_ strregions 
- Additional Cloud Regions for Backup Replication.
- admin_password str
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- admin_username str
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- alloydbomni_version str
- Enum: 15, and newer. PostgreSQL major version.
- backup_hour int
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- backup_minute int
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- enable_ipv6 bool
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- google_columnar_ boolengine_ enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- google_columnar_ intengine_ memory_ size_ percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- ip_filter_ Sequence[Getobjects Alloydbomni Alloydbomni User Config Ip Filter Object] 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ip_filter_ Sequence[str]strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- ip_filters Sequence[str]
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- node_count int
- Number of nodes for the service. Example: 3.
- pg
GetAlloydbomni Alloydbomni User Config Pg 
- postgresql.conf configuration values
- pg_read_ boolreplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- pg_service_ strto_ fork_ from 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- pg_version str
- Enum: 15, and newer. PostgreSQL major version.
- pgaudit
GetAlloydbomni Alloydbomni User Config Pgaudit 
- System-wide settings for the pgaudit extension
- pgbouncer
GetAlloydbomni Alloydbomni User Config Pgbouncer 
- PGBouncer connection pooling settings
- pglookout
GetAlloydbomni Alloydbomni User Config Pglookout 
- System-wide settings for pglookout
- private_access GetAlloydbomni Alloydbomni User Config Private Access 
- Allow access to selected service ports from private networks
- privatelink_access GetAlloydbomni Alloydbomni User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- project_to_ strfork_ from 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- public_access GetAlloydbomni Alloydbomni User Config Public Access 
- Allow access to selected service ports from the public Internet
- recovery_target_ strtime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- service_log bool
- Store logs for the service so that they are available in the HTTP API and console.
- service_to_ strfork_ from 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- float
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- static_ips bool
- Use static public IP addresses.
- synchronous_replication str
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- variant str
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- work_mem int
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
- additionalBackup StringRegions 
- Additional Cloud Regions for Backup Replication.
- adminPassword String
- Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
- adminUsername String
- Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
- alloydbomniVersion String
- Enum: 15, and newer. PostgreSQL major version.
- backupHour Number
- The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
- backupMinute Number
- The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
- enableIpv6 Boolean
- Register AAAA DNS records for the service, and allow IPv6 packets to service ports.
- googleColumnar BooleanEngine Enabled 
- Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
- googleColumnar NumberEngine Memory Size Percentage 
- Allocate the amount of RAM to store columnar data. Default: 10.
- ipFilter List<Property Map>Objects 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter List<String>Strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- ipFilters List<String>
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- nodeCount Number
- Number of nodes for the service. Example: 3.
- pg Property Map
- postgresql.conf configuration values
- pgRead BooleanReplica 
- Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
- pgService StringTo Fork From 
- Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
- pgVersion String
- Enum: 15, and newer. PostgreSQL major version.
- pgaudit Property Map
- System-wide settings for the pgaudit extension
- pgbouncer Property Map
- PGBouncer connection pooling settings
- pglookout Property Map
- System-wide settings for pglookout
- privateAccess Property Map
- Allow access to selected service ports from private networks
- privatelinkAccess Property Map
- Allow access to selected service components through Privatelink
- projectTo StringFork From 
- Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
- publicAccess Property Map
- Allow access to selected service ports from the public Internet
- recoveryTarget StringTime 
- Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
- serviceLog Boolean
- Store logs for the service so that they are available in the HTTP API and console.
- serviceTo StringFork From 
- Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
- Number
- Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart. Example: 41.5.
- staticIps Boolean
- Use static public IP addresses.
- synchronousReplication String
- Enum: off,quorum. Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- variant String
- Enum: aiven,timescale. Variant of the PostgreSQL service, may affect the features that are exposed by default.
- workMem Number
- Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
GetAlloydbomniAlloydbomniUserConfigIpFilterObject       
- Network string
- CIDR address block. Example: 10.20.0.0/16.
- Description string
- Description for IP filter list entry. Example: Production service IP range.
- Network string
- CIDR address block. Example: 10.20.0.0/16.
- Description string
- Description for IP filter list entry. Example: Production service IP range.
- network String
- CIDR address block. Example: 10.20.0.0/16.
- description String
- Description for IP filter list entry. Example: Production service IP range.
- network string
- CIDR address block. Example: 10.20.0.0/16.
- description string
- Description for IP filter list entry. Example: Production service IP range.
- network str
- CIDR address block. Example: 10.20.0.0/16.
- description str
- Description for IP filter list entry. Example: Production service IP range.
- network String
- CIDR address block. Example: 10.20.0.0/16.
- description String
- Description for IP filter list entry. Example: Production service IP range.
GetAlloydbomniAlloydbomniUserConfigPg     
- AutovacuumAnalyze doubleScale Factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- AutovacuumNaptime int
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- AutovacuumVacuum doubleScale Factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- BgwriterDelay int
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- BgwriterFlush intAfter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- BgwriterLru intMaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- BgwriterLru doubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- DeadlockTimeout int
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- DefaultToast stringCompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds.
- Jit bool
- Controls system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- LogError stringVerbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- LogLine stringPrefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- LogTemp intFiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- MaxSlot intWal Keep Size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- MaxStack intDepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- MaxSync intWorkers Per Subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- PasswordEncryption string
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- PgPartman intBgw Dot Interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- PgPartman stringBgw Dot Role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- PgStat stringStatements Dot Track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- Timezone string
- PostgreSQL service timezone. Example: Europe/Helsinki.
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- TrackCommit stringTimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- TrackFunctions string
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- TrackIo stringTiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
- AutovacuumAnalyze float64Scale Factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- AutovacuumAnalyze intThreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- AutovacuumFreeze intMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- AutovacuumMax intWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- AutovacuumNaptime int
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- AutovacuumVacuum intCost Delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- AutovacuumVacuum intCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- AutovacuumVacuum float64Scale Factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- AutovacuumVacuum intThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- BgwriterDelay int
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- BgwriterFlush intAfter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- BgwriterLru intMaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- BgwriterLru float64Multiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- DeadlockTimeout int
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- DefaultToast stringCompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- IdleIn intTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds.
- Jit bool
- Controls system-wide use of Just-in-Time Compilation (JIT).
- LogAutovacuum intMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- LogError stringVerbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- LogLine stringPrefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- LogMin intDuration Statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- LogTemp intFiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- MaxFiles intPer Process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- MaxLocks intPer Transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- MaxLogical intReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- MaxParallel intWorkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- MaxParallel intWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- MaxPred intLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- MaxPrepared intTransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- MaxReplication intSlots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- MaxSlot intWal Keep Size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- MaxStack intDepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- MaxStandby intArchive Delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- MaxStandby intStreaming Delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- MaxSync intWorkers Per Subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- MaxWal intSenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- MaxWorker intProcesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- PasswordEncryption string
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- PgPartman intBgw Dot Interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- PgPartman stringBgw Dot Role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- PgStat stringStatements Dot Track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- TempFile intLimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- Timezone string
- PostgreSQL service timezone. Example: Europe/Helsinki.
- TrackActivity intQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- TrackCommit stringTimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- TrackFunctions string
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- TrackIo stringTiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- WalSender intTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- WalWriter intDelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
- autovacuumAnalyze DoubleScale Factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumAnalyze IntegerThreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- autovacuumFreeze IntegerMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- autovacuumMax IntegerWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- autovacuumNaptime Integer
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- autovacuumVacuum IntegerCost Delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- autovacuumVacuum IntegerCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- autovacuumVacuum DoubleScale Factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumVacuum IntegerThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- bgwriterDelay Integer
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- bgwriterFlush IntegerAfter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- bgwriterLru IntegerMaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- bgwriterLru DoubleMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- deadlockTimeout Integer
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- defaultToast StringCompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- idleIn IntegerTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds.
- jit Boolean
- Controls system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum IntegerMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- logError StringVerbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- logLine StringPrefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- logMin IntegerDuration Statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- logTemp IntegerFiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- maxFiles IntegerPer Process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- maxLocks IntegerPer Transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- maxLogical IntegerReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- maxParallel IntegerWorkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- maxParallel IntegerWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- maxPred IntegerLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- maxPrepared IntegerTransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- maxReplication IntegerSlots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- maxSlot IntegerWal Keep Size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- maxStack IntegerDepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- maxStandby IntegerArchive Delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- maxStandby IntegerStreaming Delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- maxSync IntegerWorkers Per Subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- maxWal IntegerSenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- maxWorker IntegerProcesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- passwordEncryption String
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- pgPartman IntegerBgw Dot Interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- pgPartman StringBgw Dot Role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- pgStat StringStatements Dot Track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- tempFile IntegerLimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- timezone String
- PostgreSQL service timezone. Example: Europe/Helsinki.
- trackActivity IntegerQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- trackCommit StringTimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- trackFunctions String
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- trackIo StringTiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- walSender IntegerTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- walWriter IntegerDelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
- autovacuumAnalyze numberScale Factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumAnalyze numberThreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- autovacuumFreeze numberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- autovacuumMax numberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- autovacuumNaptime number
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- autovacuumVacuum numberCost Delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- autovacuumVacuum numberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- autovacuumVacuum numberScale Factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumVacuum numberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- bgwriterDelay number
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- bgwriterFlush numberAfter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- bgwriterLru numberMaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- bgwriterLru numberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- deadlockTimeout number
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- defaultToast stringCompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- idleIn numberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds.
- jit boolean
- Controls system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum numberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- logError stringVerbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- logLine stringPrefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- logMin numberDuration Statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- logTemp numberFiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- maxFiles numberPer Process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- maxLocks numberPer Transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- maxLogical numberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- maxParallel numberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- maxParallel numberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- maxPred numberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- maxPrepared numberTransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- maxReplication numberSlots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- maxSlot numberWal Keep Size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- maxStack numberDepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- maxStandby numberArchive Delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- maxStandby numberStreaming Delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- maxSync numberWorkers Per Subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- maxWal numberSenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- maxWorker numberProcesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- passwordEncryption string
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- pgPartman numberBgw Dot Interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- pgPartman stringBgw Dot Role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- pgStat stringStatements Dot Track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- tempFile numberLimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- timezone string
- PostgreSQL service timezone. Example: Europe/Helsinki.
- trackActivity numberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- trackCommit stringTimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- trackFunctions string
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- trackIo stringTiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- walSender numberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- walWriter numberDelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
- autovacuum_analyze_ floatscale_ factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuum_analyze_ intthreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- autovacuum_freeze_ intmax_ age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- autovacuum_max_ intworkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- autovacuum_naptime int
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- autovacuum_vacuum_ intcost_ delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- autovacuum_vacuum_ intcost_ limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- autovacuum_vacuum_ floatscale_ factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuum_vacuum_ intthreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- bgwriter_delay int
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- bgwriter_flush_ intafter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- bgwriter_lru_ intmaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- bgwriter_lru_ floatmultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- deadlock_timeout int
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- default_toast_ strcompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- idle_in_ inttransaction_ session_ timeout 
- Time out sessions with open transactions after this number of milliseconds.
- jit bool
- Controls system-wide use of Just-in-Time Compilation (JIT).
- log_autovacuum_ intmin_ duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- log_error_ strverbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- log_line_ strprefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- log_min_ intduration_ statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- log_temp_ intfiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- max_files_ intper_ process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- max_locks_ intper_ transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- max_logical_ intreplication_ workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- max_parallel_ intworkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- max_parallel_ intworkers_ per_ gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- max_pred_ intlocks_ per_ transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- max_prepared_ inttransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- max_replication_ intslots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- max_slot_ intwal_ keep_ size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- max_stack_ intdepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- max_standby_ intarchive_ delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- max_standby_ intstreaming_ delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- max_sync_ intworkers_ per_ subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- max_wal_ intsenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- max_worker_ intprocesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- password_encryption str
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- pg_partman_ intbgw_ dot_ interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- pg_partman_ strbgw_ dot_ role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- pg_stat_ strstatements_ dot_ track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- temp_file_ intlimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- timezone str
- PostgreSQL service timezone. Example: Europe/Helsinki.
- track_activity_ intquery_ size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- track_commit_ strtimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- track_functions str
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- track_io_ strtiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- wal_sender_ inttimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- wal_writer_ intdelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
- autovacuumAnalyze NumberScale Factor 
- Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumAnalyze NumberThreshold 
- Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.
- autovacuumFreeze NumberMax Age 
- Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.
- autovacuumMax NumberWorkers 
- Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.
- autovacuumNaptime Number
- Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.
- autovacuumVacuum NumberCost Delay 
- Specifies the cost delay value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_delay value will be used. The default is2(upstream default).
- autovacuumVacuum NumberCost Limit 
- Specifies the cost limit value that will be used in automatic VACUUM operations. If -1is specified, the regular vacuum_cost_limit value will be used. The default is-1(upstream default).
- autovacuumVacuum NumberScale Factor 
- Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2for 20% of the table size). The default is0.2.
- autovacuumVacuum NumberThreshold 
- Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.
- bgwriterDelay Number
- Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200. Example:200.
- bgwriterFlush NumberAfter 
- Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512. Example:512.
- bgwriterLru NumberMaxpages 
- In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100. Example:100.
- bgwriterLru NumberMultiplier 
- The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example:2.
- deadlockTimeout Number
- This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000(upstream default). Example:1000.
- defaultToast StringCompression 
- Enum: lz4,pglz. Specifies the default TOAST compression method for values of compressible columns. The default islz4.
- idleIn NumberTransaction Session Timeout 
- Time out sessions with open transactions after this number of milliseconds.
- jit Boolean
- Controls system-wide use of Just-in-Time Compilation (JIT).
- logAutovacuum NumberMin Duration 
- Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.
- logError StringVerbosity 
- Enum: DEFAULT,TERSE,VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
- logLine StringPrefix 
- Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ','%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h ','pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
- logMin NumberDuration Statement 
- Log statements that take more than this number of milliseconds to run, -1 disables.
- logTemp NumberFiles 
- Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
- maxFiles NumberPer Process 
- PostgreSQL maximum number of files that can be open per process. The default is 1000(upstream default). Changing this parameter causes a service restart.
- maxLocks NumberPer Transaction 
- PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.
- maxLogical NumberReplication Workers 
- PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4(upstream default). Changing this parameter causes a service restart.
- maxParallel NumberWorkers 
- Sets the maximum number of workers that the system can support for parallel queries. The default is 8(upstream default).
- maxParallel NumberWorkers Per Gather 
- Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2(upstream default).
- maxPred NumberLocks Per Transaction 
- PostgreSQL maximum predicate locks per transaction. The default is 64(upstream default). Changing this parameter causes a service restart.
- maxPrepared NumberTransactions 
- PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.
- maxReplication NumberSlots 
- PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.
- maxSlot NumberWal Keep Size 
- PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1is specified, replication slots may retain an unlimited amount of WAL files. The default is-1(upstream default). wal_keep_size minimum WAL size setting takes precedence over this.
- maxStack NumberDepth 
- Maximum depth of the stack in bytes. The default is 2097152(upstream default).
- maxStandby NumberArchive Delay 
- Max standby archive delay in milliseconds. The default is 30000(upstream default).
- maxStandby NumberStreaming Delay 
- Max standby streaming delay in milliseconds. The default is 30000(upstream default).
- maxSync NumberWorkers Per Subscription 
- Maximum number of synchronization workers per subscription. The default is 2.
- maxWal NumberSenders 
- PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.
- maxWorker NumberProcesses 
- Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.
- passwordEncryption String
- Enum: md5,scram-sha-256. Chooses the algorithm for encrypting passwords.
- pgPartman NumberBgw Dot Interval 
- Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600. Example:3600.
- pgPartman StringBgw Dot Role 
- Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
- pgStat StringStatements Dot Track 
- Enum: all,none,top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default istop.
- tempFile NumberLimit 
- PostgreSQL temporary file limit in KiB, -1 for unlimited.
- timezone String
- PostgreSQL service timezone. Example: Europe/Helsinki.
- trackActivity NumberQuery Size 
- Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart. Example: 1024.
- trackCommit StringTimestamp 
- Enum: off,on. Record commit time of transactions. Changing this parameter causes a service restart.
- trackFunctions String
- Enum: all,none,pl. Enables tracking of function call counts and time used.
- trackIo StringTiming 
- Enum: off,on. Enables timing of database I/O calls. The default isoff. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- walSender NumberTimeout 
- Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
- walWriter NumberDelay 
- WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance. Example:50.
GetAlloydbomniAlloydbomniUserConfigPgaudit     
- FeatureEnabled bool
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- LogCatalog bool
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- LogClient bool
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- LogLevel string
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- LogMax intString Length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- LogNested boolStatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- LogParameter bool
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- LogParameter intMax Size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- LogRelation bool
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- LogRows bool
- Log Rows. Default: false.
- LogStatement bool
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- LogStatement boolOnce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- Logs List<string>
- Specifies which classes of statements will be logged by session audit logging.
- Role string
- Specifies the master role to use for object audit logging.
- FeatureEnabled bool
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- LogCatalog bool
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- LogClient bool
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- LogLevel string
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- LogMax intString Length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- LogNested boolStatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- LogParameter bool
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- LogParameter intMax Size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- LogRelation bool
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- LogRows bool
- Log Rows. Default: false.
- LogStatement bool
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- LogStatement boolOnce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- Logs []string
- Specifies which classes of statements will be logged by session audit logging.
- Role string
- Specifies the master role to use for object audit logging.
- featureEnabled Boolean
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- logCatalog Boolean
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- logClient Boolean
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- logLevel String
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- logMax IntegerString Length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- logNested BooleanStatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- logParameter Boolean
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- logParameter IntegerMax Size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- logRelation Boolean
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- logRows Boolean
- Log Rows. Default: false.
- logStatement Boolean
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- logStatement BooleanOnce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- logs List<String>
- Specifies which classes of statements will be logged by session audit logging.
- role String
- Specifies the master role to use for object audit logging.
- featureEnabled boolean
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- logCatalog boolean
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- logClient boolean
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- logLevel string
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- logMax numberString Length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- logNested booleanStatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- logParameter boolean
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- logParameter numberMax Size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- logRelation boolean
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- logRows boolean
- Log Rows. Default: false.
- logStatement boolean
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- logStatement booleanOnce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- logs string[]
- Specifies which classes of statements will be logged by session audit logging.
- role string
- Specifies the master role to use for object audit logging.
- feature_enabled bool
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- log_catalog bool
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- log_client bool
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- log_level str
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- log_max_ intstring_ length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- log_nested_ boolstatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- log_parameter bool
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- log_parameter_ intmax_ size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- log_relation bool
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- log_rows bool
- Log Rows. Default: false.
- log_statement bool
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- log_statement_ boolonce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- logs Sequence[str]
- Specifies which classes of statements will be logged by session audit logging.
- role str
- Specifies the master role to use for object audit logging.
- featureEnabled Boolean
- Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved. Default: false.
- logCatalog Boolean
- Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Default: true.
- logClient Boolean
- Specifies whether log messages will be visible to a client process such as psql. Default: false.
- logLevel String
- Enum: debug1,debug2,debug3,debug4,debug5,info,log,notice,warning. Specifies the log level that will be used for log entries. Default:log.
- logMax NumberString Length 
- Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation. Default: -1.
- logNested BooleanStatements 
- This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun. Default: true.
- logParameter Boolean
- Specifies that audit logging should include the parameters that were passed with the statement. Default: false.
- logParameter NumberMax Size 
- Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with . Default: 0.
- logRelation Boolean
- Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement. Default: false.
- logRows Boolean
- Log Rows. Default: false.
- logStatement Boolean
- Specifies whether logging will include the statement text and parameters (if enabled). Default: true.
- logStatement BooleanOnce 
- Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Default: false.
- logs List<String>
- Specifies which classes of statements will be logged by session audit logging.
- role String
- Specifies the master role to use for object audit logging.
GetAlloydbomniAlloydbomniUserConfigPgbouncer     
- AutodbIdle intTimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- AutodbMax intDb Connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- AutodbPool stringMode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- AutodbPool intSize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- IgnoreStartup List<string>Parameters 
- List of parameters to ignore when given in startup packet.
- MaxPrepared intStatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- MinPool intSize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- ServerIdle intTimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- ServerLifetime int
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- ServerReset boolQuery Always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
- AutodbIdle intTimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- AutodbMax intDb Connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- AutodbPool stringMode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- AutodbPool intSize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- IgnoreStartup []stringParameters 
- List of parameters to ignore when given in startup packet.
- MaxPrepared intStatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- MinPool intSize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- ServerIdle intTimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- ServerLifetime int
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- ServerReset boolQuery Always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
- autodbIdle IntegerTimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- autodbMax IntegerDb Connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- autodbPool StringMode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- autodbPool IntegerSize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- ignoreStartup List<String>Parameters 
- List of parameters to ignore when given in startup packet.
- maxPrepared IntegerStatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- minPool IntegerSize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- serverIdle IntegerTimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- serverLifetime Integer
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- serverReset BooleanQuery Always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
- autodbIdle numberTimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- autodbMax numberDb Connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- autodbPool stringMode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- autodbPool numberSize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- ignoreStartup string[]Parameters 
- List of parameters to ignore when given in startup packet.
- maxPrepared numberStatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- minPool numberSize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- serverIdle numberTimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- serverLifetime number
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- serverReset booleanQuery Always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
- autodb_idle_ inttimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- autodb_max_ intdb_ connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- autodb_pool_ strmode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- autodb_pool_ intsize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- ignore_startup_ Sequence[str]parameters 
- List of parameters to ignore when given in startup packet.
- max_prepared_ intstatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- min_pool_ intsize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- server_idle_ inttimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- server_lifetime int
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- server_reset_ boolquery_ always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
- autodbIdle NumberTimeout 
- If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds). Default: 3600.
- autodbMax NumberDb Connections 
- Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited. Example: 0.
- autodbPool StringMode 
- Enum: session,statement,transaction. PGBouncer pool mode. Default:transaction.
- autodbPool NumberSize 
- If non-zero then create automatically a pool of that size per user when a pool doesn't exist. Default: 0.
- ignoreStartup List<String>Parameters 
- List of parameters to ignore when given in startup packet.
- maxPrepared NumberStatements 
- PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. Default: 100.
- minPool NumberSize 
- Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. Default: 0.
- serverIdle NumberTimeout 
- If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds). Default: 600.
- serverLifetime Number
- The pooler will close an unused server connection that has been connected longer than this. (seconds). Default: 3600.
- serverReset BooleanQuery Always 
- Run server_reset_query (DISCARD ALL) in all pooling modes. Default: false.
GetAlloydbomniAlloydbomniUserConfigPglookout     
- MaxFailover intReplication Time Lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
- MaxFailover intReplication Time Lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
- maxFailover IntegerReplication Time Lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
- maxFailover numberReplication Time Lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
- max_failover_ intreplication_ time_ lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
- maxFailover NumberReplication Time Lag 
- Number of seconds of master unavailability before triggering database failover to standby. Default: 60.
GetAlloydbomniAlloydbomniUserConfigPrivateAccess      
- Pg bool
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Pgbouncer bool
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Pg bool
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Pgbouncer bool
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pg Boolean
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pgbouncer Boolean
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus Boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pg boolean
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pgbouncer boolean
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pg bool
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pgbouncer bool
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pg Boolean
- Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- pgbouncer Boolean
- Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus Boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess      
- Pg bool
- Enable pg.
- Pgbouncer bool
- Enable pgbouncer.
- Prometheus bool
- Enable prometheus.
- Pg bool
- Enable pg.
- Pgbouncer bool
- Enable pgbouncer.
- Prometheus bool
- Enable prometheus.
- pg Boolean
- Enable pg.
- pgbouncer Boolean
- Enable pgbouncer.
- prometheus Boolean
- Enable prometheus.
- pg boolean
- Enable pg.
- pgbouncer boolean
- Enable pgbouncer.
- prometheus boolean
- Enable prometheus.
- pg bool
- Enable pg.
- pgbouncer bool
- Enable pgbouncer.
- prometheus bool
- Enable prometheus.
- pg Boolean
- Enable pg.
- pgbouncer Boolean
- Enable pgbouncer.
- prometheus Boolean
- Enable prometheus.
GetAlloydbomniAlloydbomniUserConfigPublicAccess      
- Pg bool
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- Pgbouncer bool
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- Prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- Pg bool
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- Pgbouncer bool
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- Prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- pg Boolean
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- pgbouncer Boolean
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus Boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- pg boolean
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- pgbouncer boolean
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- pg bool
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- pgbouncer bool
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- pg Boolean
- Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network.
- pgbouncer Boolean
- Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus Boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
GetAlloydbomniComponent  
- Component string
- Service component name
- ConnectionUri string
- Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- KafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- KafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- Component string
- Service component name
- ConnectionUri string
- Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- KafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- KafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- component String
- Service component name
- connectionUri String
- Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafkaAuthentication StringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl StringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port Integer
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
- component string
- Service component name
- connectionUri string
- Connection info for connecting to the service component. This is a combination of host and port.
- host string
- Host name for connecting to the service component
- kafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port number
- Port number for connecting to the service component
- route string
- Network access route
- ssl boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage string
- DNS usage name
- component str
- Service component name
- connection_uri str
- Connection info for connecting to the service component. This is a combination of host and port.
- host str
- Host name for connecting to the service component
- kafka_authentication_ strmethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka_ssl_ strca 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port int
- Port number for connecting to the service component
- route str
- Network access route
- ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage str
- DNS usage name
- component String
- Service component name
- connectionUri String
- Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafkaAuthentication StringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl StringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port Number
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
GetAlloydbomniServiceIntegration   
- IntegrationType string
- Type of the service integration. The possible value is read_replica.
- SourceService stringName 
- Name of the source service
- IntegrationType string
- Type of the service integration. The possible value is read_replica.
- SourceService stringName 
- Name of the source service
- integrationType String
- Type of the service integration. The possible value is read_replica.
- sourceService StringName 
- Name of the source service
- integrationType string
- Type of the service integration. The possible value is read_replica.
- sourceService stringName 
- Name of the source service
- integration_type str
- Type of the service integration. The possible value is read_replica.
- source_service_ strname 
- Name of the source service
- integrationType String
- Type of the service integration. The possible value is read_replica.
- sourceService StringName 
- Name of the source service
GetAlloydbomniTag  
GetAlloydbomniTechEmail   
- Email string
- An email address to contact for technical issues
- Email string
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
- email string
- An email address to contact for technical issues
- email str
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the aivenTerraform Provider.
