Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getClickhouseDatabase
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getClickhouseDatabase

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

Gets information about a 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",
});
Copy
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")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupClickhouseDatabase(ctx *Context, args *LookupClickhouseDatabaseArgs, opts ...InvokeOption) (*LookupClickhouseDatabaseResult, error)
func LookupClickhouseDatabaseOutput(ctx *Context, args *LookupClickhouseDatabaseOutputArgs, opts ...InvokeOption) LookupClickhouseDatabaseResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetClickhouseDatabaseResult> getClickhouseDatabase(GetClickhouseDatabaseArgs args, InvokeOptions options)
public static Output<GetClickhouseDatabaseResult> getClickhouseDatabase(GetClickhouseDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aiven:index/getClickhouseDatabase:getClickhouseDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the ClickHouse database. Changing this property forces recreation of the resource.
Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Name This property is required. string
The name of the ClickHouse database. Changing this property forces recreation of the resource.
Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
name This property is required. String
The name of the ClickHouse database. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
name This property is required. string
The name of the ClickHouse database. Changing this property forces recreation of the resource.
project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
name This property is required. str
The name of the ClickHouse database. Changing this property forces recreation of the resource.
project This property is required. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name This property is required. str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
name This property is required. String
The name of the ClickHouse database. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
project str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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. Changing this property forces recreation of the resource.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
terminationProtection Boolean

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven