Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. PgDatabase
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.PgDatabase

Explore with Pulumi AI

aiven logo
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

    Creates and manages a database in an Aiven for PostgreSQL® service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const main = new aiven.PgDatabase("main", {
    project: exampleProject.project,
    serviceName: examplePostgres.serviceName,
    databaseName: "example-database",
});

    import pulumi
import pulumi_aiven as aiven

main = aiven.PgDatabase("main",
    project=example_project["project"],
    service_name=example_postgres["serviceName"],
    database_name="example-database")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewPgDatabase(ctx, "main", &aiven.PgDatabaseArgs{
			Project:      pulumi.Any(exampleProject.Project),
			ServiceName:  pulumi.Any(examplePostgres.ServiceName),
			DatabaseName: pulumi.String("example-database"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var main = new Aiven.PgDatabase("main", new()
    {
        Project = exampleProject.Project,
        ServiceName = examplePostgres.ServiceName,
        DatabaseName = "example-database",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.PgDatabase;
import com.pulumi.aiven.PgDatabaseArgs;
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) {
        var main = new PgDatabase("main", PgDatabaseArgs.builder()
            .project(exampleProject.project())
            .serviceName(examplePostgres.serviceName())
            .databaseName("example-database")
            .build());

    }
}

    resources:
  main:
    type: aiven:PgDatabase
    properties:
      project: ${exampleProject.project}
      serviceName: ${examplePostgres.serviceName}
      databaseName: example-database

    Create PgDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PgDatabase(name: string, args: PgDatabaseArgs, opts?: CustomResourceOptions);
    @overload
def PgDatabase(resource_name: str,
               args: PgDatabaseArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def PgDatabase(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               database_name: Optional[str] = None,
               project: Optional[str] = None,
               service_name: Optional[str] = None,
               lc_collate: Optional[str] = None,
               lc_ctype: Optional[str] = None,
               termination_protection: Optional[bool] = None)
    func NewPgDatabase(ctx *Context, name string, args PgDatabaseArgs, opts ...ResourceOption) (*PgDatabase, error)
    public PgDatabase(string name, PgDatabaseArgs args, CustomResourceOptions? opts = null)
    public PgDatabase(String name, PgDatabaseArgs args)
public PgDatabase(String name, PgDatabaseArgs args, CustomResourceOptions options)

    type: aiven:PgDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PgDatabaseArgs
    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 PgDatabaseArgs
    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 PgDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PgDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PgDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var pgDatabaseResource = new Aiven.PgDatabase("pgDatabaseResource", new()
{
    DatabaseName = "string",
    Project = "string",
    ServiceName = "string",
    LcCollate = "string",
    LcCtype = "string",
    TerminationProtection = false,
});

    example, err := aiven.NewPgDatabase(ctx, "pgDatabaseResource", &aiven.PgDatabaseArgs{
	DatabaseName:          pulumi.String("string"),
	Project:               pulumi.String("string"),
	ServiceName:           pulumi.String("string"),
	LcCollate:             pulumi.String("string"),
	LcCtype:               pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

    var pgDatabaseResource = new PgDatabase("pgDatabaseResource", PgDatabaseArgs.builder()
    .databaseName("string")
    .project("string")
    .serviceName("string")
    .lcCollate("string")
    .lcCtype("string")
    .terminationProtection(false)
    .build());

    pg_database_resource = aiven.PgDatabase("pgDatabaseResource",
    database_name="string",
    project="string",
    service_name="string",
    lc_collate="string",
    lc_ctype="string",
    termination_protection=False)

    const pgDatabaseResource = new aiven.PgDatabase("pgDatabaseResource", {
    databaseName: "string",
    project: "string",
    serviceName: "string",
    lcCollate: "string",
    lcCtype: "string",
    terminationProtection: false,
});

    type: aiven:PgDatabase
properties:
    databaseName: string
    lcCollate: string
    lcCtype: string
    project: string
    serviceName: string
    terminationProtection: false

    PgDatabase Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PgDatabase resource accepts the following input properties:

    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    TerminationProtection bool
    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    TerminationProtection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    terminationProtection Boolean
    databaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    lcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    terminationProtection boolean
    database_name str
    The name of the service database. Changing this property forces recreation of the resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    lc_collate str
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lc_ctype str
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    termination_protection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    terminationProtection Boolean

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PgDatabase Resource

    Get an existing PgDatabase 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?: PgDatabaseState, opts?: CustomResourceOptions): PgDatabase
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        lc_collate: Optional[str] = None,
        lc_ctype: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        termination_protection: Optional[bool] = None) -> PgDatabase
    func GetPgDatabase(ctx *Context, name string, id IDInput, state *PgDatabaseState, opts ...ResourceOption) (*PgDatabase, error)
    public static PgDatabase Get(string name, Input<string> id, PgDatabaseState? state, CustomResourceOptions? opts = null)
    public static PgDatabase get(String name, Output<String> id, PgDatabaseState state, CustomResourceOptions options)
    resources:  _:    type: aiven:PgDatabase    get:      id: ${id}
    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:
    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    TerminationProtection bool
    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    TerminationProtection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection Boolean
    databaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    lcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection boolean
    database_name str
    The name of the service database. Changing this property forces recreation of the resource.
    lc_collate str
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lc_ctype str
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    termination_protection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection Boolean

    Import

    $ pulumi import aiven:index/pgDatabase:PgDatabase main PROJECT/SERVICE_NAME/DATABASE_NAME

    To learn more about importing existing cloud resources, see Importing resources.

    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.37.0 published on Thursday, Apr 10, 2025 by Pulumi
    pulumi/pulumi-aiven