1. Packages
  2. Aiven Provider
  3. API Docs
  4. getClickhouseDatabase
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.getClickhouseDatabase

aiven logo
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Gets information about an Aiven for ClickHouse database.

    Example Usage

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

const exampleClickhouseDb = aiven.getClickhouseDatabase({
    project: exampleProject.project,
    serviceName: exampleClickhouse.serviceName,
    name: "example-database",
});

    import pulumi
import pulumi_aiven as aiven

example_clickhouse_db = aiven.get_clickhouse_database(project=example_project["project"],
    service_name=example_clickhouse["serviceName"],
    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.LookupClickhouseDatabase(ctx, &aiven.LookupClickhouseDatabaseArgs{
			Project:     exampleProject.Project,
			ServiceName: exampleClickhouse.ServiceName,
			Name:        "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 exampleClickhouseDb = Aiven.GetClickhouseDatabase.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleClickhouse.ServiceName,
        Name = "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.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 exampleClickhouseDb = AivenFunctions.getClickhouseDatabase(GetClickhouseDatabaseArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleClickhouse.serviceName())
            .name("example-database")
            .build());

    }
}

    variables:
  exampleClickhouseDb:
    fn::invoke:
      function: aiven:getClickhouseDatabase
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleClickhouse.serviceName}
        name: example-database

    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,
                            timeouts: Optional[GetClickhouseDatabaseTimeouts] = 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,
                            timeouts: Optional[pulumi.Input[GetClickhouseDatabaseTimeoutsArgs]] = 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
    Service database name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetClickhouseDatabaseTimeouts
    Name string
    Service database name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetClickhouseDatabaseTimeouts
    name String
    Service database name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetClickhouseDatabaseTimeouts
    name string
    Service database name.
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetClickhouseDatabaseTimeouts
    name str
    Service database name.
    project str
    Project name.
    service_name str
    Service name.
    timeouts GetClickhouseDatabaseTimeouts
    name String
    Service database name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map

    getClickhouseDatabase Result

    The following output properties are available:

    Id string
    Resource ID composed as: project/service_name/name.
    Name string
    Service database name.
    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 GetClickhouseDatabaseTimeouts
    Id string
    Resource ID composed as: project/service_name/name.
    Name string
    Service database name.
    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 GetClickhouseDatabaseTimeouts
    id String
    Resource ID composed as: project/service_name/name.
    name String
    Service database name.
    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 GetClickhouseDatabaseTimeouts
    id string
    Resource ID composed as: project/service_name/name.
    name string
    Service database name.
    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 GetClickhouseDatabaseTimeouts
    id str
    Resource ID composed as: project/service_name/name.
    name str
    Service database name.
    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 GetClickhouseDatabaseTimeouts
    id String
    Resource ID composed as: project/service_name/name.
    name String
    Service database name.
    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

    GetClickhouseDatabaseTimeouts

    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.
    aiven logo
    Viewing docs for Aiven v6.51.0
    published on Tuesday, Mar 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.