aiven.getClickhouseDatabase (v5)

Aiven v5.6.0 (5.x), Mar 9 26

Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var clickhouseDb = Aiven.GetClickhouseDatabase.Invoke(new()
    {
        Project = aiven_clickhouse.Ch.Project,
        ServiceName = aiven_clickhouse.Ch.Service_name,
        Name = "my-ch-db",
    });

});

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.LookupClickhouseDatabase(ctx, &aiven.LookupClickhouseDatabaseArgs{
			Project:     aiven_clickhouse.Ch.Project,
			ServiceName: aiven_clickhouse.Ch.Service_name,
			Name:        "my-ch-db",
		}, 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.GetClickhouseDatabaseArgs;
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 clickhouseDb = AivenFunctions.getClickhouseDatabase(GetClickhouseDatabaseArgs.builder()
            .project(aiven_clickhouse.ch().project())
            .serviceName(aiven_clickhouse.ch().service_name())
            .name("my-ch-db")
            .build());

    }
}

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

const clickhouseDb = aiven.getClickhouseDatabase({
    project: aiven_clickhouse.ch.project,
    serviceName: aiven_clickhouse.ch.service_name,
    name: "my-ch-db",
});

import pulumi
import pulumi_aiven as aiven

clickhouse_db = aiven.get_clickhouse_database(project=aiven_clickhouse["ch"]["project"],
    service_name=aiven_clickhouse["ch"]["service_name"],
    name="my-ch-db")

variables:
  clickhouseDb:
    fn::invoke:
      Function: aiven:getClickhouseDatabase
      Arguments:
        project: ${aiven_clickhouse.ch.project}
        serviceName: ${aiven_clickhouse.ch.service_name}
        name: my-ch-db

Using getClickhouseDatabase

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 getClickhouseDatabase(args: GetClickhouseDatabaseArgs, opts?: InvokeOptions): Promise<GetClickhouseDatabaseResult>
function getClickhouseDatabaseOutput(args: GetClickhouseDatabaseOutputArgs, opts?: InvokeOptions): Output<GetClickhouseDatabaseResult>

def get_clickhouse_database(name: Optional[str] = None,
                            project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetClickhouseDatabaseResult
def get_clickhouse_database_output(name: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            service_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetClickhouseDatabaseResult]

func LookupClickhouseDatabase(ctx *Context, args *LookupClickhouseDatabaseArgs, opts ...InvokeOption) (*LookupClickhouseDatabaseResult, error)
func LookupClickhouseDatabaseOutput(ctx *Context, args *LookupClickhouseDatabaseOutputArgs, opts ...InvokeOption) LookupClickhouseDatabaseResultOutput

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

public static class GetClickhouseDatabase 
{
    public static Task<GetClickhouseDatabaseResult> InvokeAsync(GetClickhouseDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetClickhouseDatabaseResult> Invoke(GetClickhouseDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClickhouseDatabaseResult> getClickhouseDatabase(GetClickhouseDatabaseArgs args, InvokeOptions options)
public static Output<GetClickhouseDatabaseResult> getClickhouseDatabase(GetClickhouseDatabaseArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

Name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

name String: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

name str: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

name String: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.

getClickhouseDatabase Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
TerminationProtection bool

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
TerminationProtection bool

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
terminationProtection Boolean

id string: The provider-assigned unique ID for this managed resource.
name string: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
terminationProtection boolean

id str: The provider-assigned unique ID for this managed resource.
name str: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
termination_protection bool

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
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 name of the service that 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.
terminationProtection Boolean