1. Packages
  2. Aiven
  3. API Docs
  4. Pg
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.Pg

Explore with Pulumi AI

aiven logo
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

    The PG resource allows the creation and management of Aiven PostgreSQL services.

    Create Pg Resource

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

    Pg Resource Properties

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

    Inputs

    The Pg resource accepts the following input properties:

    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 seem from the Aiven pricing page.

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.

    PgServer PgPg

    postgresql.conf configuration values.

    PgUserConfig PgPgUserConfig

    Pg user configurable settings

    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.

    ServiceIntegrations List<PgServiceIntegration>

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

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    StaticIps List<string>

    Use static public IP addresses.

    Tags List<PgTag>

    Tags are key-value pairs that allow you to categorize services.

    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.

    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 seem from the Aiven pricing page.

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.

    Pg PgPgArgs

    postgresql.conf configuration values.

    PgUserConfig PgPgUserConfigArgs

    Pg user configurable settings

    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.

    ServiceIntegrations []PgServiceIntegrationArgs

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

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    StaticIps []string

    Use static public IP addresses.

    Tags []PgTagArgs

    Tags are key-value pairs that allow you to categorize services.

    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.

    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 seem from the Aiven pricing page.

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.

    pg PgPg

    postgresql.conf configuration values.

    pgUserConfig PgPgUserConfig

    Pg user configurable settings

    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.

    serviceIntegrations List<PgServiceIntegration>

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

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    staticIps List<String>

    Use static public IP addresses.

    tags List<PgTag>

    Tags are key-value pairs that allow you to categorize services.

    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.

    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 seem from the Aiven pricing page.

    project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    additionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.

    pg PgPg

    postgresql.conf configuration values.

    pgUserConfig PgPgUserConfig

    Pg user configurable settings

    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.

    serviceIntegrations PgServiceIntegration[]

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

    serviceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    staticIps string[]

    Use static public IP addresses.

    tags PgTag[]

    Tags are key-value pairs that allow you to categorize services.

    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.

    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 seem from the Aiven pricing page.

    project str

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    additional_disk_space str

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenance_window_dow str

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenance_window_time str

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    pg PgPgArgs

    postgresql.conf configuration values.

    pg_user_config PgPgUserConfigArgs

    Pg user configurable settings

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

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

    service_name str

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    static_ips Sequence[str]

    Use static public IP addresses.

    tags Sequence[PgTagArgs]

    Tags are key-value pairs that allow you to categorize services.

    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.

    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 seem from the Aiven pricing page.

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.

    pg Property Map

    postgresql.conf configuration values.

    pgUserConfig Property Map

    Pg user configurable settings

    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.

    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.

    staticIps List<String>

    Use static public IP addresses.

    tags List<Property Map>

    Tags are key-value pairs that allow you to categorize services.

    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.

    Outputs

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

    Components List<PgComponent>

    Service component information objects

    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.

    ServiceHost string

    The hostname of the service.

    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

    Components []PgComponent

    Service component information objects

    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.

    ServiceHost string

    The hostname of the service.

    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

    components List<PgComponent>

    Service component information objects

    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.

    serviceHost String

    The hostname of the service.

    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

    components PgComponent[]

    Service component information objects

    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.

    serviceHost string

    The hostname of the service.

    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

    components Sequence[PgComponent]

    Service component information objects

    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.

    service_host str

    The hostname of the service.

    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

    components List<Property Map>

    Service component information objects

    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.

    serviceHost String

    The hostname of the service.

    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

    Look up Existing Pg Resource

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

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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

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

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    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.

    PgServer PgPg

    postgresql.conf configuration values.

    PgUserConfig PgPgUserConfig

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations List<PgServiceIntegration>

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

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    ServicePassword string

    Password used for connecting to the 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>

    Use static public IP addresses.

    Tags List<PgTag>

    Tags are key-value pairs that allow you to categorize services.

    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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

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

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    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.

    Pg PgPgArgs

    postgresql.conf configuration values.

    PgUserConfig PgPgUserConfigArgs

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations []PgServiceIntegrationArgs

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

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    ServicePassword string

    Password used for connecting to the 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

    Use static public IP addresses.

    Tags []PgTagArgs

    Tags are key-value pairs that allow you to categorize services.

    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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

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

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    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.

    pg PgPg

    postgresql.conf configuration values.

    pgUserConfig PgPgUserConfig

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.

    serviceHost String

    The hostname of the service.

    serviceIntegrations List<PgServiceIntegration>

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

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    servicePassword String

    Password used for connecting to the 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>

    Use static public IP addresses.

    tags List<PgTag>

    Tags are key-value pairs that allow you to categorize services.

    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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName string

    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

    components PgComponent[]

    Service component information objects

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    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.

    pg PgPg

    postgresql.conf configuration values.

    pgUserConfig PgPgUserConfig

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.

    serviceHost string

    The hostname of the service.

    serviceIntegrations PgServiceIntegration[]

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

    serviceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    servicePassword string

    Password used for connecting to the 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[]

    Use static public IP addresses.

    tags PgTag[]

    Tags are key-value pairs that allow you to categorize services.

    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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloud_name str

    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

    components Sequence[PgComponentArgs]

    Service component information objects

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    maintenance_window_dow str

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenance_window_time str

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    pg PgPgArgs

    postgresql.conf configuration values.

    pg_user_config PgPgUserConfigArgs

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    project str

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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_host str

    The hostname of the service.

    service_integrations Sequence[PgServiceIntegrationArgs]

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

    service_name str

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    service_password str

    Password used for connecting to the 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]

    Use static public IP addresses.

    tags Sequence[PgTagArgs]

    Tags are key-value pairs that allow you to categorize services.

    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

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    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.

    pg Property Map

    postgresql.conf configuration values.

    pgUserConfig Property Map

    Pg user configurable settings

    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 seem from the Aiven pricing page.

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.

    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>

    Use static public IP addresses.

    tags List<Property Map>

    Tags are key-value pairs that allow you to categorize services.

    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

    PgComponent, PgComponentArgs

    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Integer
    route String
    ssl Boolean
    usage String
    component string
    host string
    kafkaAuthenticationMethod string
    port number
    route string
    ssl boolean
    usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Number
    route String
    ssl Boolean
    usage String

    PgPg, PgPgArgs

    Dbname string

    Primary PostgreSQL database name

    Host string

    PostgreSQL master node host IP or name

    MaxConnections int

    Connection limit

    Password string

    PostgreSQL admin user password

    Port int

    PostgreSQL port

    ReplicaUri string

    PostgreSQL replica URI for services with a replica

    Sslmode string

    PostgreSQL sslmode setting (currently always "require")

    Uri string

    PostgreSQL master connection URI

    User string

    PostgreSQL admin user name

    Dbname string

    Primary PostgreSQL database name

    Host string

    PostgreSQL master node host IP or name

    MaxConnections int

    Connection limit

    Password string

    PostgreSQL admin user password

    Port int

    PostgreSQL port

    ReplicaUri string

    PostgreSQL replica URI for services with a replica

    Sslmode string

    PostgreSQL sslmode setting (currently always "require")

    Uri string

    PostgreSQL master connection URI

    User string

    PostgreSQL admin user name

    dbname String

    Primary PostgreSQL database name

    host String

    PostgreSQL master node host IP or name

    maxConnections Integer

    Connection limit

    password String

    PostgreSQL admin user password

    port Integer

    PostgreSQL port

    replicaUri String

    PostgreSQL replica URI for services with a replica

    sslmode String

    PostgreSQL sslmode setting (currently always "require")

    uri String

    PostgreSQL master connection URI

    user String

    PostgreSQL admin user name

    dbname string

    Primary PostgreSQL database name

    host string

    PostgreSQL master node host IP or name

    maxConnections number

    Connection limit

    password string

    PostgreSQL admin user password

    port number

    PostgreSQL port

    replicaUri string

    PostgreSQL replica URI for services with a replica

    sslmode string

    PostgreSQL sslmode setting (currently always "require")

    uri string

    PostgreSQL master connection URI

    user string

    PostgreSQL admin user name

    dbname str

    Primary PostgreSQL database name

    host str

    PostgreSQL master node host IP or name

    max_connections int

    Connection limit

    password str

    PostgreSQL admin user password

    port int

    PostgreSQL port

    replica_uri str

    PostgreSQL replica URI for services with a replica

    sslmode str

    PostgreSQL sslmode setting (currently always "require")

    uri str

    PostgreSQL master connection URI

    user str

    PostgreSQL admin user name

    dbname String

    Primary PostgreSQL database name

    host String

    PostgreSQL master node host IP or name

    maxConnections Number

    Connection limit

    password String

    PostgreSQL admin user password

    port Number

    PostgreSQL port

    replicaUri String

    PostgreSQL replica URI for services with a replica

    sslmode String

    PostgreSQL sslmode setting (currently always "require")

    uri String

    PostgreSQL master connection URI

    user String

    PostgreSQL admin user name

    PgPgUserConfig, PgPgUserConfigArgs

    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.

    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.

    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.

    EnableIpv6 bool

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    IpFilterObjects List<PgPgUserConfigIpFilterObject>

    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:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    Migration PgPgUserConfigMigration

    Migrate data from existing server.

    Pg PgPgUserConfigPg

    postgresql.conf configuration values.

    PgReadReplica bool

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    PgServiceToForkFrom string

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    PgStatMonitorEnable bool

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    PgVersion string

    PostgreSQL major version.

    Pgbouncer PgPgUserConfigPgbouncer

    PGBouncer connection pooling settings.

    Pglookout PgPgUserConfigPglookout

    PGLookout settings.

    PrivateAccess PgPgUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    PrivatelinkAccess PgPgUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    ProjectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    PublicAccess PgPgUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    RecoveryTargetTime string

    Recovery target time when forking a service. This has effect only when a new service is being created.

    ServiceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

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

    StaticIps bool

    Use static public IP addresses.

    SynchronousReplication string

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    Timescaledb PgPgUserConfigTimescaledb

    TimescaleDB extension configuration values.

    Variant string

    Variant of the PostgreSQL service, may affect the features that are exposed by default.

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

    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.

    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.

    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.

    EnableIpv6 bool

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    IpFilterObjects []PgPgUserConfigIpFilterObject

    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:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    Migration PgPgUserConfigMigration

    Migrate data from existing server.

    Pg PgPgUserConfigPg

    postgresql.conf configuration values.

    PgReadReplica bool

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    PgServiceToForkFrom string

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    PgStatMonitorEnable bool

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    PgVersion string

    PostgreSQL major version.

    Pgbouncer PgPgUserConfigPgbouncer

    PGBouncer connection pooling settings.

    Pglookout PgPgUserConfigPglookout

    PGLookout settings.

    PrivateAccess PgPgUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    PrivatelinkAccess PgPgUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    ProjectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    PublicAccess PgPgUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    RecoveryTargetTime string

    Recovery target time when forking a service. This has effect only when a new service is being created.

    ServiceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

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

    StaticIps bool

    Use static public IP addresses.

    SynchronousReplication string

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    Timescaledb PgPgUserConfigTimescaledb

    TimescaleDB extension configuration values.

    Variant string

    Variant of the PostgreSQL service, may affect the features that are exposed by default.

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

    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.

    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.

    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.

    enableIpv6 Boolean

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    ipFilterObjects List<PgPgUserConfigIpFilterObject>

    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:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    migration PgPgUserConfigMigration

    Migrate data from existing server.

    pg PgPgUserConfigPg

    postgresql.conf configuration values.

    pgReadReplica Boolean

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    pgServiceToForkFrom String

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    pgStatMonitorEnable Boolean

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    pgVersion String

    PostgreSQL major version.

    pgbouncer PgPgUserConfigPgbouncer

    PGBouncer connection pooling settings.

    pglookout PgPgUserConfigPglookout

    PGLookout settings.

    privateAccess PgPgUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelinkAccess PgPgUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    projectToForkFrom String

    Name of another project to fork a service from. This has effect only when a new service is being created.

    publicAccess PgPgUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recoveryTargetTime String

    Recovery target time when forking a service. This has effect only when a new service is being created.

    serviceToForkFrom String

    Name of another service to fork from. This has effect only when a new service is being created.

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

    staticIps Boolean

    Use static public IP addresses.

    synchronousReplication String

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    timescaledb PgPgUserConfigTimescaledb

    TimescaleDB extension configuration values.

    variant String

    Variant of the PostgreSQL service, may affect the features that are exposed by default.

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

    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.

    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.

    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.

    enableIpv6 boolean

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    ipFilterObjects PgPgUserConfigIpFilterObject[]

    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:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    migration PgPgUserConfigMigration

    Migrate data from existing server.

    pg PgPgUserConfigPg

    postgresql.conf configuration values.

    pgReadReplica boolean

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    pgServiceToForkFrom string

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    pgStatMonitorEnable boolean

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    pgVersion string

    PostgreSQL major version.

    pgbouncer PgPgUserConfigPgbouncer

    PGBouncer connection pooling settings.

    pglookout PgPgUserConfigPglookout

    PGLookout settings.

    privateAccess PgPgUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelinkAccess PgPgUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    projectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    publicAccess PgPgUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recoveryTargetTime string

    Recovery target time when forking a service. This has effect only when a new service is being created.

    serviceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

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

    staticIps boolean

    Use static public IP addresses.

    synchronousReplication string

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    timescaledb PgPgUserConfigTimescaledb

    TimescaleDB extension configuration values.

    variant string

    Variant of the PostgreSQL service, may affect the features that are exposed by default.

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

    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.

    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.

    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.

    enable_ipv6 bool

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    ip_filter_objects Sequence[PgPgUserConfigIpFilterObject]

    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:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    migration PgPgUserConfigMigration

    Migrate data from existing server.

    pg PgPgUserConfigPg

    postgresql.conf configuration values.

    pg_read_replica bool

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    pg_service_to_fork_from str

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    pg_stat_monitor_enable bool

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    pg_version str

    PostgreSQL major version.

    pgbouncer PgPgUserConfigPgbouncer

    PGBouncer connection pooling settings.

    pglookout PgPgUserConfigPglookout

    PGLookout settings.

    private_access PgPgUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelink_access PgPgUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    project_to_fork_from str

    Name of another project to fork a service from. This has effect only when a new service is being created.

    public_access PgPgUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recovery_target_time str

    Recovery target time when forking a service. This has effect only when a new service is being created.

    service_to_fork_from str

    Name of another service to fork from. This has effect only when a new service is being created.

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

    static_ips bool

    Use static public IP addresses.

    synchronous_replication str

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    timescaledb PgPgUserConfigTimescaledb

    TimescaleDB extension configuration values.

    variant str

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

    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.

    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.

    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.

    enableIpv6 Boolean

    Register AAAA DNS records for the service, and allow IPv6 packets to service ports.

    ipFilterObjects List<Property Map>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilterStrings List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilters List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    migration Property Map

    Migrate data from existing server.

    pg Property Map

    postgresql.conf configuration values.

    pgReadReplica Boolean

    Use read_replica service integration instead.

    Deprecated:

    Usage of this field is discouraged.

    pgServiceToForkFrom String

    Name of the PG Service from which to fork (deprecated, use servicetofork_from). This has effect only when a new service is being created.

    Deprecated:

    Usage of this field is discouraged.

    pgStatMonitorEnable Boolean

    Enable the pgstatmonitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pgstatstatements results for utility commands are unreliable. The default value is false.

    pgVersion String

    PostgreSQL major version.

    pgbouncer Property Map

    PGBouncer connection pooling settings.

    pglookout Property Map

    PGLookout settings.

    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.

    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.

    serviceToForkFrom String

    Name of another service to fork from. This has effect only when a new service is being created.

    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.

    staticIps Boolean

    Use static public IP addresses.

    synchronousReplication String

    Synchronous replication type. Note that the service plan also needs to support synchronous replication.

    timescaledb Property Map

    TimescaleDB extension configuration values.

    variant String

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

    PgPgUserConfigIpFilterObject, PgPgUserConfigIpFilterObjectArgs

    Network string

    CIDR address block.

    Description string

    Description for IP filter list entry.

    Network string

    CIDR address block.

    Description string

    Description for IP filter list entry.

    network String

    CIDR address block.

    description String

    Description for IP filter list entry.

    network string

    CIDR address block.

    description string

    Description for IP filter list entry.

    network str

    CIDR address block.

    description str

    Description for IP filter list entry.

    network String

    CIDR address block.

    description String

    Description for IP filter list entry.

    PgPgUserConfigMigration, PgPgUserConfigMigrationArgs

    Host string
    Port int
    Dbname string

    Primary PostgreSQL database name

    IgnoreDbs string

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    Method string

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    Password string

    PostgreSQL admin user password

    Ssl bool
    Username string

    User name for authentication with the server where to migrate data from.

    Host string
    Port int
    Dbname string

    Primary PostgreSQL database name

    IgnoreDbs string

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    Method string

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    Password string

    PostgreSQL admin user password

    Ssl bool
    Username string

    User name for authentication with the server where to migrate data from.

    host String
    port Integer
    dbname String

    Primary PostgreSQL database name

    ignoreDbs String

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    method String

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    password String

    PostgreSQL admin user password

    ssl Boolean
    username String

    User name for authentication with the server where to migrate data from.

    host string
    port number
    dbname string

    Primary PostgreSQL database name

    ignoreDbs string

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    method string

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    password string

    PostgreSQL admin user password

    ssl boolean
    username string

    User name for authentication with the server where to migrate data from.

    host str
    port int
    dbname str

    Primary PostgreSQL database name

    ignore_dbs str

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    method str

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    password str

    PostgreSQL admin user password

    ssl bool
    username str

    User name for authentication with the server where to migrate data from.

    host String
    port Number
    dbname String

    Primary PostgreSQL database name

    ignoreDbs String

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).

    method String

    The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).

    password String

    PostgreSQL admin user password

    ssl Boolean
    username String

    User name for authentication with the server where to migrate data from.

    PgPgUserConfigPg, PgPgUserConfigPgArgs

    AutovacuumAnalyzeScaleFactor double

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    AutovacuumVacuumScaleFactor double

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    BgwriterFlushAfter int

    Whenever more than bgwriterflushafter 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.

    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.

    BgwriterLruMultiplier double

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    DefaultToastCompression string

    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

    Controls the amount of detail written in the server log for each message that is logged.

    LogLinePrefix string

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    PgPartmanBgwDotInterval int

    Sets the time interval to run pg_partman's scheduled tasks.

    PgPartmanBgwDotRole string

    Controls which role to use for pg_partman's scheduled background tasks.

    PgStatMonitorDotPgsmEnableQueryPlan bool

    Enables or disables query plan monitoring.

    PgStatMonitorDotPgsmMaxBuckets int

    Sets the maximum number of buckets .

    PgStatStatementsDotTrack string

    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.

    Timezone string

    PostgreSQL service timezone.

    TrackActivityQuerySize int

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    TrackCommitTimestamp string

    Record commit time of transactions.

    TrackFunctions string

    Enables tracking of function call counts and time used.

    TrackIoTiming string

    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.

    WalWriterDelay int

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    AutovacuumAnalyzeScaleFactor float64

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    AutovacuumVacuumScaleFactor float64

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    BgwriterFlushAfter int

    Whenever more than bgwriterflushafter 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.

    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.

    BgwriterLruMultiplier float64

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    DefaultToastCompression string

    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

    Controls the amount of detail written in the server log for each message that is logged.

    LogLinePrefix string

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    PgPartmanBgwDotInterval int

    Sets the time interval to run pg_partman's scheduled tasks.

    PgPartmanBgwDotRole string

    Controls which role to use for pg_partman's scheduled background tasks.

    PgStatMonitorDotPgsmEnableQueryPlan bool

    Enables or disables query plan monitoring.

    PgStatMonitorDotPgsmMaxBuckets int

    Sets the maximum number of buckets .

    PgStatStatementsDotTrack string

    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.

    Timezone string

    PostgreSQL service timezone.

    TrackActivityQuerySize int

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    TrackCommitTimestamp string

    Record commit time of transactions.

    TrackFunctions string

    Enables tracking of function call counts and time used.

    TrackIoTiming string

    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.

    WalWriterDelay int

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    autovacuumAnalyzeScaleFactor Double

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    autovacuumVacuumScaleFactor Double

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    bgwriterFlushAfter Integer

    Whenever more than bgwriterflushafter 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.

    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.

    bgwriterLruMultiplier Double

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    defaultToastCompression String

    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

    Controls the amount of detail written in the server log for each message that is logged.

    logLinePrefix String

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    pgPartmanBgwDotInterval Integer

    Sets the time interval to run pg_partman's scheduled tasks.

    pgPartmanBgwDotRole String

    Controls which role to use for pg_partman's scheduled background tasks.

    pgStatMonitorDotPgsmEnableQueryPlan Boolean

    Enables or disables query plan monitoring.

    pgStatMonitorDotPgsmMaxBuckets Integer

    Sets the maximum number of buckets .

    pgStatStatementsDotTrack String

    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.

    timezone String

    PostgreSQL service timezone.

    trackActivityQuerySize Integer

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    trackCommitTimestamp String

    Record commit time of transactions.

    trackFunctions String

    Enables tracking of function call counts and time used.

    trackIoTiming String

    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.

    walWriterDelay Integer

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    autovacuumAnalyzeScaleFactor number

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    autovacuumVacuumScaleFactor number

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    bgwriterFlushAfter number

    Whenever more than bgwriterflushafter 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.

    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.

    bgwriterLruMultiplier number

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    defaultToastCompression string

    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

    Controls the amount of detail written in the server log for each message that is logged.

    logLinePrefix string

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    pgPartmanBgwDotInterval number

    Sets the time interval to run pg_partman's scheduled tasks.

    pgPartmanBgwDotRole string

    Controls which role to use for pg_partman's scheduled background tasks.

    pgStatMonitorDotPgsmEnableQueryPlan boolean

    Enables or disables query plan monitoring.

    pgStatMonitorDotPgsmMaxBuckets number

    Sets the maximum number of buckets .

    pgStatStatementsDotTrack string

    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.

    timezone string

    PostgreSQL service timezone.

    trackActivityQuerySize number

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    trackCommitTimestamp string

    Record commit time of transactions.

    trackFunctions string

    Enables tracking of function call counts and time used.

    trackIoTiming string

    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.

    walWriterDelay number

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    autovacuum_analyze_scale_factor float

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    autovacuum_vacuum_scale_factor float

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    bgwriter_flush_after int

    Whenever more than bgwriterflushafter 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.

    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.

    bgwriter_lru_multiplier float

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    default_toast_compression str

    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

    Controls the amount of detail written in the server log for each message that is logged.

    log_line_prefix str

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    pg_partman_bgw_dot_interval int

    Sets the time interval to run pg_partman's scheduled tasks.

    pg_partman_bgw_dot_role str

    Controls which role to use for pg_partman's scheduled background tasks.

    pg_stat_monitor_dot_pgsm_enable_query_plan bool

    Enables or disables query plan monitoring.

    pg_stat_monitor_dot_pgsm_max_buckets int

    Sets the maximum number of buckets .

    pg_stat_statements_dot_track str

    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.

    timezone str

    PostgreSQL service timezone.

    track_activity_query_size int

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    track_commit_timestamp str

    Record commit time of transactions.

    track_functions str

    Enables tracking of function call counts and time used.

    track_io_timing str

    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.

    wal_writer_delay int

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    autovacuumAnalyzeScaleFactor Number

    Specifies a fraction of the table size to add to autovacuumanalyzethreshold 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.

    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 vacuumcostdelay 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 vacuumcostlimit value will be used.

    autovacuumVacuumScaleFactor Number

    Specifies a fraction of the table size to add to autovacuumvacuumthreshold 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.

    bgwriterFlushAfter Number

    Whenever more than bgwriterflushafter 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.

    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.

    bgwriterLruMultiplier Number

    The average recent need for new buffers is multiplied by bgwriterlrumultiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriterlrumaxpages). 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.

    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.

    defaultToastCompression String

    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

    Controls the amount of detail written in the server log for each message that is logged.

    logLinePrefix String

    Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.

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

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

    pgPartmanBgwDotInterval Number

    Sets the time interval to run pg_partman's scheduled tasks.

    pgPartmanBgwDotRole String

    Controls which role to use for pg_partman's scheduled background tasks.

    pgStatMonitorDotPgsmEnableQueryPlan Boolean

    Enables or disables query plan monitoring.

    pgStatMonitorDotPgsmMaxBuckets Number

    Sets the maximum number of buckets .

    pgStatStatementsDotTrack String

    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.

    timezone String

    PostgreSQL service timezone.

    trackActivityQuerySize Number

    Specifies the number of bytes reserved to track the currently executing command for each active session.

    trackCommitTimestamp String

    Record commit time of transactions.

    trackFunctions String

    Enables tracking of function call counts and time used.

    trackIoTiming String

    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.

    walWriterDelay Number

    WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.

    PgPgUserConfigPgbouncer, PgPgUserConfigPgbouncerArgs

    AutodbIdleTimeout int

    If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).

    AutodbMaxDbConnections int

    Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

    AutodbPoolMode string

    PGBouncer pool mode.

    AutodbPoolSize int

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    IgnoreStartupParameters List<string>

    List of parameters to ignore when given in startup packet.

    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.

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

    ServerLifetime int

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    ServerResetQueryAlways bool

    Run serverresetquery (DISCARD ALL) in all pooling modes.

    AutodbIdleTimeout int

    If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).

    AutodbMaxDbConnections int

    Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

    AutodbPoolMode string

    PGBouncer pool mode.

    AutodbPoolSize int

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    IgnoreStartupParameters []string

    List of parameters to ignore when given in startup packet.

    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.

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

    ServerLifetime int

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    ServerResetQueryAlways bool

    Run serverresetquery (DISCARD ALL) in all pooling modes.

    autodbIdleTimeout Integer

    If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).

    autodbMaxDbConnections Integer

    Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

    autodbPoolMode String

    PGBouncer pool mode.

    autodbPoolSize Integer

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    ignoreStartupParameters List<String>

    List of parameters to ignore when given in startup packet.

    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.

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

    serverLifetime Integer

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    serverResetQueryAlways Boolean

    Run serverresetquery (DISCARD ALL) in all pooling modes.

    autodbIdleTimeout number

    If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).

    autodbMaxDbConnections number

    Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

    autodbPoolMode string

    PGBouncer pool mode.

    autodbPoolSize number

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    ignoreStartupParameters string[]

    List of parameters to ignore when given in startup packet.

    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.

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

    serverLifetime number

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    serverResetQueryAlways boolean

    Run serverresetquery (DISCARD ALL) in all pooling modes.

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

    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.

    autodb_pool_mode str

    PGBouncer pool mode.

    autodb_pool_size int

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    ignore_startup_parameters Sequence[str]

    List of parameters to ignore when given in startup packet.

    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.

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

    server_lifetime int

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    server_reset_query_always bool

    Run serverresetquery (DISCARD ALL) in all pooling modes.

    autodbIdleTimeout Number

    If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).

    autodbMaxDbConnections Number

    Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

    autodbPoolMode String

    PGBouncer pool mode.

    autodbPoolSize Number

    If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

    ignoreStartupParameters List<String>

    List of parameters to ignore when given in startup packet.

    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.

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

    serverLifetime Number

    The pooler will close an unused server connection that has been connected longer than this. (seconds).

    serverResetQueryAlways Boolean

    Run serverresetquery (DISCARD ALL) in all pooling modes.

    PgPgUserConfigPglookout, PgPgUserConfigPglookoutArgs

    MaxFailoverReplicationTimeLag int

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    MaxFailoverReplicationTimeLag int

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    maxFailoverReplicationTimeLag Integer

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    maxFailoverReplicationTimeLag number

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    max_failover_replication_time_lag int

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    maxFailoverReplicationTimeLag Number

    Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

    PgPgUserConfigPrivateAccess, PgPgUserConfigPrivateAccessArgs

    Pg bool

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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.

    PgPgUserConfigPrivatelinkAccess, PgPgUserConfigPrivatelinkAccessArgs

    Pg bool

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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.

    PgPgUserConfigPublicAccess, PgPgUserConfigPublicAccessArgs

    Pg bool

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    Pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer boolean

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer bool

    PGBouncer connection pooling settings.

    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

    postgresql.conf configuration values.

    pgbouncer Boolean

    PGBouncer connection pooling settings.

    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.

    PgPgUserConfigTimescaledb, PgPgUserConfigTimescaledbArgs

    MaxBackgroundWorkers int

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    MaxBackgroundWorkers int

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    maxBackgroundWorkers Integer

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    maxBackgroundWorkers number

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    max_background_workers int

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    maxBackgroundWorkers Number

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

    PgServiceIntegration, PgServiceIntegrationArgs

    IntegrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    SourceServiceName string

    Name of the source service

    IntegrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    SourceServiceName string

    Name of the source service

    integrationType String

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName String

    Name of the source service

    integrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName string

    Name of the source service

    integration_type str

    Type of the service integration. The only supported value at the moment is read_replica

    source_service_name str

    Name of the source service

    integrationType String

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName String

    Name of the source service

    PgTag, PgTagArgs

    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

    Import

     $ pulumi import aiven:index/pg:Pg pg project/service_name
    

    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.7.2 published on Tuesday, Oct 31, 2023 by Pulumi