getPgDatabase

Aiven v6.51.0, Mar 17 26

Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Example Usage

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

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

import pulumi
import pulumi_aiven as aiven

main = aiven.get_pg_database(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.LookupPgDatabase(ctx, &aiven.LookupPgDatabaseArgs{
			Project:      exampleProject.Project,
			ServiceName:  examplePostgres.ServiceName,
			DatabaseName: "example-database",
		}, nil)
		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 = Aiven.GetPgDatabase.Invoke(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.AivenFunctions;
import com.pulumi.aiven.inputs.GetPgDatabaseArgs;
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 main = AivenFunctions.getPgDatabase(GetPgDatabaseArgs.builder()
            .project(exampleProject.project())
            .serviceName(examplePostgres.serviceName())
            .databaseName("example-database")
            .build());

    }
}

variables:
  main:
    fn::invoke:
      function: aiven:getPgDatabase
      arguments:
        project: ${exampleProject.project}
        serviceName: ${examplePostgres.serviceName}
        databaseName: example-database

Using getPgDatabase

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 getPgDatabase(args: GetPgDatabaseArgs, opts?: InvokeOptions): Promise<GetPgDatabaseResult>
function getPgDatabaseOutput(args: GetPgDatabaseOutputArgs, opts?: InvokeOptions): Output<GetPgDatabaseResult>

def get_pg_database(database_name: Optional[str] = None,
                    project: Optional[str] = None,
                    service_name: Optional[str] = None,
                    timeouts: Optional[GetPgDatabaseTimeouts] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPgDatabaseResult
def get_pg_database_output(database_name: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    timeouts: Optional[pulumi.Input[GetPgDatabaseTimeoutsArgs]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPgDatabaseResult]

func LookupPgDatabase(ctx *Context, args *LookupPgDatabaseArgs, opts ...InvokeOption) (*LookupPgDatabaseResult, error)
func LookupPgDatabaseOutput(ctx *Context, args *LookupPgDatabaseOutputArgs, opts ...InvokeOption) LookupPgDatabaseResultOutput

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

public static class GetPgDatabase 
{
    public static Task<GetPgDatabaseResult> InvokeAsync(GetPgDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetPgDatabaseResult> Invoke(GetPgDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPgDatabaseResult> getPgDatabase(GetPgDatabaseArgs args, InvokeOptions options)
public static Output<GetPgDatabaseResult> getPgDatabase(GetPgDatabaseArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getPgDatabase:getPgDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseName string: Service database name.
Project string: Project name.
ServiceName string: Service name.
Timeouts GetPgDatabaseTimeouts

DatabaseName string: Service database name.
Project string: Project name.
ServiceName string: Service name.
Timeouts GetPgDatabaseTimeouts

databaseName String: Service database name.
project String: Project name.
serviceName String: Service name.
timeouts GetPgDatabaseTimeouts

databaseName string: Service database name.
project string: Project name.
serviceName string: Service name.
timeouts GetPgDatabaseTimeouts

database_name str: Service database name.
project str: Project name.
service_name str: Service name.
timeouts GetPgDatabaseTimeouts

databaseName String: Service database name.
project String: Project name.
serviceName String: Service name.
timeouts Property Map

getPgDatabase Result

The following output properties are available:

DatabaseName string: Service database name.
Id string: Resource ID composed as: project/service_name/database_name.
LcCollate string: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
LcCtype string: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
Project string: Project name.
ServiceName string: Service name.
TerminationProtection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
Timeouts GetPgDatabaseTimeouts

DatabaseName string: Service database name.
Id string: Resource ID composed as: project/service_name/database_name.
LcCollate string: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
LcCtype string: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
Project string: Project name.
ServiceName string: Service name.
TerminationProtection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
Timeouts GetPgDatabaseTimeouts

databaseName String: Service database name.
id String: Resource ID composed as: project/service_name/database_name.
lcCollate String: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
lcCtype String: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
project String: Project name.
serviceName String: Service name.
terminationProtection Boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
timeouts GetPgDatabaseTimeouts

databaseName string: Service database name.
id string: Resource ID composed as: project/service_name/database_name.
lcCollate string: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
lcCtype string: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
project string: Project name.
serviceName string: Service name.
terminationProtection boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
timeouts GetPgDatabaseTimeouts

database_name str: Service database name.
id str: Resource ID composed as: project/service_name/database_name.
lc_collate str: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
lc_ctype str: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
project str: Project name.
service_name str: Service name.
termination_protection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
timeouts GetPgDatabaseTimeouts

databaseName String: Service database name.
id String: Resource ID composed as: project/service_name/database_name.
lcCollate String: Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8.
lcCtype String: Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8.
project String: Project name.
serviceName String: Service name.
terminationProtection Boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy
Deprecated: Instead, use prevent_destroy
timeouts Property Map

Supporting Types

GetPgDatabaseTimeouts

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

aiven.getPgDatabase

On this page

On this page

Example Usage

Using getPgDatabase

getPgDatabase Result

Supporting Types

GetPgDatabaseTimeouts

Package Details

On this page

On this page