1. Packages
  2. Aiven Provider
  3. API Docs
  4. getAlloydbomni
Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi

aiven.getAlloydbomni

Explore with Pulumi AI

aiven logo
Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi

    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.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aiven:index/getAlloydbomni:getAlloydbomni
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    getAlloydbomni Result

    The following output properties are available:

    AdditionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    AlloydbomniUserConfigs List<GetAlloydbomniAlloydbomniUserConfig>
    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<GetAlloydbomniAlloydbomni>
    Values provided by the AlloyDB Omni server.
    CloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    Components List<GetAlloydbomniComponent>
    Service component information objects
    DiskSpace string
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    ServiceAccountCredentials string
    Your Google service account key in JSON format.
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations List<GetAlloydbomniServiceIntegration>
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps List<string>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    Tags List<GetAlloydbomniTag>
    Tags are key-value pairs that allow you to categorize services.
    TechEmails List<GetAlloydbomniTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    AdditionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    AlloydbomniUserConfigs []GetAlloydbomniAlloydbomniUserConfig
    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 []GetAlloydbomniAlloydbomni
    Values provided by the AlloyDB Omni server.
    CloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    Components []GetAlloydbomniComponent
    Service component information objects
    DiskSpace string
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ProjectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    ServiceAccountCredentials string
    Your Google service account key in JSON format.
    ServiceHost string
    The hostname of the service.
    ServiceIntegrations []GetAlloydbomniServiceIntegration
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps []string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    Tags []GetAlloydbomniTag
    Tags are key-value pairs that allow you to categorize services.
    TechEmails []GetAlloydbomniTechEmail
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    TerminationProtection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    additionalDiskSpace String
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    alloydbomniUserConfigs List<GetAlloydbomniAlloydbomniUserConfig>
    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<GetAlloydbomniAlloydbomni>
    Values provided by the AlloyDB Omni server.
    cloudName String
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components List<GetAlloydbomniComponent>
    Service component information objects
    diskSpace String
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    serviceAccountCredentials String
    Your Google service account key in JSON format.
    serviceHost String
    The hostname of the service.
    serviceIntegrations List<GetAlloydbomniServiceIntegration>
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    tags List<GetAlloydbomniTag>
    Tags are key-value pairs that allow you to categorize services.
    techEmails List<GetAlloydbomniTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    additionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    alloydbomniUserConfigs GetAlloydbomniAlloydbomniUserConfig[]
    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 GetAlloydbomniAlloydbomni[]
    Values provided by the AlloyDB Omni server.
    cloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components GetAlloydbomniComponent[]
    Service component information objects
    diskSpace string
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    diskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed string
    Disk space that service is currently using
    id string
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    projectVpcId string
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    serviceAccountCredentials string
    Your Google service account key in JSON format.
    serviceHost string
    The hostname of the service.
    serviceIntegrations GetAlloydbomniServiceIntegration[]
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps string[]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    tags GetAlloydbomniTag[]
    Tags are key-value pairs that allow you to categorize services.
    techEmails GetAlloydbomniTechEmail[]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    terminationProtection boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    additional_disk_space str
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    alloydbomni_user_configs Sequence[GetAlloydbomniAlloydbomniUserConfig]
    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[GetAlloydbomniAlloydbomni]
    Values provided by the AlloyDB Omni server.
    cloud_name str
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components Sequence[GetAlloydbomniComponent]
    Service component information objects
    disk_space str
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    disk_space_cap str
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    disk_space_default str
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    disk_space_step str
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    disk_space_used str
    Disk space that service is currently using
    id str
    The provider-assigned unique ID for this managed resource.
    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenance_window_time str
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan str
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project_vpc_id str
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    service_account_credentials str
    Your Google service account key in JSON format.
    service_host str
    The hostname of the service.
    service_integrations Sequence[GetAlloydbomniServiceIntegration]
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    static_ips Sequence[str]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    tags Sequence[GetAlloydbomniTag]
    Tags are key-value pairs that allow you to categorize services.
    tech_emails Sequence[GetAlloydbomniTechEmail]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    termination_protection bool
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
    additionalDiskSpace String
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    alloydbomniUserConfigs List<Property Map>
    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
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components List<Property Map>
    Service component information objects
    diskSpace String
    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    projectVpcId String
    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
    serviceAccountCredentials String
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    tags List<Property Map>
    Tags are key-value pairs that allow you to categorize services.
    techEmails List<Property Map>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    terminationProtection Boolean
    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Supporting Types

    GetAlloydbomniAlloydbomni

    Bouncer string
    PgBouncer connection details for connection pooling.

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

    Dbname string
    Primary 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<GetAlloydbomniAlloydbomniParam>
    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.

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

    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 []GetAlloydbomniAlloydbomniParam
    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.

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

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

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

    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 GetAlloydbomniAlloydbomniParam[]
    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.

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

    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[GetAlloydbomniAlloydbomniParam]
    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.

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

    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

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

    GetAlloydbomniAlloydbomniUserConfig

    AdditionalBackupRegions string
    Additional Cloud Regions for Backup Replication.
    AdminPassword string
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    AdminUsername string
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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.
    GoogleColumnarEngineEnabled bool
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    GoogleColumnarEngineMemorySizePercentage int
    Allocate the amount of RAM to store columnar data. Default: 10.
    IpFilterObjects List<GetAlloydbomniAlloydbomniUserConfigIpFilterObject>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    IpFilterStrings List<string>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    IpFilters List<string>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    Pg GetAlloydbomniAlloydbomniUserConfigPg
    postgresql.conf configuration values
    PgReadReplica bool
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    PgServiceToForkFrom string
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    PgVersion string
    Enum: 15, and newer. PostgreSQL major version.
    Pgbouncer GetAlloydbomniAlloydbomniUserConfigPgbouncer
    PGBouncer connection pooling settings
    Pglookout GetAlloydbomniAlloydbomniUserConfigPglookout
    System-wide settings for pglookout
    PrivateAccess GetAlloydbomniAlloydbomniUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    PublicAccess GetAlloydbomniAlloydbomniUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryTargetTime string
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    ServiceLog bool
    Store logs for the service so that they are available in the HTTP API and console.
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    SharedBuffersPercentage double
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
    AdditionalBackupRegions string
    Additional Cloud Regions for Backup Replication.
    AdminPassword string
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    AdminUsername string
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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.
    GoogleColumnarEngineEnabled bool
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    GoogleColumnarEngineMemorySizePercentage int
    Allocate the amount of RAM to store columnar data. Default: 10.
    IpFilterObjects []GetAlloydbomniAlloydbomniUserConfigIpFilterObject
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    IpFilterStrings []string
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    IpFilters []string
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    Pg GetAlloydbomniAlloydbomniUserConfigPg
    postgresql.conf configuration values
    PgReadReplica bool
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    PgServiceToForkFrom string
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    PgVersion string
    Enum: 15, and newer. PostgreSQL major version.
    Pgbouncer GetAlloydbomniAlloydbomniUserConfigPgbouncer
    PGBouncer connection pooling settings
    Pglookout GetAlloydbomniAlloydbomniUserConfigPglookout
    System-wide settings for pglookout
    PrivateAccess GetAlloydbomniAlloydbomniUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    PublicAccess GetAlloydbomniAlloydbomniUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryTargetTime string
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    ServiceLog bool
    Store logs for the service so that they are available in the HTTP API and console.
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    SharedBuffersPercentage float64
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
    additionalBackupRegions String
    Additional Cloud Regions for Backup Replication.
    adminPassword String
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    adminUsername String
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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.
    googleColumnarEngineEnabled Boolean
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    googleColumnarEngineMemorySizePercentage Integer
    Allocate the amount of RAM to store columnar data. Default: 10.
    ipFilterObjects List<GetAlloydbomniAlloydbomniUserConfigIpFilterObject>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    pg GetAlloydbomniAlloydbomniUserConfigPg
    postgresql.conf configuration values
    pgReadReplica Boolean
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    pgServiceToForkFrom String
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    pgVersion String
    Enum: 15, and newer. PostgreSQL major version.
    pgbouncer GetAlloydbomniAlloydbomniUserConfigPgbouncer
    PGBouncer connection pooling settings
    pglookout GetAlloydbomniAlloydbomniUserConfigPglookout
    System-wide settings for pglookout
    privateAccess GetAlloydbomniAlloydbomniUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess GetAlloydbomniAlloydbomniUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryTargetTime String
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    serviceLog Boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    sharedBuffersPercentage Double
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
    additionalBackupRegions string
    Additional Cloud Regions for Backup Replication.
    adminPassword string
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    adminUsername string
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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.
    googleColumnarEngineEnabled boolean
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    googleColumnarEngineMemorySizePercentage number
    Allocate the amount of RAM to store columnar data. Default: 10.
    ipFilterObjects GetAlloydbomniAlloydbomniUserConfigIpFilterObject[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings string[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters string[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    pg GetAlloydbomniAlloydbomniUserConfigPg
    postgresql.conf configuration values
    pgReadReplica boolean
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    pgServiceToForkFrom string
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    pgVersion string
    Enum: 15, and newer. PostgreSQL major version.
    pgbouncer GetAlloydbomniAlloydbomniUserConfigPgbouncer
    PGBouncer connection pooling settings
    pglookout GetAlloydbomniAlloydbomniUserConfigPglookout
    System-wide settings for pglookout
    privateAccess GetAlloydbomniAlloydbomniUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess GetAlloydbomniAlloydbomniUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryTargetTime string
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    serviceLog boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    sharedBuffersPercentage number
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
    additional_backup_regions str
    Additional Cloud Regions for Backup Replication.
    admin_password str
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    admin_username str
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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_engine_enabled bool
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    google_columnar_engine_memory_size_percentage int
    Allocate the amount of RAM to store columnar data. Default: 10.
    ip_filter_objects Sequence[GetAlloydbomniAlloydbomniUserConfigIpFilterObject]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ip_filter_strings Sequence[str]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ip_filters Sequence[str]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    pg GetAlloydbomniAlloydbomniUserConfigPg
    postgresql.conf configuration values
    pg_read_replica bool
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    pg_service_to_fork_from str
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    pg_version str
    Enum: 15, and newer. PostgreSQL major version.
    pgbouncer GetAlloydbomniAlloydbomniUserConfigPgbouncer
    PGBouncer connection pooling settings
    pglookout GetAlloydbomniAlloydbomniUserConfigPglookout
    System-wide settings for pglookout
    private_access GetAlloydbomniAlloydbomniUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelink_access GetAlloydbomniAlloydbomniUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    project_to_fork_from str
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    public_access GetAlloydbomniAlloydbomniUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recovery_target_time str
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    service_log bool
    Store logs for the service so that they are available in the HTTP API and console.
    service_to_fork_from str
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    shared_buffers_percentage float
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. Default is 1MB + 0.075% of total RAM (up to 32MB). Example: 4.
    additionalBackupRegions String
    Additional Cloud Regions for Backup Replication.
    adminPassword String
    Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
    adminUsername String
    Custom username for admin user. This must be set only when a new service is being created. Example: avnadmin.
    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.
    googleColumnarEngineEnabled Boolean
    Enables or disables the columnar engine. When enabled, it accelerates SQL query processing. Default: true.
    googleColumnarEngineMemorySizePercentage Number
    Allocate the amount of RAM to store columnar data. Default: 10.
    ipFilterObjects List<Property Map>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    pg Property Map
    postgresql.conf configuration values
    pgReadReplica Boolean
    Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).
    pgServiceToForkFrom String
    Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created. Example: anotherservicename.
    pgVersion String
    Enum: 15, and newer. PostgreSQL major version.
    pgbouncer Property Map
    PGBouncer connection pooling settings
    pglookout Property Map
    System-wide settings for pglookout
    privateAccess Property Map
    Allow access to selected service ports from private networks
    privatelinkAccess Property Map
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess Property Map
    Allow access to selected service ports from the public Internet
    recoveryTargetTime String
    Recovery target time when forking a service. This has effect only when a new service is being created. Example: 2019-01-01 23:34:45.
    serviceLog Boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    sharedBuffersPercentage Number
    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. 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. 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

    AutovacuumAnalyzeScaleFactor double
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    AutovacuumAnalyzeThreshold int
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    AutovacuumFreezeMaxAge int
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    AutovacuumMaxWorkers int
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    AutovacuumNaptime int
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    AutovacuumVacuumCostDelay int
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    AutovacuumVacuumCostLimit int
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    AutovacuumVacuumScaleFactor double
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    AutovacuumVacuumThreshold int
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    BgwriterDelay int
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    BgwriterFlushAfter int
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    BgwriterLruMaxpages int
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    BgwriterLruMultiplier double
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    DeadlockTimeout int
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    DefaultToastCompression string
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    IdleInTransactionSessionTimeout int
    Time out sessions with open transactions after this number of milliseconds.
    Jit bool
    Controls system-wide use of Just-in-Time Compilation (JIT).
    LogAutovacuumMinDuration int
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    LogErrorVerbosity string
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    LogLinePrefix string
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    LogMinDurationStatement int
    Log statements that take more than this number of milliseconds to run, -1 disables.
    LogTempFiles int
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    MaxFilesPerProcess int
    PostgreSQL maximum number of files that can be open per process.
    MaxLocksPerTransaction int
    PostgreSQL maximum locks per transaction.
    MaxLogicalReplicationWorkers int
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    MaxParallelWorkers int
    Sets the maximum number of workers that the system can support for parallel queries.
    MaxParallelWorkersPerGather int
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    MaxPredLocksPerTransaction int
    PostgreSQL maximum predicate locks per transaction.
    MaxPreparedTransactions int
    PostgreSQL maximum prepared transactions.
    MaxReplicationSlots int
    PostgreSQL maximum replication slots.
    MaxSlotWalKeepSize int
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    MaxStackDepth int
    Maximum depth of the stack in bytes.
    MaxStandbyArchiveDelay int
    Max standby archive delay in milliseconds.
    MaxStandbyStreamingDelay int
    Max standby streaming delay in milliseconds.
    MaxWalSenders int
    PostgreSQL maximum WAL senders.
    MaxWorkerProcesses int
    Sets the maximum number of background processes that the system can support.
    PasswordEncryption string
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    PgPartmanBgwDotInterval int
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    PgPartmanBgwDotRole string
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    PgStatStatementsDotTrack string
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    TempFileLimit int
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    Timezone string
    PostgreSQL service timezone. Example: Europe/Helsinki.
    TrackActivityQuerySize int
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    TrackCommitTimestamp string
    Enum: off, on. Record commit time of transactions.
    TrackFunctions string
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    TrackIoTiming string
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    WalSenderTimeout int
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    WalWriterDelay int
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
    AutovacuumAnalyzeScaleFactor float64
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    AutovacuumAnalyzeThreshold int
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    AutovacuumFreezeMaxAge int
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    AutovacuumMaxWorkers int
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    AutovacuumNaptime int
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    AutovacuumVacuumCostDelay int
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    AutovacuumVacuumCostLimit int
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    AutovacuumVacuumScaleFactor float64
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    AutovacuumVacuumThreshold int
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    BgwriterDelay int
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    BgwriterFlushAfter int
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    BgwriterLruMaxpages int
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    BgwriterLruMultiplier float64
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    DeadlockTimeout int
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    DefaultToastCompression string
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    IdleInTransactionSessionTimeout int
    Time out sessions with open transactions after this number of milliseconds.
    Jit bool
    Controls system-wide use of Just-in-Time Compilation (JIT).
    LogAutovacuumMinDuration int
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    LogErrorVerbosity string
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    LogLinePrefix string
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    LogMinDurationStatement int
    Log statements that take more than this number of milliseconds to run, -1 disables.
    LogTempFiles int
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    MaxFilesPerProcess int
    PostgreSQL maximum number of files that can be open per process.
    MaxLocksPerTransaction int
    PostgreSQL maximum locks per transaction.
    MaxLogicalReplicationWorkers int
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    MaxParallelWorkers int
    Sets the maximum number of workers that the system can support for parallel queries.
    MaxParallelWorkersPerGather int
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    MaxPredLocksPerTransaction int
    PostgreSQL maximum predicate locks per transaction.
    MaxPreparedTransactions int
    PostgreSQL maximum prepared transactions.
    MaxReplicationSlots int
    PostgreSQL maximum replication slots.
    MaxSlotWalKeepSize int
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    MaxStackDepth int
    Maximum depth of the stack in bytes.
    MaxStandbyArchiveDelay int
    Max standby archive delay in milliseconds.
    MaxStandbyStreamingDelay int
    Max standby streaming delay in milliseconds.
    MaxWalSenders int
    PostgreSQL maximum WAL senders.
    MaxWorkerProcesses int
    Sets the maximum number of background processes that the system can support.
    PasswordEncryption string
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    PgPartmanBgwDotInterval int
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    PgPartmanBgwDotRole string
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    PgStatStatementsDotTrack string
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    TempFileLimit int
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    Timezone string
    PostgreSQL service timezone. Example: Europe/Helsinki.
    TrackActivityQuerySize int
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    TrackCommitTimestamp string
    Enum: off, on. Record commit time of transactions.
    TrackFunctions string
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    TrackIoTiming string
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    WalSenderTimeout int
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    WalWriterDelay int
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
    autovacuumAnalyzeScaleFactor Double
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    autovacuumAnalyzeThreshold Integer
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    autovacuumFreezeMaxAge Integer
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    autovacuumMaxWorkers Integer
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    autovacuumNaptime Integer
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    autovacuumVacuumCostDelay Integer
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    autovacuumVacuumCostLimit Integer
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    autovacuumVacuumScaleFactor Double
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    autovacuumVacuumThreshold Integer
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    bgwriterDelay Integer
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    bgwriterFlushAfter Integer
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    bgwriterLruMaxpages Integer
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    bgwriterLruMultiplier Double
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    deadlockTimeout Integer
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    defaultToastCompression String
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    idleInTransactionSessionTimeout Integer
    Time out sessions with open transactions after this number of milliseconds.
    jit Boolean
    Controls system-wide use of Just-in-Time Compilation (JIT).
    logAutovacuumMinDuration Integer
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    logErrorVerbosity String
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    logLinePrefix String
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    logMinDurationStatement Integer
    Log statements that take more than this number of milliseconds to run, -1 disables.
    logTempFiles Integer
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    maxFilesPerProcess Integer
    PostgreSQL maximum number of files that can be open per process.
    maxLocksPerTransaction Integer
    PostgreSQL maximum locks per transaction.
    maxLogicalReplicationWorkers Integer
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    maxParallelWorkers Integer
    Sets the maximum number of workers that the system can support for parallel queries.
    maxParallelWorkersPerGather Integer
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    maxPredLocksPerTransaction Integer
    PostgreSQL maximum predicate locks per transaction.
    maxPreparedTransactions Integer
    PostgreSQL maximum prepared transactions.
    maxReplicationSlots Integer
    PostgreSQL maximum replication slots.
    maxSlotWalKeepSize Integer
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    maxStackDepth Integer
    Maximum depth of the stack in bytes.
    maxStandbyArchiveDelay Integer
    Max standby archive delay in milliseconds.
    maxStandbyStreamingDelay Integer
    Max standby streaming delay in milliseconds.
    maxWalSenders Integer
    PostgreSQL maximum WAL senders.
    maxWorkerProcesses Integer
    Sets the maximum number of background processes that the system can support.
    passwordEncryption String
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    pgPartmanBgwDotInterval Integer
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    pgPartmanBgwDotRole String
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    pgStatStatementsDotTrack String
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    tempFileLimit Integer
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    timezone String
    PostgreSQL service timezone. Example: Europe/Helsinki.
    trackActivityQuerySize Integer
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    trackCommitTimestamp String
    Enum: off, on. Record commit time of transactions.
    trackFunctions String
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    trackIoTiming String
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    walSenderTimeout Integer
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    walWriterDelay Integer
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
    autovacuumAnalyzeScaleFactor number
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    autovacuumAnalyzeThreshold number
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    autovacuumFreezeMaxAge number
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    autovacuumMaxWorkers number
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    autovacuumNaptime number
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    autovacuumVacuumCostDelay number
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    autovacuumVacuumCostLimit number
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    autovacuumVacuumScaleFactor number
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    autovacuumVacuumThreshold number
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    bgwriterDelay number
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    bgwriterFlushAfter number
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    bgwriterLruMaxpages number
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    bgwriterLruMultiplier number
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    deadlockTimeout number
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    defaultToastCompression string
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    idleInTransactionSessionTimeout number
    Time out sessions with open transactions after this number of milliseconds.
    jit boolean
    Controls system-wide use of Just-in-Time Compilation (JIT).
    logAutovacuumMinDuration number
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    logErrorVerbosity string
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    logLinePrefix string
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    logMinDurationStatement number
    Log statements that take more than this number of milliseconds to run, -1 disables.
    logTempFiles number
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    maxFilesPerProcess number
    PostgreSQL maximum number of files that can be open per process.
    maxLocksPerTransaction number
    PostgreSQL maximum locks per transaction.
    maxLogicalReplicationWorkers number
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    maxParallelWorkers number
    Sets the maximum number of workers that the system can support for parallel queries.
    maxParallelWorkersPerGather number
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    maxPredLocksPerTransaction number
    PostgreSQL maximum predicate locks per transaction.
    maxPreparedTransactions number
    PostgreSQL maximum prepared transactions.
    maxReplicationSlots number
    PostgreSQL maximum replication slots.
    maxSlotWalKeepSize number
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    maxStackDepth number
    Maximum depth of the stack in bytes.
    maxStandbyArchiveDelay number
    Max standby archive delay in milliseconds.
    maxStandbyStreamingDelay number
    Max standby streaming delay in milliseconds.
    maxWalSenders number
    PostgreSQL maximum WAL senders.
    maxWorkerProcesses number
    Sets the maximum number of background processes that the system can support.
    passwordEncryption string
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    pgPartmanBgwDotInterval number
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    pgPartmanBgwDotRole string
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    pgStatStatementsDotTrack string
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    tempFileLimit number
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    timezone string
    PostgreSQL service timezone. Example: Europe/Helsinki.
    trackActivityQuerySize number
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    trackCommitTimestamp string
    Enum: off, on. Record commit time of transactions.
    trackFunctions string
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    trackIoTiming string
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    walSenderTimeout number
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    walWriterDelay number
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
    autovacuum_analyze_scale_factor float
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    autovacuum_analyze_threshold int
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    autovacuum_freeze_max_age int
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    autovacuum_max_workers int
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    autovacuum_naptime int
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    autovacuum_vacuum_cost_delay int
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    autovacuum_vacuum_cost_limit int
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    autovacuum_vacuum_scale_factor float
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    autovacuum_vacuum_threshold int
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    bgwriter_delay int
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    bgwriter_flush_after int
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    bgwriter_lru_maxpages int
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    bgwriter_lru_multiplier float
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    deadlock_timeout int
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    default_toast_compression str
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    idle_in_transaction_session_timeout int
    Time out sessions with open transactions after this number of milliseconds.
    jit bool
    Controls system-wide use of Just-in-Time Compilation (JIT).
    log_autovacuum_min_duration int
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    log_error_verbosity str
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    log_line_prefix str
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    log_min_duration_statement int
    Log statements that take more than this number of milliseconds to run, -1 disables.
    log_temp_files int
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    max_files_per_process int
    PostgreSQL maximum number of files that can be open per process.
    max_locks_per_transaction int
    PostgreSQL maximum locks per transaction.
    max_logical_replication_workers int
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    max_parallel_workers int
    Sets the maximum number of workers that the system can support for parallel queries.
    max_parallel_workers_per_gather int
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    max_pred_locks_per_transaction int
    PostgreSQL maximum predicate locks per transaction.
    max_prepared_transactions int
    PostgreSQL maximum prepared transactions.
    max_replication_slots int
    PostgreSQL maximum replication slots.
    max_slot_wal_keep_size int
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    max_stack_depth int
    Maximum depth of the stack in bytes.
    max_standby_archive_delay int
    Max standby archive delay in milliseconds.
    max_standby_streaming_delay int
    Max standby streaming delay in milliseconds.
    max_wal_senders int
    PostgreSQL maximum WAL senders.
    max_worker_processes int
    Sets the maximum number of background processes that the system can support.
    password_encryption str
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    pg_partman_bgw_dot_interval int
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    pg_partman_bgw_dot_role str
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    pg_stat_statements_dot_track str
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    temp_file_limit int
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    timezone str
    PostgreSQL service timezone. Example: Europe/Helsinki.
    track_activity_query_size int
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    track_commit_timestamp str
    Enum: off, on. Record commit time of transactions.
    track_functions str
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    track_io_timing str
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    wal_sender_timeout int
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    wal_writer_delay int
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.
    autovacuumAnalyzeScaleFactor Number
    Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
    autovacuumAnalyzeThreshold Number
    Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
    autovacuumFreezeMaxAge Number
    Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. Example: 200000000.
    autovacuumMaxWorkers Number
    Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
    autovacuumNaptime Number
    Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
    autovacuumVacuumCostDelay Number
    Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds.
    autovacuumVacuumCostLimit Number
    Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.
    autovacuumVacuumScaleFactor Number
    Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
    autovacuumVacuumThreshold Number
    Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
    bgwriterDelay Number
    Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200. Example: 200.
    bgwriterFlushAfter Number
    Whenever more than 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, default is 512. Setting of 0 disables forced writeback. Example: 512.
    bgwriterLruMaxpages Number
    In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100. Example: 100.
    bgwriterLruMultiplier Number
    The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. Example: 2.0.
    deadlockTimeout Number
    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. Example: 1000.
    defaultToastCompression String
    Enum: lz4, pglz. Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
    idleInTransactionSessionTimeout Number
    Time out sessions with open transactions after this number of milliseconds.
    jit Boolean
    Controls system-wide use of Just-in-Time Compilation (JIT).
    logAutovacuumMinDuration Number
    Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
    logErrorVerbosity String
    Enum: DEFAULT, TERSE, VERBOSE. Controls the amount of detail written in the server log for each message that is logged.
    logLinePrefix String
    Enum: '%m [%p] %q[user=%u,db=%d,app=%a] ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '. Choose from one of the available log formats.
    logMinDurationStatement Number
    Log statements that take more than this number of milliseconds to run, -1 disables.
    logTempFiles Number
    Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
    maxFilesPerProcess Number
    PostgreSQL maximum number of files that can be open per process.
    maxLocksPerTransaction Number
    PostgreSQL maximum locks per transaction.
    maxLogicalReplicationWorkers Number
    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
    maxParallelWorkers Number
    Sets the maximum number of workers that the system can support for parallel queries.
    maxParallelWorkersPerGather Number
    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
    maxPredLocksPerTransaction Number
    PostgreSQL maximum predicate locks per transaction.
    maxPreparedTransactions Number
    PostgreSQL maximum prepared transactions.
    maxReplicationSlots Number
    PostgreSQL maximum replication slots.
    maxSlotWalKeepSize Number
    PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.
    maxStackDepth Number
    Maximum depth of the stack in bytes.
    maxStandbyArchiveDelay Number
    Max standby archive delay in milliseconds.
    maxStandbyStreamingDelay Number
    Max standby streaming delay in milliseconds.
    maxWalSenders Number
    PostgreSQL maximum WAL senders.
    maxWorkerProcesses Number
    Sets the maximum number of background processes that the system can support.
    passwordEncryption String
    Enum: md5, scram-sha-256. Chooses the algorithm for encrypting passwords. Default: md5.
    pgPartmanBgwDotInterval Number
    Sets the time interval to run pg_partman's scheduled tasks. Example: 3600.
    pgPartmanBgwDotRole String
    Controls which role to use for pg_partman's scheduled background tasks. Example: myrolename.
    pgStatStatementsDotTrack String
    Enum: all, none, top. Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
    tempFileLimit Number
    PostgreSQL temporary file limit in KiB, -1 for unlimited. Example: 5000000.
    timezone String
    PostgreSQL service timezone. Example: Europe/Helsinki.
    trackActivityQuerySize Number
    Specifies the number of bytes reserved to track the currently executing command for each active session. Example: 1024.
    trackCommitTimestamp String
    Enum: off, on. Record commit time of transactions.
    trackFunctions String
    Enum: all, none, pl. Enables tracking of function call counts and time used.
    trackIoTiming String
    Enum: off, on. Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
    walSenderTimeout Number
    Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Example: 60000.
    walWriterDelay Number
    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance. Example: 50.

    GetAlloydbomniAlloydbomniUserConfigPgbouncer

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

    GetAlloydbomniAlloydbomniUserConfigPglookout

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

    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
    KafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    Port int
    Port number for connecting to the service component
    Route string
    Network access route
    Ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    Usage string
    DNS usage name
    Component string
    Service component name
    ConnectionUri string
    Connection info for connecting to the service component. This is a combination of host and port.
    Host string
    Host name for connecting to the service component
    KafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    Port int
    Port number for connecting to the service component
    Route string
    Network access route
    Ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    Usage string
    DNS usage name
    component String
    Service component name
    connectionUri String
    Connection info for connecting to the service component. This is a combination of host and port.
    host String
    Host name for connecting to the service component
    kafkaAuthenticationMethod String
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port Integer
    Port number for connecting to the service component
    route String
    Network access route
    ssl Boolean
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage String
    DNS usage name
    component string
    Service component name
    connectionUri string
    Connection info for connecting to the service component. This is a combination of host and port.
    host string
    Host name for connecting to the service component
    kafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port number
    Port number for connecting to the service component
    route string
    Network access route
    ssl boolean
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage string
    DNS usage name
    component str
    Service component name
    connection_uri str
    Connection info for connecting to the service component. This is a combination of host and port.
    host str
    Host name for connecting to the service component
    kafka_authentication_method str
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port int
    Port number for connecting to the service component
    route str
    Network access route
    ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage str
    DNS usage name
    component String
    Service component name
    connectionUri String
    Connection info for connecting to the service component. This is a combination of host and port.
    host String
    Host name for connecting to the service component
    kafkaAuthenticationMethod String
    Kafka authentication method. This is a value specific to the 'kafka' service component
    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.
    SourceServiceName string
    Name of the source service
    IntegrationType string
    Type of the service integration. The possible value is read_replica.
    SourceServiceName string
    Name of the source service
    integrationType String
    Type of the service integration. The possible value is read_replica.
    sourceServiceName String
    Name of the source service
    integrationType string
    Type of the service integration. The possible value is read_replica.
    sourceServiceName string
    Name of the source service
    integration_type str
    Type of the service integration. The possible value is read_replica.
    source_service_name str
    Name of the source service
    integrationType String
    Type of the service integration. The possible value is read_replica.
    sourceServiceName String
    Name of the source service

    GetAlloydbomniTag

    Key string
    Service tag key
    Value string
    Service tag value
    Key string
    Service tag key
    Value string
    Service tag value
    key String
    Service tag key
    value String
    Service tag value
    key string
    Service tag key
    value string
    Service tag value
    key str
    Service tag key
    value str
    Service tag value
    key String
    Service tag key
    value String
    Service tag value

    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 aiven Terraform Provider.
    aiven logo
    Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi