1. Packages
  2. Aiven
  3. API Docs
  4. ClickhouseUser
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.ClickhouseUser

Explore with Pulumi AI

aiven logo
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

    The Clickhouse User resource allows the creation and management of Aiven Clikhouse Users.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var ch_user = new Aiven.ClickhouseUser("ch-user", new()
        {
            Project = aiven_project.Myproject.Project,
            ServiceName = aiven_clickhouse.Myservice.Service_name,
            Username = "<USERNAME>",
        });
    
    });
    
    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.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
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.ClickhouseUser;
    import com.pulumi.aiven.ClickhouseUserArgs;
    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) {
            var ch_user = new ClickhouseUser("ch-user", ClickhouseUserArgs.builder()        
                .project(aiven_project.myproject().project())
                .serviceName(aiven_clickhouse.myservice().service_name())
                .username("<USERNAME>")
                .build());
    
        }
    }
    
    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>")
    
    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>",
    });
    
    resources:
      ch-user:
        type: aiven:ClickhouseUser
        properties:
          project: ${aiven_project.myproject.project}
          serviceName: ${aiven_clickhouse.myservice.service_name}
          username: <USERNAME>
    

    Create ClickhouseUser Resource

    new ClickhouseUser(name: string, args: ClickhouseUserArgs, opts?: CustomResourceOptions);
    @overload
    def ClickhouseUser(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       project: Optional[str] = None,
                       service_name: Optional[str] = None,
                       username: Optional[str] = None)
    @overload
    def ClickhouseUser(resource_name: str,
                       args: ClickhouseUserArgs,
                       opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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)
    Resource lookup is not supported in YAML
    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.

    Import

     $ pulumi import aiven:index/clickhouseUser:ClickhouseUser ch-user project/service_name/username
    

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aiven Terraform Provider.

    aiven logo
    Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi