1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. getDatabases
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_postgresql.getDatabases

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rds postgresql databases

    Example Usage

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

const foo = volcengine.rds_postgresql.getDatabases({
    dbName: "test001",
    instanceId: "postgres-95******8233",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_postgresql.get_databases(db_name="test001",
    instance_id="postgres-95******8233")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_postgresql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_postgresql.GetDatabases(ctx, &rds_postgresql.GetDatabasesArgs{
			DbName:     pulumi.StringRef("test001"),
			InstanceId: "postgres-95******8233",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Rds_postgresql.GetDatabases.Invoke(new()
    {
        DbName = "test001",
        InstanceId = "postgres-95******8233",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_postgresql.Rds_postgresqlFunctions;
import com.pulumi.volcengine.rds_postgresql.inputs.GetDatabasesArgs;
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 foo = Rds_postgresqlFunctions.getDatabases(GetDatabasesArgs.builder()
            .dbName("test001")
            .instanceId("postgres-95******8233")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_postgresql:getDatabases
      Arguments:
        dbName: test001
        instanceId: postgres-95******8233

    Using getDatabases

    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 getDatabases(args: GetDatabasesArgs, opts?: InvokeOptions): Promise<GetDatabasesResult>
function getDatabasesOutput(args: GetDatabasesOutputArgs, opts?: InvokeOptions): Output<GetDatabasesResult>
    def get_databases(db_name: Optional[str] = None,
                  instance_id: Optional[str] = None,
                  output_file: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDatabasesResult
def get_databases_output(db_name: Optional[pulumi.Input[str]] = None,
                  instance_id: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDatabasesResult]
    func GetDatabases(ctx *Context, args *GetDatabasesArgs, opts ...InvokeOption) (*GetDatabasesResult, error)
func GetDatabasesOutput(ctx *Context, args *GetDatabasesOutputArgs, opts ...InvokeOption) GetDatabasesResultOutput

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

    public static class GetDatabases 
{
    public static Task<GetDatabasesResult> InvokeAsync(GetDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabasesResult> Invoke(GetDatabasesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)
public static Output<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds_postgresql/getDatabases:getDatabases
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of the RDS instance.
    DbName string
    The name of the RDS database.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The id of the RDS instance.
    DbName string
    The name of the RDS database.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The id of the RDS instance.
    dbName String
    The name of the RDS database.
    outputFile String
    File name where to save data source results.
    instanceId string
    The id of the RDS instance.
    dbName string
    The name of the RDS database.
    outputFile string
    File name where to save data source results.
    instance_id str
    The id of the RDS instance.
    db_name str
    The name of the RDS database.
    output_file str
    File name where to save data source results.
    instanceId String
    The id of the RDS instance.
    dbName String
    The name of the RDS database.
    outputFile String
    File name where to save data source results.

    getDatabases Result

    The following output properties are available:

    Databases List<GetDatabasesDatabase>
    The collection of RDS instance account query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of RDS database query.
    DbName string
    The name of the RDS database.
    OutputFile string
    Databases []GetDatabasesDatabase
    The collection of RDS instance account query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of RDS database query.
    DbName string
    The name of the RDS database.
    OutputFile string
    databases List<GetDatabasesDatabase>
    The collection of RDS instance account query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Integer
    The total count of RDS database query.
    dbName String
    The name of the RDS database.
    outputFile String
    databases GetDatabasesDatabase[]
    The collection of RDS instance account query.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    totalCount number
    The total count of RDS database query.
    dbName string
    The name of the RDS database.
    outputFile string
    databases Sequence[GetDatabasesDatabase]
    The collection of RDS instance account query.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    total_count int
    The total count of RDS database query.
    db_name str
    The name of the RDS database.
    output_file str
    databases List<Property Map>
    The collection of RDS instance account query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Number
    The total count of RDS database query.
    dbName String
    The name of the RDS database.
    outputFile String

    Supporting Types

    GetDatabasesDatabase

    CType string
    Character classification.
    CharacterSetName string
    The character set of the RDS database.
    Collate string
    The collate of database.
    DbName string
    The name of the RDS database.
    DbStatus string
    The status of the RDS database.
    Owner string
    The owner of database.
    CType string
    Character classification.
    CharacterSetName string
    The character set of the RDS database.
    Collate string
    The collate of database.
    DbName string
    The name of the RDS database.
    DbStatus string
    The status of the RDS database.
    Owner string
    The owner of database.
    cType String
    Character classification.
    characterSetName String
    The character set of the RDS database.
    collate String
    The collate of database.
    dbName String
    The name of the RDS database.
    dbStatus String
    The status of the RDS database.
    owner String
    The owner of database.
    cType string
    Character classification.
    characterSetName string
    The character set of the RDS database.
    collate string
    The collate of database.
    dbName string
    The name of the RDS database.
    dbStatus string
    The status of the RDS database.
    owner string
    The owner of database.
    c_type str
    Character classification.
    character_set_name str
    The character set of the RDS database.
    collate str
    The collate of database.
    db_name str
    The name of the RDS database.
    db_status str
    The status of the RDS database.
    owner str
    The owner of database.
    cType String
    Character classification.
    characterSetName String
    The character set of the RDS database.
    collate String
    The collate of database.
    dbName String
    The name of the RDS database.
    dbStatus String
    The status of the RDS database.
    owner String
    The owner of database.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate