ClickhouseUser

Aiven v4.5.2 (4.x), Mar 9 26

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

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

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

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var ch_user = new Aiven.ClickhouseUser("ch-user", new Aiven.ClickhouseUserArgs
        {
            Project = aiven_project.Myproject.Project,
            ServiceName = aiven_clickhouse.Myservice.Service_name,
            Username = "<USERNAME>",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v4/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewClickhouseUser(ctx, "ch-user", &aiven.ClickhouseUserArgs{
			Project:     pulumi.Any(aiven_project.Myproject.Project),
			ServiceName: pulumi.Any(aiven_clickhouse.Myservice.Service_name),
			Username:    pulumi.String("<USERNAME>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

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

import pulumi
import pulumi_aiven as aiven

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

Example coming soon!

Create ClickhouseUser Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClickhouseUser(name: string, args: ClickhouseUserArgs, opts?: CustomResourceOptions);

@overload
def ClickhouseUser(resource_name: str,
                   args: ClickhouseUserArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ClickhouseUser(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project: Optional[str] = None,
                   service_name: Optional[str] = None,
                   username: Optional[str] = None)

func NewClickhouseUser(ctx *Context, name string, args ClickhouseUserArgs, opts ...ResourceOption) (*ClickhouseUser, error)

public ClickhouseUser(string name, ClickhouseUserArgs args, CustomResourceOptions? opts = null)

public ClickhouseUser(String name, ClickhouseUserArgs args)
public ClickhouseUser(String name, ClickhouseUserArgs args, CustomResourceOptions options)

type: aiven:ClickhouseUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ClickhouseUserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ClickhouseUserArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClickhouseUserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClickhouseUserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClickhouseUserArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var clickhouseUserResource = new Aiven.ClickhouseUser("clickhouseUserResource", new()
{
    Project = "string",
    ServiceName = "string",
    Username = "string",
});

example, err := aiven.NewClickhouseUser(ctx, "clickhouseUserResource", &aiven.ClickhouseUserArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Username:    pulumi.String("string"),
})

var clickhouseUserResource = new ClickhouseUser("clickhouseUserResource", ClickhouseUserArgs.builder()
    .project("string")
    .serviceName("string")
    .username("string")
    .build());

clickhouse_user_resource = aiven.ClickhouseUser("clickhouseUserResource",
    project="string",
    service_name="string",
    username="string")

const clickhouseUserResource = new aiven.ClickhouseUser("clickhouseUserResource", {
    project: "string",
    serviceName: "string",
    username: "string",
});

type: aiven:ClickhouseUser
properties:
    project: string
    serviceName: string
    username: string

ClickhouseUser Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ClickhouseUser resource accepts the following input properties:

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClickhouseUser resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Password string: The password of the clickhouse user.
Required bool: Indicates if a clickhouse user is required
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.
Required bool: Indicates if a clickhouse user is required
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.
required Boolean: Indicates if a clickhouse user is required
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.
required boolean: Indicates if a clickhouse user is required
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.
required bool: Indicates if a clickhouse user is required
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.
required Boolean: Indicates if a clickhouse user is required
uuid String: UUID of the clickhouse user.

Look up Existing ClickhouseUser Resource

Get an existing ClickhouseUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClickhouseUserState, opts?: CustomResourceOptions): ClickhouseUser

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        project: Optional[str] = None,
        required: Optional[bool] = None,
        service_name: Optional[str] = None,
        username: Optional[str] = None,
        uuid: Optional[str] = None) -> ClickhouseUser

func GetClickhouseUser(ctx *Context, name string, id IDInput, state *ClickhouseUserState, opts ...ResourceOption) (*ClickhouseUser, error)

public static ClickhouseUser Get(string name, Input<string> id, ClickhouseUserState? state, CustomResourceOptions? opts = null)

public static ClickhouseUser get(String name, Output<String> id, ClickhouseUserState state, CustomResourceOptions options)

resources:  _:    type: aiven:ClickhouseUser    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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.

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.

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.

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.

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.

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.