Aiven

v5.4.0 published on Monday, Sep 12, 2022 by Pulumi

getPg

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var pg = Aiven.GetPg.Invoke(new()
    {
        Project = data.Aiven_project.Pr1.Project,
        ServiceName = "my-pg1",
    });

});
package main

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

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

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetPgArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var pg = AivenFunctions.getPg(GetPgArgs.builder()
            .project(data.aiven_project().pr1().project())
            .serviceName("my-pg1")
            .build());

    }
}
import pulumi
import pulumi_aiven as aiven

pg = aiven.get_pg(project=data["aiven_project"]["pr1"]["project"],
    service_name="my-pg1")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const pg = aiven.getPg({
    project: data.aiven_project.pr1.project,
    serviceName: "my-pg1",
});
variables:
  pg:
    Fn::Invoke:
      Function: aiven:getPg
      Arguments:
        project: ${data.aiven_project.pr1.project}
        serviceName: my-pg1

Using getPg

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPg(args: GetPgArgs, opts?: InvokeOptions): Promise<GetPgResult>
function getPgOutput(args: GetPgOutputArgs, opts?: InvokeOptions): Output<GetPgResult>
def get_pg(project: Optional[str] = None,
           service_name: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> GetPgResult
def get_pg_output(project: Optional[pulumi.Input[str]] = None,
           service_name: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[GetPgResult]
func LookupPg(ctx *Context, args *LookupPgArgs, opts ...InvokeOption) (*LookupPgResult, error)
func LookupPgOutput(ctx *Context, args *LookupPgOutputArgs, opts ...InvokeOption) LookupPgResultOutput

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

public static class GetPg 
{
    public static Task<GetPgResult> InvokeAsync(GetPgArgs args, InvokeOptions? opts = null)
    public static Output<GetPgResult> Invoke(GetPgInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPgResult> getPg(GetPgArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aiven:index/getPg:getPg
  arguments:
    # arguments dictionary

The following arguments are supported:

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.

ServiceName string

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

Project string

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.

ServiceName string

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

project String

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.

serviceName String

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

project string

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.

serviceName string

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

project str

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.

service_name str

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

project String

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.

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.

getPg Result

The following output properties are available:

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

Service component information objects

DiskSpace string

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

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

DiskSpaceUsed string

Disk space that service is currently using

Id string

The provider-assigned unique ID for this managed resource.

MaintenanceWindowDow string

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

MaintenanceWindowTime string

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

PgUserConfigs List<GetPgPgUserConfig>

Pg user configurable settings

Pgs List<GetPgPg>

PostgreSQL specific server provided values

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

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

ServiceName string

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

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps List<string>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

Tags List<GetPgTag>

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

Service component information objects

DiskSpace string

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

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

DiskSpaceUsed string

Disk space that service is currently using

Id string

The provider-assigned unique ID for this managed resource.

MaintenanceWindowDow string

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

MaintenanceWindowTime string

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

PgUserConfigs []GetPgPgUserConfig

Pg user configurable settings

Pgs []GetPgPg

PostgreSQL specific server provided values

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

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

ServiceName string

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

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps []string

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

Tags []GetPgTag

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

Service component information objects

diskSpace String

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

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed String

Disk space that service is currently using

id String

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow String

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

maintenanceWindowTime String

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

pgUserConfigs List<GetPgPgUserConfig>

Pg user configurable settings

pgs List<GetPgPg>

PostgreSQL specific server provided values

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

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

serviceName String

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

servicePassword String

Password used for connecting to the service, if applicable

servicePort Integer

The port of the service

serviceType String

Aiven internal service type code

serviceUri String

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername String

Username used for connecting to the service, if applicable

state String

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps List<String>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags List<GetPgTag>

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

Service component information objects

diskSpace string

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

diskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed string

Disk space that service is currently using

id string

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow string

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

maintenanceWindowTime string

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

pgUserConfigs GetPgPgUserConfig[]

Pg user configurable settings

pgs GetPgPg[]

PostgreSQL specific server provided values

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

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

serviceName string

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

servicePassword string

Password used for connecting to the service, if applicable

servicePort number

The port of the service

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername string

Username used for connecting to the service, if applicable

state string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps string[]

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags GetPgTag[]

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

Service component information objects

disk_space str

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

disk_space_cap str

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

disk_space_default str

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

disk_space_step str

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

disk_space_used str

Disk space that service is currently using

id str

The provider-assigned unique ID for this managed resource.

maintenance_window_dow str

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

maintenance_window_time str

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

pg_user_configs Sequence[GetPgPgUserConfig]

Pg user configurable settings

pgs Sequence[GetPgPg]

PostgreSQL specific server provided values

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

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

service_name str

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

service_password str

Password used for connecting to the service, if applicable

service_port int

The port of the service

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

service_username str

Username used for connecting to the service, if applicable

state str

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

static_ips Sequence[str]

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags Sequence[GetPgTag]

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.

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed String

Disk space that service is currently using

id String

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow String

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

maintenanceWindowTime String

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

pgUserConfigs List<Property Map>

Pg user configurable settings

pgs List<Property Map>

PostgreSQL specific server provided values

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>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags List<Property Map>

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

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

GetPgComponent

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

GetPgPg

Dbname string
Host string
MaxConnections int
Password string
Port int
ReplicaUri string
Sslmode string
Uri string
User string
Dbname string
Host string
MaxConnections int
Password string
Port int
ReplicaUri string
Sslmode string
Uri string
User string
dbname String
host String
maxConnections Integer
password String
port Integer
replicaUri String
sslmode String
uri String
user String
dbname string
host string
maxConnections number
password string
port number
replicaUri string
sslmode string
uri string
user string
dbname String
host String
maxConnections Number
password String
port Number
replicaUri String
sslmode String
uri String
user String

GetPgPgUserConfig

AdminPassword string
AdminUsername string
BackupHour string
BackupMinute string
EnableIpv6 string
IpFilters List<string>
Migration GetPgPgUserConfigMigration
Pg GetPgPgUserConfigPg

PostgreSQL specific server provided values

PgReadReplica string
PgServiceToForkFrom string
PgStatMonitorEnable string
PgVersion string
Pgbouncer GetPgPgUserConfigPgbouncer
Pglookout GetPgPgUserConfigPglookout
PrivateAccess GetPgPgUserConfigPrivateAccess
PrivatelinkAccess GetPgPgUserConfigPrivatelinkAccess
ProjectToForkFrom string
PublicAccess GetPgPgUserConfigPublicAccess
RecoveryTargetTime string
ServiceToForkFrom string
SharedBuffersPercentage string
StaticIps string

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

SynchronousReplication string
Timescaledb GetPgPgUserConfigTimescaledb
Variant string
WorkMem string
AdminPassword string
AdminUsername string
BackupHour string
BackupMinute string
EnableIpv6 string
IpFilters []string
Migration GetPgPgUserConfigMigration
Pg GetPgPgUserConfigPg

PostgreSQL specific server provided values

PgReadReplica string
PgServiceToForkFrom string
PgStatMonitorEnable string
PgVersion string
Pgbouncer GetPgPgUserConfigPgbouncer
Pglookout GetPgPgUserConfigPglookout
PrivateAccess GetPgPgUserConfigPrivateAccess
PrivatelinkAccess GetPgPgUserConfigPrivatelinkAccess
ProjectToForkFrom string
PublicAccess GetPgPgUserConfigPublicAccess
RecoveryTargetTime string
ServiceToForkFrom string
SharedBuffersPercentage string
StaticIps string

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

SynchronousReplication string
Timescaledb GetPgPgUserConfigTimescaledb
Variant string
WorkMem string
adminPassword String
adminUsername String
backupHour String
backupMinute String
enableIpv6 String
ipFilters List<String>
migration GetPgPgUserConfigMigration
pg GetPgPgUserConfigPg

PostgreSQL specific server provided values

pgReadReplica String
pgServiceToForkFrom String
pgStatMonitorEnable String
pgVersion String
pgbouncer GetPgPgUserConfigPgbouncer
pglookout GetPgPgUserConfigPglookout
privateAccess GetPgPgUserConfigPrivateAccess
privatelinkAccess GetPgPgUserConfigPrivatelinkAccess
projectToForkFrom String
publicAccess GetPgPgUserConfigPublicAccess
recoveryTargetTime String
serviceToForkFrom String
sharedBuffersPercentage String
staticIps String

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

synchronousReplication String
timescaledb GetPgPgUserConfigTimescaledb
variant String
workMem String
adminPassword string
adminUsername string
backupHour string
backupMinute string
enableIpv6 string
ipFilters string[]
migration GetPgPgUserConfigMigration
pg GetPgPgUserConfigPg

PostgreSQL specific server provided values

pgReadReplica string
pgServiceToForkFrom string
pgStatMonitorEnable string
pgVersion string
pgbouncer GetPgPgUserConfigPgbouncer
pglookout GetPgPgUserConfigPglookout
privateAccess GetPgPgUserConfigPrivateAccess
privatelinkAccess GetPgPgUserConfigPrivatelinkAccess
projectToForkFrom string
publicAccess GetPgPgUserConfigPublicAccess
recoveryTargetTime string
serviceToForkFrom string
sharedBuffersPercentage string
staticIps string

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

synchronousReplication string
timescaledb GetPgPgUserConfigTimescaledb
variant string
workMem string
admin_password str
admin_username str
backup_hour str
backup_minute str
enable_ipv6 str
ip_filters Sequence[str]
migration GetPgPgUserConfigMigration
pg GetPgPgUserConfigPg

PostgreSQL specific server provided values

pg_read_replica str
pg_service_to_fork_from str
pg_stat_monitor_enable str
pg_version str
pgbouncer GetPgPgUserConfigPgbouncer
pglookout GetPgPgUserConfigPglookout
private_access GetPgPgUserConfigPrivateAccess
privatelink_access GetPgPgUserConfigPrivatelinkAccess
project_to_fork_from str
public_access GetPgPgUserConfigPublicAccess
recovery_target_time str
service_to_fork_from str
shared_buffers_percentage str
static_ips str

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

synchronous_replication str
timescaledb GetPgPgUserConfigTimescaledb
variant str
work_mem str
adminPassword String
adminUsername String
backupHour String
backupMinute String
enableIpv6 String
ipFilters List<String>
migration Property Map
pg Property Map

PostgreSQL specific server provided values

pgReadReplica String
pgServiceToForkFrom String
pgStatMonitorEnable String
pgVersion String
pgbouncer Property Map
pglookout Property Map
privateAccess Property Map
privatelinkAccess Property Map
projectToForkFrom String
publicAccess Property Map
recoveryTargetTime String
serviceToForkFrom String
sharedBuffersPercentage String
staticIps String

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

synchronousReplication String
timescaledb Property Map
variant String
workMem String

GetPgPgUserConfigMigration

Dbname string
Host string
IgnoreDbs string
Method string
Password string
Port string
Ssl string
Username string
Dbname string
Host string
IgnoreDbs string
Method string
Password string
Port string
Ssl string
Username string
dbname String
host String
ignoreDbs String
method String
password String
port String
ssl String
username String
dbname string
host string
ignoreDbs string
method string
password string
port string
ssl string
username string
dbname String
host String
ignoreDbs String
method String
password String
port String
ssl String
username String

GetPgPgUserConfigPg

AutovacuumAnalyzeScaleFactor string
AutovacuumAnalyzeThreshold string
AutovacuumFreezeMaxAge string
AutovacuumMaxWorkers string
AutovacuumNaptime string
AutovacuumVacuumCostDelay string
AutovacuumVacuumCostLimit string
AutovacuumVacuumScaleFactor string
AutovacuumVacuumThreshold string
BgwriterDelay string
BgwriterFlushAfter string
BgwriterLruMaxpages string
BgwriterLruMultiplier string
DeadlockTimeout string
DefaultToastCompression string
IdleInTransactionSessionTimeout string
Jit string
LogAutovacuumMinDuration string
LogErrorVerbosity string
LogLinePrefix string
LogMinDurationStatement string
LogTempFiles string
MaxFilesPerProcess string
MaxLocksPerTransaction string
MaxLogicalReplicationWorkers string
MaxParallelWorkers string
MaxParallelWorkersPerGather string
MaxPredLocksPerTransaction string
MaxPreparedTransactions string
MaxReplicationSlots string
MaxSlotWalKeepSize string
MaxStackDepth string
MaxStandbyArchiveDelay string
MaxStandbyStreamingDelay string
MaxWalSenders string
MaxWorkerProcesses string
PgPartmanBgwDotInterval string
PgPartmanBgwDotRole string
PgStatStatementsDotTrack string
TempFileLimit string
Timezone string
TrackActivityQuerySize string
TrackCommitTimestamp string
TrackFunctions string
TrackIoTiming string
WalSenderTimeout string
WalWriterDelay string
AutovacuumAnalyzeScaleFactor string
AutovacuumAnalyzeThreshold string
AutovacuumFreezeMaxAge string
AutovacuumMaxWorkers string
AutovacuumNaptime string
AutovacuumVacuumCostDelay string
AutovacuumVacuumCostLimit string
AutovacuumVacuumScaleFactor string
AutovacuumVacuumThreshold string
BgwriterDelay string
BgwriterFlushAfter string
BgwriterLruMaxpages string
BgwriterLruMultiplier string
DeadlockTimeout string
DefaultToastCompression string
IdleInTransactionSessionTimeout string
Jit string
LogAutovacuumMinDuration string
LogErrorVerbosity string
LogLinePrefix string
LogMinDurationStatement string
LogTempFiles string
MaxFilesPerProcess string
MaxLocksPerTransaction string
MaxLogicalReplicationWorkers string
MaxParallelWorkers string
MaxParallelWorkersPerGather string
MaxPredLocksPerTransaction string
MaxPreparedTransactions string
MaxReplicationSlots string
MaxSlotWalKeepSize string
MaxStackDepth string
MaxStandbyArchiveDelay string
MaxStandbyStreamingDelay string
MaxWalSenders string
MaxWorkerProcesses string
PgPartmanBgwDotInterval string
PgPartmanBgwDotRole string
PgStatStatementsDotTrack string
TempFileLimit string
Timezone string
TrackActivityQuerySize string
TrackCommitTimestamp string
TrackFunctions string
TrackIoTiming string
WalSenderTimeout string
WalWriterDelay string
autovacuumAnalyzeScaleFactor String
autovacuumAnalyzeThreshold String
autovacuumFreezeMaxAge String
autovacuumMaxWorkers String
autovacuumNaptime String
autovacuumVacuumCostDelay String
autovacuumVacuumCostLimit String
autovacuumVacuumScaleFactor String
autovacuumVacuumThreshold String
bgwriterDelay String
bgwriterFlushAfter String
bgwriterLruMaxpages String
bgwriterLruMultiplier String
deadlockTimeout String
defaultToastCompression String
idleInTransactionSessionTimeout String
jit String
logAutovacuumMinDuration String
logErrorVerbosity String
logLinePrefix String
logMinDurationStatement String
logTempFiles String
maxFilesPerProcess String
maxLocksPerTransaction String
maxLogicalReplicationWorkers String
maxParallelWorkers String
maxParallelWorkersPerGather String
maxPredLocksPerTransaction String
maxPreparedTransactions String
maxReplicationSlots String
maxSlotWalKeepSize String
maxStackDepth String
maxStandbyArchiveDelay String
maxStandbyStreamingDelay String
maxWalSenders String
maxWorkerProcesses String
pgPartmanBgwDotInterval String
pgPartmanBgwDotRole String
pgStatStatementsDotTrack String
tempFileLimit String
timezone String
trackActivityQuerySize String
trackCommitTimestamp String
trackFunctions String
trackIoTiming String
walSenderTimeout String
walWriterDelay String
autovacuumAnalyzeScaleFactor string
autovacuumAnalyzeThreshold string
autovacuumFreezeMaxAge string
autovacuumMaxWorkers string
autovacuumNaptime string
autovacuumVacuumCostDelay string
autovacuumVacuumCostLimit string
autovacuumVacuumScaleFactor string
autovacuumVacuumThreshold string
bgwriterDelay string
bgwriterFlushAfter string
bgwriterLruMaxpages string
bgwriterLruMultiplier string
deadlockTimeout string
defaultToastCompression string
idleInTransactionSessionTimeout string
jit string
logAutovacuumMinDuration string
logErrorVerbosity string
logLinePrefix string
logMinDurationStatement string
logTempFiles string
maxFilesPerProcess string
maxLocksPerTransaction string
maxLogicalReplicationWorkers string
maxParallelWorkers string
maxParallelWorkersPerGather string
maxPredLocksPerTransaction string
maxPreparedTransactions string
maxReplicationSlots string
maxSlotWalKeepSize string
maxStackDepth string
maxStandbyArchiveDelay string
maxStandbyStreamingDelay string
maxWalSenders string
maxWorkerProcesses string
pgPartmanBgwDotInterval string
pgPartmanBgwDotRole string
pgStatStatementsDotTrack string
tempFileLimit string
timezone string
trackActivityQuerySize string
trackCommitTimestamp string
trackFunctions string
trackIoTiming string
walSenderTimeout string
walWriterDelay string
autovacuum_analyze_scale_factor str
autovacuum_analyze_threshold str
autovacuum_freeze_max_age str
autovacuum_max_workers str
autovacuum_naptime str
autovacuum_vacuum_cost_delay str
autovacuum_vacuum_cost_limit str
autovacuum_vacuum_scale_factor str
autovacuum_vacuum_threshold str
bgwriter_delay str
bgwriter_flush_after str
bgwriter_lru_maxpages str
bgwriter_lru_multiplier str
deadlock_timeout str
default_toast_compression str
idle_in_transaction_session_timeout str
jit str
log_autovacuum_min_duration str
log_error_verbosity str
log_line_prefix str
log_min_duration_statement str
log_temp_files str
max_files_per_process str
max_locks_per_transaction str
max_logical_replication_workers str
max_parallel_workers str
max_parallel_workers_per_gather str
max_pred_locks_per_transaction str
max_prepared_transactions str
max_replication_slots str
max_slot_wal_keep_size str
max_stack_depth str
max_standby_archive_delay str
max_standby_streaming_delay str
max_wal_senders str
max_worker_processes str
pg_partman_bgw_dot_interval str
pg_partman_bgw_dot_role str
pg_stat_statements_dot_track str
temp_file_limit str
timezone str
track_activity_query_size str
track_commit_timestamp str
track_functions str
track_io_timing str
wal_sender_timeout str
wal_writer_delay str
autovacuumAnalyzeScaleFactor String
autovacuumAnalyzeThreshold String
autovacuumFreezeMaxAge String
autovacuumMaxWorkers String
autovacuumNaptime String
autovacuumVacuumCostDelay String
autovacuumVacuumCostLimit String
autovacuumVacuumScaleFactor String
autovacuumVacuumThreshold String
bgwriterDelay String
bgwriterFlushAfter String
bgwriterLruMaxpages String
bgwriterLruMultiplier String
deadlockTimeout String
defaultToastCompression String
idleInTransactionSessionTimeout String
jit String
logAutovacuumMinDuration String
logErrorVerbosity String
logLinePrefix String
logMinDurationStatement String
logTempFiles String
maxFilesPerProcess String
maxLocksPerTransaction String
maxLogicalReplicationWorkers String
maxParallelWorkers String
maxParallelWorkersPerGather String
maxPredLocksPerTransaction String
maxPreparedTransactions String
maxReplicationSlots String
maxSlotWalKeepSize String
maxStackDepth String
maxStandbyArchiveDelay String
maxStandbyStreamingDelay String
maxWalSenders String
maxWorkerProcesses String
pgPartmanBgwDotInterval String
pgPartmanBgwDotRole String
pgStatStatementsDotTrack String
tempFileLimit String
timezone String
trackActivityQuerySize String
trackCommitTimestamp String
trackFunctions String
trackIoTiming String
walSenderTimeout String
walWriterDelay String

GetPgPgUserConfigPgbouncer

GetPgPgUserConfigPglookout

GetPgPgUserConfigPrivateAccess

Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String
pg string

PostgreSQL specific server provided values

pgbouncer string
prometheus string
pg str

PostgreSQL specific server provided values

pgbouncer str
prometheus str
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String

GetPgPgUserConfigPrivatelinkAccess

Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String
pg string

PostgreSQL specific server provided values

pgbouncer string
prometheus string
pg str

PostgreSQL specific server provided values

pgbouncer str
prometheus str
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String

GetPgPgUserConfigPublicAccess

Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
Pg string

PostgreSQL specific server provided values

Pgbouncer string
Prometheus string
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String
pg string

PostgreSQL specific server provided values

pgbouncer string
prometheus string
pg str

PostgreSQL specific server provided values

pgbouncer str
prometheus str
pg String

PostgreSQL specific server provided values

pgbouncer String
prometheus String

GetPgPgUserConfigTimescaledb

GetPgServiceIntegration

GetPgTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes

This Pulumi package is based on the aiven Terraform Provider.