1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabaseClickhouseUser
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudProjectDatabaseClickhouseUser

ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Import

    OVHcloud Managed Clickhouse clusters users can be imported using the service_name, cluster_id and id of the user, separated by “/” E.g.,

    bash

    $ pulumi import ovh:index/cloudProjectDatabaseClickhouseUser:CloudProjectDatabaseClickhouseUser my_user service_name/cluster_id/id

    Create CloudProjectDatabaseClickhouseUser Resource

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

    Constructor syntax

    new CloudProjectDatabaseClickhouseUser(name: string, args: CloudProjectDatabaseClickhouseUserArgs, opts?: CustomResourceOptions);
    @overload
def CloudProjectDatabaseClickhouseUser(resource_name: str,
                                       args: CloudProjectDatabaseClickhouseUserArgs,
                                       opts: Optional[ResourceOptions] = None)

@overload
def CloudProjectDatabaseClickhouseUser(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       cluster_id: Optional[str] = None,
                                       name: Optional[str] = None,
                                       password_reset: Optional[str] = None,
                                       service_name: Optional[str] = None)
    func NewCloudProjectDatabaseClickhouseUser(ctx *Context, name string, args CloudProjectDatabaseClickhouseUserArgs, opts ...ResourceOption) (*CloudProjectDatabaseClickhouseUser, error)
    public CloudProjectDatabaseClickhouseUser(string name, CloudProjectDatabaseClickhouseUserArgs args, CustomResourceOptions? opts = null)
    public CloudProjectDatabaseClickhouseUser(String name, CloudProjectDatabaseClickhouseUserArgs args)
public CloudProjectDatabaseClickhouseUser(String name, CloudProjectDatabaseClickhouseUserArgs args, CustomResourceOptions options)

    type: ovh:CloudProjectDatabaseClickhouseUser
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 CloudProjectDatabaseClickhouseUserArgs
    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 CloudProjectDatabaseClickhouseUserArgs
    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 CloudProjectDatabaseClickhouseUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudProjectDatabaseClickhouseUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudProjectDatabaseClickhouseUserArgs
    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 cloudProjectDatabaseClickhouseUserResource = new Ovh.CloudProjectDatabaseClickhouseUser("cloudProjectDatabaseClickhouseUserResource", new()
{
    ClusterId = "string",
    Name = "string",
    PasswordReset = "string",
    ServiceName = "string",
});

    example, err := ovh.NewCloudProjectDatabaseClickhouseUser(ctx, "cloudProjectDatabaseClickhouseUserResource", &ovh.CloudProjectDatabaseClickhouseUserArgs{
	ClusterId:     pulumi.String("string"),
	Name:          pulumi.String("string"),
	PasswordReset: pulumi.String("string"),
	ServiceName:   pulumi.String("string"),
})

    var cloudProjectDatabaseClickhouseUserResource = new CloudProjectDatabaseClickhouseUser("cloudProjectDatabaseClickhouseUserResource", CloudProjectDatabaseClickhouseUserArgs.builder()
    .clusterId("string")
    .name("string")
    .passwordReset("string")
    .serviceName("string")
    .build());

    cloud_project_database_clickhouse_user_resource = ovh.CloudProjectDatabaseClickhouseUser("cloudProjectDatabaseClickhouseUserResource",
    cluster_id="string",
    name="string",
    password_reset="string",
    service_name="string")

    const cloudProjectDatabaseClickhouseUserResource = new ovh.CloudProjectDatabaseClickhouseUser("cloudProjectDatabaseClickhouseUserResource", {
    clusterId: "string",
    name: "string",
    passwordReset: "string",
    serviceName: "string",
});

    type: ovh:CloudProjectDatabaseClickhouseUser
properties:
    clusterId: string
    name: string
    passwordReset: string
    serviceName: string

    CloudProjectDatabaseClickhouseUser 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 CloudProjectDatabaseClickhouseUser resource accepts the following input properties:

    ClusterId string
    Cluster ID.
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    ClusterId string
    Cluster ID.
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID.
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId string
    Cluster ID.
    name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    cluster_id str
    Cluster ID.
    name str
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password_reset str
    Arbitrary string to change to trigger a password update
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID.
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    Outputs

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

    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Roles List<string>
    Roles the user belongs to.
    Status string
    Current status of the user.
    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Roles []string
    Roles the user belongs to.
    Status string
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    roles List<String>
    Roles the user belongs to.
    status String
    Current status of the user.
    createdAt string
    Date of the creation of the user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (Sensitive) Password of the user.
    roles string[]
    Roles the user belongs to.
    status string
    Current status of the user.
    created_at str
    Date of the creation of the user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (Sensitive) Password of the user.
    roles Sequence[str]
    Roles the user belongs to.
    status str
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    roles List<String>
    Roles the user belongs to.
    status String
    Current status of the user.

    Look up Existing CloudProjectDatabaseClickhouseUser Resource

    Get an existing CloudProjectDatabaseClickhouseUser 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?: CloudProjectDatabaseClickhouseUserState, opts?: CustomResourceOptions): CloudProjectDatabaseClickhouseUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        created_at: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_reset: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None) -> CloudProjectDatabaseClickhouseUser
    func GetCloudProjectDatabaseClickhouseUser(ctx *Context, name string, id IDInput, state *CloudProjectDatabaseClickhouseUserState, opts ...ResourceOption) (*CloudProjectDatabaseClickhouseUser, error)
    public static CloudProjectDatabaseClickhouseUser Get(string name, Input<string> id, CloudProjectDatabaseClickhouseUserState? state, CustomResourceOptions? opts = null)
    public static CloudProjectDatabaseClickhouseUser get(String name, Output<String> id, CloudProjectDatabaseClickhouseUserState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudProjectDatabaseClickhouseUser    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:
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles List<string>
    Roles the user belongs to.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles []string
    Roles the user belongs to.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.
    clusterId string
    Cluster ID.
    createdAt string
    Date of the creation of the user.
    name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password string
    (Sensitive) Password of the user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    roles string[]
    Roles the user belongs to.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status string
    Current status of the user.
    cluster_id str
    Cluster ID.
    created_at str
    Date of the creation of the user.
    name str
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password str
    (Sensitive) Password of the user.
    password_reset str
    Arbitrary string to change to trigger a password update
    roles Sequence[str]
    Roles the user belongs to.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status str
    Current status of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh
      Try Pulumi Cloud free. Your team will thank you.