ionoscloud.dbaas.getPSQLCluster

Explore with Pulumi AI

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

The DbaaS Postgres Cluster data source can be used to search for and return an existing DbaaS Postgres Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

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

const example = ionoscloud.dbaas.getPSQLCluster({
    id: "cluster_id",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.dbaas.get_psql_cluster(id="cluster_id")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/dbaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbaas.LookupPSQLCluster(ctx, &dbaas.LookupPSQLClusterArgs{
			Id: pulumi.StringRef("cluster_id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Dbaas.GetPSQLCluster.Invoke(new()
    {
        Id = "cluster_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.dbaas.DbaasFunctions;
import com.pulumi.ionoscloud.dbaas.inputs.GetPSQLClusterArgs;
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 example = DbaasFunctions.getPSQLCluster(GetPSQLClusterArgs.builder()
            .id("cluster_id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:dbaas:getPSQLCluster
      arguments:
        id: cluster_id

By Name

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

const example = ionoscloud.dbaas.getPSQLCluster({
    displayName: "PostgreSQL_cluster",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.dbaas.get_psql_cluster(display_name="PostgreSQL_cluster")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/dbaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbaas.LookupPSQLCluster(ctx, &dbaas.LookupPSQLClusterArgs{
			DisplayName: pulumi.StringRef("PostgreSQL_cluster"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Dbaas.GetPSQLCluster.Invoke(new()
    {
        DisplayName = "PostgreSQL_cluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.dbaas.DbaasFunctions;
import com.pulumi.ionoscloud.dbaas.inputs.GetPSQLClusterArgs;
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 example = DbaasFunctions.getPSQLCluster(GetPSQLClusterArgs.builder()
            .displayName("PostgreSQL_cluster")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:dbaas:getPSQLCluster
      arguments:
        displayName: PostgreSQL_cluster

Using getPSQLCluster

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 getPSQLCluster(args: GetPSQLClusterArgs, opts?: InvokeOptions): Promise<GetPSQLClusterResult>
function getPSQLClusterOutput(args: GetPSQLClusterOutputArgs, opts?: InvokeOptions): Output<GetPSQLClusterResult>

def get_psql_cluster(display_name: Optional[str] = None,
                     id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPSQLClusterResult
def get_psql_cluster_output(display_name: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPSQLClusterResult]

func LookupPSQLCluster(ctx *Context, args *LookupPSQLClusterArgs, opts ...InvokeOption) (*LookupPSQLClusterResult, error)
func LookupPSQLClusterOutput(ctx *Context, args *LookupPSQLClusterOutputArgs, opts ...InvokeOption) LookupPSQLClusterResultOutput

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

public static class GetPSQLCluster 
{
    public static Task<GetPSQLClusterResult> InvokeAsync(GetPSQLClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetPSQLClusterResult> Invoke(GetPSQLClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPSQLClusterResult> getPSQLCluster(GetPSQLClusterArgs args, InvokeOptions options)
public static Output<GetPSQLClusterResult> getPSQLCluster(GetPSQLClusterArgs args, InvokeOptions options)

fn::invoke:
  function: ionoscloud:dbaas/getPSQLCluster:getPSQLCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

DisplayName string

Display Name of an existing cluster that you want to search for.

Id string