Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Clickhouse
  4. API Docs
  5. Provider
Viewing docs for Clickhouse v2.0.4
published on Friday, May 22, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-clickhouse

clickhouse.Provider

clickhouse logo
Viewing docs for Clickhouse v2.0.4
published on Friday, May 22, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-clickhouse

    The provider type for the clickhouse package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_url: Optional[str] = None,
             organization_id: Optional[str] = None,
             timeout_seconds: Optional[int] = None,
             token_key: Optional[str] = None,
             token_secret: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:clickhouse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumi_clickhouse" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiUrl string
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    OrganizationId string
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    TimeoutSeconds int
    Timeout in seconds for the HTTP client.
    TokenKey string
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    TokenSecret string
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    ApiUrl string
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    OrganizationId string
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    TimeoutSeconds int
    Timeout in seconds for the HTTP client.
    TokenKey string
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    TokenSecret string
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    api_url string
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    organization_id string
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    timeout_seconds number
    Timeout in seconds for the HTTP client.
    token_key string
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    token_secret string
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    apiUrl String
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    organizationId String
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    timeoutSeconds Integer
    Timeout in seconds for the HTTP client.
    tokenKey String
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    tokenSecret String
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    apiUrl string
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    organizationId string
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    timeoutSeconds number
    Timeout in seconds for the HTTP client.
    tokenKey string
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    tokenSecret string
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    api_url str
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    organization_id str
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    timeout_seconds int
    Timeout in seconds for the HTTP client.
    token_key str
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    token_secret str
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.
    apiUrl String
    API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the CLICKHOUSE_API_URL environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
    organizationId String
    ID of the organization the provider will create services under. Alternatively, can be configured using the CLICKHOUSE_ORG_ID environment variable.
    timeoutSeconds Number
    Timeout in seconds for the HTTP client.
    tokenKey String
    Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_KEY environment variable.
    tokenSecret String
    Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the CLICKHOUSE_TOKEN_SECRET environment variable.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result map(any)
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Package Details

    Repository
    clickhouse pulumiverse/pulumi-clickhouse
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the clickhouse Terraform Provider.
    clickhouse logo
    Viewing docs for Clickhouse v2.0.4
    published on Friday, May 22, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-clickhouse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial