1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getClickhouseUser
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi

    Gets information about an Aiven for ClickHouse user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const exampleUser = aiven.getClickhouseUser({
        project: exampleProject.project,
        serviceName: exampleClickhouse.serviceName,
        username: "analyst",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example_user = aiven.get_clickhouse_user(project=example_project["project"],
        service_name=example_clickhouse["serviceName"],
        username="analyst")
    
    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.GetClickhouseUser(ctx, &aiven.LookupClickhouseUserArgs{
    			Project:     exampleProject.Project,
    			ServiceName: exampleClickhouse.ServiceName,
    			Username:    pulumi.StringRef("analyst"),
    		}, 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 exampleUser = Aiven.Index.GetClickhouseUser.Invoke(new()
        {
            Project = exampleProject.Project,
            ServiceName = exampleClickhouse.ServiceName,
            Username = "analyst",
        });
    
    });
    
    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 exampleUser = AivenFunctions.getClickhouseUser(GetClickhouseUserArgs.builder()
                .project(exampleProject.project())
                .serviceName(exampleClickhouse.serviceName())
                .username("analyst")
                .build());
    
        }
    }
    
    variables:
      exampleUser:
        fn::invoke:
          function: aiven:getClickhouseUser
          arguments:
            project: ${exampleProject.project}
            serviceName: ${exampleClickhouse.serviceName}
            username: analyst
    

    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,
                            timeouts: Optional[GetClickhouseUserTimeouts] = None,
                            username: Optional[str] = None,
                            uuid: 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,
                            timeouts: Optional[pulumi.Input[GetClickhouseUserTimeoutsArgs]] = None,
                            username: Optional[pulumi.Input[str]] = None,
                            uuid: 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
    Project name.
    ServiceName string
    Service name.
    Timeouts GetClickhouseUserTimeouts
    Username string
    User name. Exactly one of the fields must be specified: uuid or username.
    Uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetClickhouseUserTimeouts
    Username string
    User name. Exactly one of the fields must be specified: uuid or username.
    Uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetClickhouseUserTimeouts
    username String
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid String
    User identifier. Exactly one of the fields must be specified: uuid or username.
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetClickhouseUserTimeouts
    username string
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    project str
    Project name.
    service_name str
    Service name.
    timeouts GetClickhouseUserTimeouts
    username str
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid str
    User identifier. Exactly one of the fields must be specified: uuid or username.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map
    username String
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid String
    User identifier. Exactly one of the fields must be specified: uuid or username.

    getClickhouseUser Result

    The following output properties are available:

    Id string
    Resource ID composed as: project/service_name/uuid.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    Project string
    Project name.
    Required bool
    Required user.
    ServiceName string
    Service name.
    Username string
    User name. Exactly one of the fields must be specified: uuid or username.
    Uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    Timeouts GetClickhouseUserTimeouts
    Id string
    Resource ID composed as: project/service_name/uuid.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    Project string
    Project name.
    Required bool
    Required user.
    ServiceName string
    Service name.
    Username string
    User name. Exactly one of the fields must be specified: uuid or username.
    Uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    Timeouts GetClickhouseUserTimeouts
    id String
    Resource ID composed as: project/service_name/uuid.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    project String
    Project name.
    required Boolean
    Required user.
    serviceName String
    Service name.
    username String
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid String
    User identifier. Exactly one of the fields must be specified: uuid or username.
    timeouts GetClickhouseUserTimeouts
    id string
    Resource ID composed as: project/service_name/uuid.
    password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    project string
    Project name.
    required boolean
    Required user.
    serviceName string
    Service name.
    username string
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid string
    User identifier. Exactly one of the fields must be specified: uuid or username.
    timeouts GetClickhouseUserTimeouts
    id str
    Resource ID composed as: project/service_name/uuid.
    password str
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    project str
    Project name.
    required bool
    Required user.
    service_name str
    Service name.
    username str
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid str
    User identifier. Exactly one of the fields must be specified: uuid or username.
    timeouts GetClickhouseUserTimeouts
    id String
    Resource ID composed as: project/service_name/uuid.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    project String
    Project name.
    required Boolean
    Required user.
    serviceName String
    Service name.
    username String
    User name. Exactly one of the fields must be specified: uuid or username.
    uuid String
    User identifier. Exactly one of the fields must be specified: uuid or username.
    timeouts Property Map

    Supporting Types

    GetClickhouseUserTimeouts

    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.53.1
    published on Thursday, Apr 23, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.