aiven.getClickhouseUser (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 ch_user = Aiven.GetClickhouseUser.Invoke(new()
    {
        Project = aiven_project.Myproject.Project,
        ServiceName = aiven_clickhouse.Myservice.Service_name,
        Username = "<USERNAME>",
    });

});

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.LookupClickhouseUser(ctx, &aiven.LookupClickhouseUserArgs{
			Project:     aiven_project.Myproject.Project,
			ServiceName: aiven_clickhouse.Myservice.Service_name,
			Username:    "<USERNAME>",
		}, 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.GetClickhouseUserArgs;
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 ch-user = AivenFunctions.getClickhouseUser(GetClickhouseUserArgs.builder()
            .project(aiven_project.myproject().project())
            .serviceName(aiven_clickhouse.myservice().service_name())
            .username("<USERNAME>")
            .build());

    }
}

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

const ch-user = aiven.getClickhouseUser({
    project: aiven_project.myproject.project,
    serviceName: aiven_clickhouse.myservice.service_name,
    username: "<USERNAME>",
});

import pulumi
import pulumi_aiven as aiven

ch_user = aiven.get_clickhouse_user(project=aiven_project["myproject"]["project"],
    service_name=aiven_clickhouse["myservice"]["service_name"],
    username="<USERNAME>")

variables:
  ch-user:
    fn::invoke:
      Function: aiven:getClickhouseUser
      Arguments:
        project: ${aiven_project.myproject.project}
        serviceName: ${aiven_clickhouse.myservice.service_name}
        username: <USERNAME>

Using getClickhouseUser

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 getClickhouseUser(args: GetClickhouseUserArgs, opts?: InvokeOptions): Promise<GetClickhouseUserResult>
function getClickhouseUserOutput(args: GetClickhouseUserOutputArgs, opts?: InvokeOptions): Output<GetClickhouseUserResult>

def get_clickhouse_user(project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        username: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetClickhouseUserResult
def get_clickhouse_user_output(project: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        username: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetClickhouseUserResult]

func LookupClickhouseUser(ctx *Context, args *LookupClickhouseUserArgs, opts ...InvokeOption) (*LookupClickhouseUserResult, error)
func LookupClickhouseUserOutput(ctx *Context, args *LookupClickhouseUserOutputArgs, opts ...InvokeOption) LookupClickhouseUserResultOutput

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

public static class GetClickhouseUser 
{
    public static Task<GetClickhouseUserResult> InvokeAsync(GetClickhouseUserArgs args, InvokeOptions? opts = null)
    public static Output<GetClickhouseUserResult> Invoke(GetClickhouseUserInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClickhouseUserResult> getClickhouseUser(GetClickhouseUserArgs args, InvokeOptions options)
public static Output<GetClickhouseUserResult> getClickhouseUser(GetClickhouseUserArgs args, InvokeOptions options)

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

The following arguments are supported:

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.
Username string: The actual name of the Clickhouse user. 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.
Username string: The actual name of the Clickhouse user. 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.
username String: The actual name of the Clickhouse user. 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.
username string: The actual name of the Clickhouse user. 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.
username str: The actual name of the Clickhouse user. 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.
username String: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.

getClickhouseUser Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Password string: The password of the clickhouse user.
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.
Required bool: Indicates if a clickhouse user is required
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.
Username string: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
Uuid string: UUID of the clickhouse user.

Id string: The provider-assigned unique ID for this managed resource.
Password string: The password of the clickhouse user.
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.
Required bool: Indicates if a clickhouse user is required
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.
Username string: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
Uuid string: UUID of the clickhouse user.

id String: The provider-assigned unique ID for this managed resource.
password String: The password of the clickhouse user.
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.
required Boolean: Indicates if a clickhouse user is required
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.
username String: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
uuid String: UUID of the clickhouse user.

id string: The provider-assigned unique ID for this managed resource.
password string: The password of the clickhouse user.
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.
required boolean: Indicates if a clickhouse user is required
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.
username string: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
uuid string: UUID of the clickhouse user.

id str: The provider-assigned unique ID for this managed resource.
password str: The password of the clickhouse user.
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.
required bool: Indicates if a clickhouse user is required
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.
username str: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
uuid str: UUID of the clickhouse user.

id String: The provider-assigned unique ID for this managed resource.
password String: The password of the clickhouse user.
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.
required Boolean: Indicates if a clickhouse user is required
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.
username String: The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
uuid String: UUID of the clickhouse user.