1. Packages
  2. Airbyte Provider
  3. API Docs
  4. DestinationClickhouse
airbyte 1.0.0 published on Wednesday, Mar 4, 2026 by airbytehq
airbyte logo
airbyte 1.0.0 published on Wednesday, Mar 4, 2026 by airbytehq

    DestinationClickhouse Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const myDestinationClickhouse = new airbyte.DestinationClickhouse("my_destination_clickhouse", {
        configuration: {
            additionalProperties: "{ \"see\": \"documentation\" }",
            database: "...my_database...",
            enableJson: true,
            host: "...my_host...",
            password: "...my_password...",
            port: "...my_port...",
            protocol: "https",
            recordWindowSize: 4,
            tunnelMethod: {
                noTunnel: {
                    additionalProperties: "{ \"see\": \"documentation\" }",
                    tunnelMethod: "NO_TUNNEL",
                },
            },
            username: "...my_username...",
        },
        definitionId: "f7e79763-e821-47f1-9f09-071b66436a92",
        name: "...my_name...",
        workspaceId: "18cdd7db-9638-49f4-915d-c14e35de40fa",
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_destination_clickhouse = airbyte.DestinationClickhouse("my_destination_clickhouse",
        configuration={
            "additional_properties": "{ \"see\": \"documentation\" }",
            "database": "...my_database...",
            "enable_json": True,
            "host": "...my_host...",
            "password": "...my_password...",
            "port": "...my_port...",
            "protocol": "https",
            "record_window_size": 4,
            "tunnel_method": {
                "no_tunnel": {
                    "additional_properties": "{ \"see\": \"documentation\" }",
                    "tunnel_method": "NO_TUNNEL",
                },
            },
            "username": "...my_username...",
        },
        definition_id="f7e79763-e821-47f1-9f09-071b66436a92",
        name="...my_name...",
        workspace_id="18cdd7db-9638-49f4-915d-c14e35de40fa")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := airbyte.NewDestinationClickhouse(ctx, "my_destination_clickhouse", &airbyte.DestinationClickhouseArgs{
    			Configuration: &airbyte.DestinationClickhouseConfigurationArgs{
    				AdditionalProperties: pulumi.String("{ \"see\": \"documentation\" }"),
    				Database:             pulumi.String("...my_database..."),
    				EnableJson:           pulumi.Bool(true),
    				Host:                 pulumi.String("...my_host..."),
    				Password:             pulumi.String("...my_password..."),
    				Port:                 pulumi.String("...my_port..."),
    				Protocol:             pulumi.String("https"),
    				RecordWindowSize:     pulumi.Float64(4),
    				TunnelMethod: &airbyte.DestinationClickhouseConfigurationTunnelMethodArgs{
    					NoTunnel: &airbyte.DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs{
    						AdditionalProperties: pulumi.String("{ \"see\": \"documentation\" }"),
    						TunnelMethod:         pulumi.String("NO_TUNNEL"),
    					},
    				},
    				Username: pulumi.String("...my_username..."),
    			},
    			DefinitionId: pulumi.String("f7e79763-e821-47f1-9f09-071b66436a92"),
    			Name:         pulumi.String("...my_name..."),
    			WorkspaceId:  pulumi.String("18cdd7db-9638-49f4-915d-c14e35de40fa"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Airbyte = Pulumi.Airbyte;
    
    return await Deployment.RunAsync(() => 
    {
        var myDestinationClickhouse = new Airbyte.DestinationClickhouse("my_destination_clickhouse", new()
        {
            Configuration = new Airbyte.Inputs.DestinationClickhouseConfigurationArgs
            {
                AdditionalProperties = "{ \"see\": \"documentation\" }",
                Database = "...my_database...",
                EnableJson = true,
                Host = "...my_host...",
                Password = "...my_password...",
                Port = "...my_port...",
                Protocol = "https",
                RecordWindowSize = 4,
                TunnelMethod = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodArgs
                {
                    NoTunnel = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs
                    {
                        AdditionalProperties = "{ \"see\": \"documentation\" }",
                        TunnelMethod = "NO_TUNNEL",
                    },
                },
                Username = "...my_username...",
            },
            DefinitionId = "f7e79763-e821-47f1-9f09-071b66436a92",
            Name = "...my_name...",
            WorkspaceId = "18cdd7db-9638-49f4-915d-c14e35de40fa",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.airbyte.DestinationClickhouse;
    import com.pulumi.airbyte.DestinationClickhouseArgs;
    import com.pulumi.airbyte.inputs.DestinationClickhouseConfigurationArgs;
    import com.pulumi.airbyte.inputs.DestinationClickhouseConfigurationTunnelMethodArgs;
    import com.pulumi.airbyte.inputs.DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs;
    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 myDestinationClickhouse = new DestinationClickhouse("myDestinationClickhouse", DestinationClickhouseArgs.builder()
                .configuration(DestinationClickhouseConfigurationArgs.builder()
                    .additionalProperties("{ \"see\": \"documentation\" }")
                    .database("...my_database...")
                    .enableJson(true)
                    .host("...my_host...")
                    .password("...my_password...")
                    .port("...my_port...")
                    .protocol("https")
                    .recordWindowSize(4.0)
                    .tunnelMethod(DestinationClickhouseConfigurationTunnelMethodArgs.builder()
                        .noTunnel(DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs.builder()
                            .additionalProperties("{ \"see\": \"documentation\" }")
                            .tunnelMethod("NO_TUNNEL")
                            .build())
                        .build())
                    .username("...my_username...")
                    .build())
                .definitionId("f7e79763-e821-47f1-9f09-071b66436a92")
                .name("...my_name...")
                .workspaceId("18cdd7db-9638-49f4-915d-c14e35de40fa")
                .build());
    
        }
    }
    
    resources:
      myDestinationClickhouse:
        type: airbyte:DestinationClickhouse
        name: my_destination_clickhouse
        properties:
          configuration:
            additionalProperties: '{ "see": "documentation" }'
            database: '...my_database...'
            enableJson: true
            host: '...my_host...'
            password: '...my_password...'
            port: '...my_port...'
            protocol: https
            recordWindowSize: 4
            tunnelMethod:
              noTunnel:
                additionalProperties: '{ "see": "documentation" }'
                tunnelMethod: NO_TUNNEL
            username: '...my_username...'
          definitionId: f7e79763-e821-47f1-9f09-071b66436a92
          name: '...my_name...'
          workspaceId: 18cdd7db-9638-49f4-915d-c14e35de40fa
    

    Create DestinationClickhouse Resource

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

    Constructor syntax

    new DestinationClickhouse(name: string, args: DestinationClickhouseArgs, opts?: CustomResourceOptions);
    @overload
    def DestinationClickhouse(resource_name: str,
                              args: DestinationClickhouseArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def DestinationClickhouse(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              configuration: Optional[DestinationClickhouseConfigurationArgs] = None,
                              workspace_id: Optional[str] = None,
                              definition_id: Optional[str] = None,
                              name: Optional[str] = None)
    func NewDestinationClickhouse(ctx *Context, name string, args DestinationClickhouseArgs, opts ...ResourceOption) (*DestinationClickhouse, error)
    public DestinationClickhouse(string name, DestinationClickhouseArgs args, CustomResourceOptions? opts = null)
    public DestinationClickhouse(String name, DestinationClickhouseArgs args)
    public DestinationClickhouse(String name, DestinationClickhouseArgs args, CustomResourceOptions options)
    
    type: airbyte:DestinationClickhouse
    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 DestinationClickhouseArgs
    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 DestinationClickhouseArgs
    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 DestinationClickhouseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DestinationClickhouseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DestinationClickhouseArgs
    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 destinationClickhouseResource = new Airbyte.DestinationClickhouse("destinationClickhouseResource", new()
    {
        Configuration = new Airbyte.Inputs.DestinationClickhouseConfigurationArgs
        {
            Host = "string",
            Password = "string",
            Protocol = "string",
            AdditionalProperties = "string",
            Database = "string",
            EnableJson = false,
            Port = "string",
            RecordWindowSize = 0,
            TunnelMethod = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodArgs
            {
                NoTunnel = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs
                {
                    AdditionalProperties = "string",
                    TunnelMethod = "string",
                },
                PasswordAuthentication = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodPasswordAuthenticationArgs
                {
                    TunnelHost = "string",
                    TunnelUser = "string",
                    TunnelUserPassword = "string",
                    AdditionalProperties = "string",
                    TunnelMethod = "string",
                    TunnelPort = 0,
                },
                SshKeyAuthentication = new Airbyte.Inputs.DestinationClickhouseConfigurationTunnelMethodSshKeyAuthenticationArgs
                {
                    SshKey = "string",
                    TunnelHost = "string",
                    TunnelUser = "string",
                    AdditionalProperties = "string",
                    TunnelMethod = "string",
                    TunnelPort = 0,
                },
            },
            Username = "string",
        },
        WorkspaceId = "string",
        DefinitionId = "string",
        Name = "string",
    });
    
    example, err := airbyte.NewDestinationClickhouse(ctx, "destinationClickhouseResource", &airbyte.DestinationClickhouseArgs{
    	Configuration: &airbyte.DestinationClickhouseConfigurationArgs{
    		Host:                 pulumi.String("string"),
    		Password:             pulumi.String("string"),
    		Protocol:             pulumi.String("string"),
    		AdditionalProperties: pulumi.String("string"),
    		Database:             pulumi.String("string"),
    		EnableJson:           pulumi.Bool(false),
    		Port:                 pulumi.String("string"),
    		RecordWindowSize:     pulumi.Float64(0),
    		TunnelMethod: &airbyte.DestinationClickhouseConfigurationTunnelMethodArgs{
    			NoTunnel: &airbyte.DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs{
    				AdditionalProperties: pulumi.String("string"),
    				TunnelMethod:         pulumi.String("string"),
    			},
    			PasswordAuthentication: &airbyte.DestinationClickhouseConfigurationTunnelMethodPasswordAuthenticationArgs{
    				TunnelHost:           pulumi.String("string"),
    				TunnelUser:           pulumi.String("string"),
    				TunnelUserPassword:   pulumi.String("string"),
    				AdditionalProperties: pulumi.String("string"),
    				TunnelMethod:         pulumi.String("string"),
    				TunnelPort:           pulumi.Float64(0),
    			},
    			SshKeyAuthentication: &airbyte.DestinationClickhouseConfigurationTunnelMethodSshKeyAuthenticationArgs{
    				SshKey:               pulumi.String("string"),
    				TunnelHost:           pulumi.String("string"),
    				TunnelUser:           pulumi.String("string"),
    				AdditionalProperties: pulumi.String("string"),
    				TunnelMethod:         pulumi.String("string"),
    				TunnelPort:           pulumi.Float64(0),
    			},
    		},
    		Username: pulumi.String("string"),
    	},
    	WorkspaceId:  pulumi.String("string"),
    	DefinitionId: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    })
    
    var destinationClickhouseResource = new DestinationClickhouse("destinationClickhouseResource", DestinationClickhouseArgs.builder()
        .configuration(DestinationClickhouseConfigurationArgs.builder()
            .host("string")
            .password("string")
            .protocol("string")
            .additionalProperties("string")
            .database("string")
            .enableJson(false)
            .port("string")
            .recordWindowSize(0.0)
            .tunnelMethod(DestinationClickhouseConfigurationTunnelMethodArgs.builder()
                .noTunnel(DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs.builder()
                    .additionalProperties("string")
                    .tunnelMethod("string")
                    .build())
                .passwordAuthentication(DestinationClickhouseConfigurationTunnelMethodPasswordAuthenticationArgs.builder()
                    .tunnelHost("string")
                    .tunnelUser("string")
                    .tunnelUserPassword("string")
                    .additionalProperties("string")
                    .tunnelMethod("string")
                    .tunnelPort(0.0)
                    .build())
                .sshKeyAuthentication(DestinationClickhouseConfigurationTunnelMethodSshKeyAuthenticationArgs.builder()
                    .sshKey("string")
                    .tunnelHost("string")
                    .tunnelUser("string")
                    .additionalProperties("string")
                    .tunnelMethod("string")
                    .tunnelPort(0.0)
                    .build())
                .build())
            .username("string")
            .build())
        .workspaceId("string")
        .definitionId("string")
        .name("string")
        .build());
    
    destination_clickhouse_resource = airbyte.DestinationClickhouse("destinationClickhouseResource",
        configuration={
            "host": "string",
            "password": "string",
            "protocol": "string",
            "additional_properties": "string",
            "database": "string",
            "enable_json": False,
            "port": "string",
            "record_window_size": 0,
            "tunnel_method": {
                "no_tunnel": {
                    "additional_properties": "string",
                    "tunnel_method": "string",
                },
                "password_authentication": {
                    "tunnel_host": "string",
                    "tunnel_user": "string",
                    "tunnel_user_password": "string",
                    "additional_properties": "string",
                    "tunnel_method": "string",
                    "tunnel_port": 0,
                },
                "ssh_key_authentication": {
                    "ssh_key": "string",
                    "tunnel_host": "string",
                    "tunnel_user": "string",
                    "additional_properties": "string",
                    "tunnel_method": "string",
                    "tunnel_port": 0,
                },
            },
            "username": "string",
        },
        workspace_id="string",
        definition_id="string",
        name="string")
    
    const destinationClickhouseResource = new airbyte.DestinationClickhouse("destinationClickhouseResource", {
        configuration: {
            host: "string",
            password: "string",
            protocol: "string",
            additionalProperties: "string",
            database: "string",
            enableJson: false,
            port: "string",
            recordWindowSize: 0,
            tunnelMethod: {
                noTunnel: {
                    additionalProperties: "string",
                    tunnelMethod: "string",
                },
                passwordAuthentication: {
                    tunnelHost: "string",
                    tunnelUser: "string",
                    tunnelUserPassword: "string",
                    additionalProperties: "string",
                    tunnelMethod: "string",
                    tunnelPort: 0,
                },
                sshKeyAuthentication: {
                    sshKey: "string",
                    tunnelHost: "string",
                    tunnelUser: "string",
                    additionalProperties: "string",
                    tunnelMethod: "string",
                    tunnelPort: 0,
                },
            },
            username: "string",
        },
        workspaceId: "string",
        definitionId: "string",
        name: "string",
    });
    
    type: airbyte:DestinationClickhouse
    properties:
        configuration:
            additionalProperties: string
            database: string
            enableJson: false
            host: string
            password: string
            port: string
            protocol: string
            recordWindowSize: 0
            tunnelMethod:
                noTunnel:
                    additionalProperties: string
                    tunnelMethod: string
                passwordAuthentication:
                    additionalProperties: string
                    tunnelHost: string
                    tunnelMethod: string
                    tunnelPort: 0
                    tunnelUser: string
                    tunnelUserPassword: string
                sshKeyAuthentication:
                    additionalProperties: string
                    sshKey: string
                    tunnelHost: string
                    tunnelMethod: string
                    tunnelPort: 0
                    tunnelUser: string
            username: string
        definitionId: string
        name: string
        workspaceId: string
    

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

    Configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    Name string
    Name of the destination e.g. dev-mysql-instance.
    Configuration DestinationClickhouseConfigurationArgs
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    Name string
    Name of the destination e.g. dev-mysql-instance.
    configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    name String
    Name of the destination e.g. dev-mysql-instance.
    configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    name string
    Name of the destination e.g. dev-mysql-instance.
    configuration DestinationClickhouseConfigurationArgs
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    name str
    Name of the destination e.g. dev-mysql-instance.
    configuration Property Map
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    name String
    Name of the destination e.g. dev-mysql-instance.

    Outputs

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

    CreatedAt double
    DestinationId string
    DestinationType string
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    CreatedAt float64
    DestinationId string
    DestinationType string
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    createdAt Double
    destinationId String
    destinationType String
    id String
    The provider-assigned unique ID for this managed resource.
    resourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    createdAt number
    destinationId string
    destinationType string
    id string
    The provider-assigned unique ID for this managed resource.
    resourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    created_at float
    destination_id str
    destination_type str
    id str
    The provider-assigned unique ID for this managed resource.
    resource_allocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    createdAt Number
    destinationId String
    destinationType String
    id String
    The provider-assigned unique ID for this managed resource.
    resourceAllocation Property Map
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

    Look up Existing DestinationClickhouse Resource

    Get an existing DestinationClickhouse 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?: DestinationClickhouseState, opts?: CustomResourceOptions): DestinationClickhouse
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            configuration: Optional[DestinationClickhouseConfigurationArgs] = None,
            created_at: Optional[float] = None,
            definition_id: Optional[str] = None,
            destination_id: Optional[str] = None,
            destination_type: Optional[str] = None,
            name: Optional[str] = None,
            resource_allocation: Optional[DestinationClickhouseResourceAllocationArgs] = None,
            workspace_id: Optional[str] = None) -> DestinationClickhouse
    func GetDestinationClickhouse(ctx *Context, name string, id IDInput, state *DestinationClickhouseState, opts ...ResourceOption) (*DestinationClickhouse, error)
    public static DestinationClickhouse Get(string name, Input<string> id, DestinationClickhouseState? state, CustomResourceOptions? opts = null)
    public static DestinationClickhouse get(String name, Output<String> id, DestinationClickhouseState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:DestinationClickhouse    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:
    Configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    DestinationId string
    DestinationType string
    Name string
    Name of the destination e.g. dev-mysql-instance.
    ResourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    WorkspaceId string
    Configuration DestinationClickhouseConfigurationArgs
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    DestinationId string
    DestinationType string
    Name string
    Name of the destination e.g. dev-mysql-instance.
    ResourceAllocation DestinationClickhouseResourceAllocationArgs
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    WorkspaceId string
    configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    destinationId String
    destinationType String
    name String
    Name of the destination e.g. dev-mysql-instance.
    resourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    workspaceId String
    configuration DestinationClickhouseConfiguration
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    destinationId string
    destinationType string
    name string
    Name of the destination e.g. dev-mysql-instance.
    resourceAllocation DestinationClickhouseResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    workspaceId string
    configuration DestinationClickhouseConfigurationArgs
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    destination_id str
    destination_type str
    name str
    Name of the destination e.g. dev-mysql-instance.
    resource_allocation DestinationClickhouseResourceAllocationArgs
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    workspace_id str
    configuration Property Map
    The values required to configure the destination. The schema for this must match the schema return by destinationdefinitionspecifications/get for the destinationDefinition.
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Default: "ce0d828e-1dc4-496c-b122-2da42e637e48"; Requires replacement if changed.
    destinationId String
    destinationType String
    name String
    Name of the destination e.g. dev-mysql-instance.
    resourceAllocation Property Map
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    workspaceId String

    Supporting Types

    DestinationClickhouseConfiguration, DestinationClickhouseConfigurationArgs

    Host string
    Hostname of the database.
    Password string
    Password associated with the username.
    Protocol string
    Protocol for the database connection string. must be one of ["http", "https"]
    AdditionalProperties string
    Parsed as JSON.
    Database string
    Name of the database. Default: "default"
    EnableJson bool
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    Port string
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    RecordWindowSize double
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    TunnelMethod DestinationClickhouseConfigurationTunnelMethod
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    Username string
    Username to use to access the database. Default: "default"
    Host string
    Hostname of the database.
    Password string
    Password associated with the username.
    Protocol string
    Protocol for the database connection string. must be one of ["http", "https"]
    AdditionalProperties string
    Parsed as JSON.
    Database string
    Name of the database. Default: "default"
    EnableJson bool
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    Port string
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    RecordWindowSize float64
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    TunnelMethod DestinationClickhouseConfigurationTunnelMethod
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    Username string
    Username to use to access the database. Default: "default"
    host String
    Hostname of the database.
    password String
    Password associated with the username.
    protocol String
    Protocol for the database connection string. must be one of ["http", "https"]
    additionalProperties String
    Parsed as JSON.
    database String
    Name of the database. Default: "default"
    enableJson Boolean
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    port String
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    recordWindowSize Double
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    tunnelMethod DestinationClickhouseConfigurationTunnelMethod
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    username String
    Username to use to access the database. Default: "default"
    host string
    Hostname of the database.
    password string
    Password associated with the username.
    protocol string
    Protocol for the database connection string. must be one of ["http", "https"]
    additionalProperties string
    Parsed as JSON.
    database string
    Name of the database. Default: "default"
    enableJson boolean
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    port string
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    recordWindowSize number
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    tunnelMethod DestinationClickhouseConfigurationTunnelMethod
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    username string
    Username to use to access the database. Default: "default"
    host str
    Hostname of the database.
    password str
    Password associated with the username.
    protocol str
    Protocol for the database connection string. must be one of ["http", "https"]
    additional_properties str
    Parsed as JSON.
    database str
    Name of the database. Default: "default"
    enable_json bool
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    port str
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    record_window_size float
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    tunnel_method DestinationClickhouseConfigurationTunnelMethod
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    username str
    Username to use to access the database. Default: "default"
    host String
    Hostname of the database.
    password String
    Password associated with the username.
    protocol String
    Protocol for the database connection string. must be one of ["http", "https"]
    additionalProperties String
    Parsed as JSON.
    database String
    Name of the database. Default: "default"
    enableJson Boolean
    Use the JSON type when possible. If disabled, the JSON will be converted to a string. Default: false
    port String
    HTTP port of the database. Default(s) HTTP: 8123 — HTTPS: 8443. Default: "8443"
    recordWindowSize Number
    Warning: Tuning this parameter can impact the performances. The maximum number of records that should be written to a batch. The batch size limit is still limited to 70 Mb
    tunnelMethod Property Map
    Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
    username String
    Username to use to access the database. Default: "default"

    DestinationClickhouseConfigurationTunnelMethod, DestinationClickhouseConfigurationTunnelMethodArgs

    NoTunnel DestinationClickhouseConfigurationTunnelMethodNoTunnel
    No ssh tunnel needed to connect to database
    PasswordAuthentication DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication
    Connect through a jump server tunnel host using username and password authentication
    SshKeyAuthentication DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication
    Connect through a jump server tunnel host using username and ssh key
    NoTunnel DestinationClickhouseConfigurationTunnelMethodNoTunnel
    No ssh tunnel needed to connect to database
    PasswordAuthentication DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication
    Connect through a jump server tunnel host using username and password authentication
    SshKeyAuthentication DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication
    Connect through a jump server tunnel host using username and ssh key
    noTunnel DestinationClickhouseConfigurationTunnelMethodNoTunnel
    No ssh tunnel needed to connect to database
    passwordAuthentication DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication
    Connect through a jump server tunnel host using username and password authentication
    sshKeyAuthentication DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication
    Connect through a jump server tunnel host using username and ssh key
    noTunnel DestinationClickhouseConfigurationTunnelMethodNoTunnel
    No ssh tunnel needed to connect to database
    passwordAuthentication DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication
    Connect through a jump server tunnel host using username and password authentication
    sshKeyAuthentication DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication
    Connect through a jump server tunnel host using username and ssh key
    no_tunnel DestinationClickhouseConfigurationTunnelMethodNoTunnel
    No ssh tunnel needed to connect to database
    password_authentication DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication
    Connect through a jump server tunnel host using username and password authentication
    ssh_key_authentication DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication
    Connect through a jump server tunnel host using username and ssh key
    noTunnel Property Map
    No ssh tunnel needed to connect to database
    passwordAuthentication Property Map
    Connect through a jump server tunnel host using username and password authentication
    sshKeyAuthentication Property Map
    Connect through a jump server tunnel host using username and ssh key

    DestinationClickhouseConfigurationTunnelMethodNoTunnel, DestinationClickhouseConfigurationTunnelMethodNoTunnelArgs

    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "NOTUNNEL"; must be "NOTUNNEL"
    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "NOTUNNEL"; must be "NOTUNNEL"
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "NOTUNNEL"; must be "NOTUNNEL"
    additionalProperties string
    Parsed as JSON.
    tunnelMethod string
    Default: "NOTUNNEL"; must be "NOTUNNEL"
    additional_properties str
    Parsed as JSON.
    tunnel_method str
    Default: "NOTUNNEL"; must be "NOTUNNEL"
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "NOTUNNEL"; must be "NOTUNNEL"

    DestinationClickhouseConfigurationTunnelMethodPasswordAuthentication, DestinationClickhouseConfigurationTunnelMethodPasswordAuthenticationArgs

    TunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    TunnelUser string
    OS-level username for logging into the jump server host
    TunnelUserPassword string
    OS-level password for logging into the jump server host
    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    TunnelPort double
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    TunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    TunnelUser string
    OS-level username for logging into the jump server host
    TunnelUserPassword string
    OS-level password for logging into the jump server host
    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    TunnelPort float64
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    tunnelHost String
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser String
    OS-level username for logging into the jump server host
    tunnelUserPassword String
    OS-level password for logging into the jump server host
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    tunnelPort Double
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    tunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser string
    OS-level username for logging into the jump server host
    tunnelUserPassword string
    OS-level password for logging into the jump server host
    additionalProperties string
    Parsed as JSON.
    tunnelMethod string
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    tunnelPort number
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    tunnel_host str
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnel_user str
    OS-level username for logging into the jump server host
    tunnel_user_password str
    OS-level password for logging into the jump server host
    additional_properties str
    Parsed as JSON.
    tunnel_method str
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    tunnel_port float
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    tunnelHost String
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser String
    OS-level username for logging into the jump server host
    tunnelUserPassword String
    OS-level password for logging into the jump server host
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "SSHPASSWORDAUTH"; must be "SSHPASSWORDAUTH"
    tunnelPort Number
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

    DestinationClickhouseConfigurationTunnelMethodSshKeyAuthentication, DestinationClickhouseConfigurationTunnelMethodSshKeyAuthenticationArgs

    SshKey string
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    TunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    TunnelUser string
    OS-level username for logging into the jump server host
    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    TunnelPort double
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    SshKey string
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    TunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    TunnelUser string
    OS-level username for logging into the jump server host
    AdditionalProperties string
    Parsed as JSON.
    TunnelMethod string
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    TunnelPort float64
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    sshKey String
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    tunnelHost String
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser String
    OS-level username for logging into the jump server host
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    tunnelPort Double
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    sshKey string
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    tunnelHost string
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser string
    OS-level username for logging into the jump server host
    additionalProperties string
    Parsed as JSON.
    tunnelMethod string
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    tunnelPort number
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    ssh_key str
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    tunnel_host str
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnel_user str
    OS-level username for logging into the jump server host
    additional_properties str
    Parsed as JSON.
    tunnel_method str
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    tunnel_port float
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
    sshKey String
    OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
    tunnelHost String
    Hostname of the jump server host that allows inbound ssh tunnel.
    tunnelUser String
    OS-level username for logging into the jump server host
    additionalProperties String
    Parsed as JSON.
    tunnelMethod String
    Default: "SSHKEYAUTH"; must be "SSHKEYAUTH"
    tunnelPort Number
    Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

    DestinationClickhouseResourceAllocation, DestinationClickhouseResourceAllocationArgs

    Default DestinationClickhouseResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics List<DestinationClickhouseResourceAllocationJobSpecific>
    Default DestinationClickhouseResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics []DestinationClickhouseResourceAllocationJobSpecific
    default DestinationClickhouseResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics DestinationClickhouseResourceAllocationJobSpecific[]
    default Property Map
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics List<Property Map>

    DestinationClickhouseResourceAllocationDefault, DestinationClickhouseResourceAllocationDefaultArgs

    DestinationClickhouseResourceAllocationJobSpecific, DestinationClickhouseResourceAllocationJobSpecificArgs

    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements DestinationClickhouseResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements DestinationClickhouseResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements DestinationClickhouseResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType string
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements DestinationClickhouseResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    job_type str
    enum that describes the different types of jobs that the platform runs.
    resource_requirements DestinationClickhouseResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements Property Map
    optional resource requirements to run workers (blank for unbounded allocations)

    DestinationClickhouseResourceAllocationJobSpecificResourceRequirements, DestinationClickhouseResourceAllocationJobSpecificResourceRequirementsArgs

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = airbyte_destination_clickhouse.my_airbyte_destination_clickhouse

    id = “…”

    }

    The pulumi import command can be used, for example:

    $ pulumi import airbyte:index/destinationClickhouse:DestinationClickhouse my_airbyte_destination_clickhouse "..."
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    airbyte 1.0.0 published on Wednesday, Mar 4, 2026 by airbytehq
      Meet Neo: Your AI Platform Teammate