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

clickhouse.Service

clickhouse logo
Viewing docs for Clickhouse v2.0.1
published on Thursday, May 21, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-clickhouse

    You can use the clickhouse_service resource to deploy ClickHouse cloud instances on supported cloud providers.

    Known limitations:

    • If you create a service with warehouseId set and then remove warehouseId attribute completely, the provider won’t detect the change. If you want to make a secondary service become primary, remove the warehouseId and taint it before applying.
    • If you create a service with readonly flag set to true and then remove readonly flag completely, the provider won’t detect the change. If you want to make a secondary service read write, explicitly set the readonly flag to false.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as clickhouse from "@pulumiverse/clickhouse";

const service = new clickhouse.Service("service", {
    name: "My Service",
    cloudProvider: "aws",
    region: "us-east-1",
    idleScaling: true,
    ipAccesses: [{
        source: "192.168.2.63",
        description: "Test IP",
    }],
    tags: {
        Environment: "Staging",
    },
    minTotalMemoryGb: 24,
    maxTotalMemoryGb: 360,
    idleTimeoutMinutes: 5,
    passwordHash: "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
});

    import pulumi
import pulumiverse_clickhouse as clickhouse

service = clickhouse.Service("service",
    name="My Service",
    cloud_provider="aws",
    region="us-east-1",
    idle_scaling=True,
    ip_accesses=[{
        "source": "192.168.2.63",
        "description": "Test IP",
    }],
    tags={
        "Environment": "Staging",
    },
    min_total_memory_gb=24,
    max_total_memory_gb=360,
    idle_timeout_minutes=5,
    password_hash="n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-clickhouse/sdk/go/clickhouse"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clickhouse.NewService(ctx, "service", &clickhouse.ServiceArgs{
			Name:          pulumi.String("My Service"),
			CloudProvider: pulumi.String("aws"),
			Region:        pulumi.String("us-east-1"),
			IdleScaling:   pulumi.Bool(true),
			IpAccesses: clickhouse.ServiceIpAccessArray{
				&clickhouse.ServiceIpAccessArgs{
					Source:      pulumi.String("192.168.2.63"),
					Description: pulumi.String("Test IP"),
				},
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Staging"),
			},
			MinTotalMemoryGb:   pulumi.Int(24),
			MaxTotalMemoryGb:   pulumi.Int(360),
			IdleTimeoutMinutes: pulumi.Int(5),
			PasswordHash:       pulumi.String("n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Clickhouse = Pulumiverse.Clickhouse;

return await Deployment.RunAsync(() => 
{
    var service = new Clickhouse.Service("service", new()
    {
        Name = "My Service",
        CloudProvider = "aws",
        Region = "us-east-1",
        IdleScaling = true,
        IpAccesses = new[]
        {
            new Clickhouse.Inputs.ServiceIpAccessArgs
            {
                Source = "192.168.2.63",
                Description = "Test IP",
            },
        },
        Tags = 
        {
            { "Environment", "Staging" },
        },
        MinTotalMemoryGb = 24,
        MaxTotalMemoryGb = 360,
        IdleTimeoutMinutes = 5,
        PasswordHash = "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.clickhouse.Service;
import com.pulumiverse.clickhouse.ServiceArgs;
import com.pulumi.clickhouse.inputs.ServiceIpAccessArgs;
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 service = new Service("service", ServiceArgs.builder()
            .name("My Service")
            .cloudProvider("aws")
            .region("us-east-1")
            .idleScaling(true)
            .ipAccesses(ServiceIpAccessArgs.builder()
                .source("192.168.2.63")
                .description("Test IP")
                .build())
            .tags(Map.of("Environment", "Staging"))
            .minTotalMemoryGb(24)
            .maxTotalMemoryGb(360)
            .idleTimeoutMinutes(5)
            .passwordHash("n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=")
            .build());

    }
}

    resources:
  service:
    type: clickhouse:Service
    properties:
      name: My Service
      cloudProvider: aws
      region: us-east-1
      idleScaling: true
      ipAccesses:
        - source: 192.168.2.63
          description: Test IP
      tags:
        Environment: Staging
      minTotalMemoryGb: 24
      maxTotalMemoryGb: 360
      idleTimeoutMinutes: 5
      passwordHash: n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=

    Example coming soon!

    Create Service Resource

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

    Constructor syntax

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

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cloud_provider: Optional[str] = None,
            region: Optional[str] = None,
            ip_accesses: Optional[Sequence[ServiceIpAccessArgs]] = None,
            max_total_memory_gb: Optional[int] = None,
            min_total_memory_gb: Optional[int] = None,
            double_sha1_password_hash: Optional[str] = None,
            enable_core_dumps: Optional[bool] = None,
            encryption_assumed_role_identifier: Optional[str] = None,
            encryption_key: Optional[str] = None,
            endpoints: Optional[ServiceEndpointsArgs] = None,
            idle_scaling: Optional[bool] = None,
            idle_timeout_minutes: Optional[int] = None,
            byoc_id: Optional[str] = None,
            max_replica_memory_gb: Optional[int] = None,
            backup_configuration: Optional[ServiceBackupConfigurationArgs] = None,
            min_replica_memory_gb: Optional[int] = None,
            compliance_type: Optional[str] = None,
            name: Optional[str] = None,
            num_replicas: Optional[int] = None,
            password: Optional[str] = None,
            password_hash: Optional[str] = None,
            password_wo: Optional[str] = None,
            password_wo_version: Optional[int] = None,
            query_api_endpoints: Optional[ServiceQueryApiEndpointsArgs] = None,
            readonly: Optional[bool] = None,
            backup_id: Optional[str] = None,
            release_channel: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tier: Optional[str] = None,
            transparent_data_encryption: Optional[ServiceTransparentDataEncryptionArgs] = None,
            warehouse_id: Optional[str] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

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


    resource "clickhouse_service" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new Clickhouse.Service("serviceResource", new()
{
    CloudProvider = "string",
    Region = "string",
    IpAccesses = new[]
    {
        new Clickhouse.Inputs.ServiceIpAccessArgs
        {
            Description = "string",
            Source = "string",
        },
    },
    DoubleSha1PasswordHash = "string",
    EnableCoreDumps = false,
    EncryptionAssumedRoleIdentifier = "string",
    EncryptionKey = "string",
    Endpoints = new Clickhouse.Inputs.ServiceEndpointsArgs
    {
        Https = new Clickhouse.Inputs.ServiceEndpointsHttpsArgs
        {
            Host = "string",
            Port = 0,
        },
        Mysql = new Clickhouse.Inputs.ServiceEndpointsMysqlArgs
        {
            Enabled = false,
            Host = "string",
            Port = 0,
        },
        Nativesecure = new Clickhouse.Inputs.ServiceEndpointsNativesecureArgs
        {
            Host = "string",
            Port = 0,
        },
    },
    IdleScaling = false,
    IdleTimeoutMinutes = 0,
    ByocId = "string",
    MaxReplicaMemoryGb = 0,
    BackupConfiguration = new Clickhouse.Inputs.ServiceBackupConfigurationArgs
    {
        BackupPeriodInHours = 0,
        BackupRetentionPeriodInHours = 0,
        BackupStartTime = "string",
    },
    MinReplicaMemoryGb = 0,
    ComplianceType = "string",
    Name = "string",
    NumReplicas = 0,
    Password = "string",
    PasswordHash = "string",
    PasswordWo = "string",
    PasswordWoVersion = 0,
    QueryApiEndpoints = new Clickhouse.Inputs.ServiceQueryApiEndpointsArgs
    {
        ApiKeyIds = new[]
        {
            "string",
        },
        Roles = new[]
        {
            "string",
        },
        AllowedOrigins = "string",
    },
    Readonly = false,
    BackupId = "string",
    ReleaseChannel = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Tier = "string",
    TransparentDataEncryption = new Clickhouse.Inputs.ServiceTransparentDataEncryptionArgs
    {
        Enabled = false,
        RoleId = "string",
    },
    WarehouseId = "string",
});

    example, err := clickhouse.NewService(ctx, "serviceResource", &clickhouse.ServiceArgs{
	CloudProvider: pulumi.String("string"),
	Region:        pulumi.String("string"),
	IpAccesses: clickhouse.ServiceIpAccessArray{
		&clickhouse.ServiceIpAccessArgs{
			Description: pulumi.String("string"),
			Source:      pulumi.String("string"),
		},
	},
	DoubleSha1PasswordHash:          pulumi.String("string"),
	EnableCoreDumps:                 pulumi.Bool(false),
	EncryptionAssumedRoleIdentifier: pulumi.String("string"),
	EncryptionKey:                   pulumi.String("string"),
	Endpoints: &clickhouse.ServiceEndpointsArgs{
		Https: &clickhouse.ServiceEndpointsHttpsArgs{
			Host: pulumi.String("string"),
			Port: pulumi.Int(0),
		},
		Mysql: &clickhouse.ServiceEndpointsMysqlArgs{
			Enabled: pulumi.Bool(false),
			Host:    pulumi.String("string"),
			Port:    pulumi.Int(0),
		},
		Nativesecure: &clickhouse.ServiceEndpointsNativesecureArgs{
			Host: pulumi.String("string"),
			Port: pulumi.Int(0),
		},
	},
	IdleScaling:        pulumi.Bool(false),
	IdleTimeoutMinutes: pulumi.Int(0),
	ByocId:             pulumi.String("string"),
	MaxReplicaMemoryGb: pulumi.Int(0),
	BackupConfiguration: &clickhouse.ServiceBackupConfigurationArgs{
		BackupPeriodInHours:          pulumi.Int(0),
		BackupRetentionPeriodInHours: pulumi.Int(0),
		BackupStartTime:              pulumi.String("string"),
	},
	MinReplicaMemoryGb: pulumi.Int(0),
	ComplianceType:     pulumi.String("string"),
	Name:               pulumi.String("string"),
	NumReplicas:        pulumi.Int(0),
	Password:           pulumi.String("string"),
	PasswordHash:       pulumi.String("string"),
	PasswordWo:         pulumi.String("string"),
	PasswordWoVersion:  pulumi.Int(0),
	QueryApiEndpoints: &clickhouse.ServiceQueryApiEndpointsArgs{
		ApiKeyIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Roles: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.String("string"),
	},
	Readonly:       pulumi.Bool(false),
	BackupId:       pulumi.String("string"),
	ReleaseChannel: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tier: pulumi.String("string"),
	TransparentDataEncryption: &clickhouse.ServiceTransparentDataEncryptionArgs{
		Enabled: pulumi.Bool(false),
		RoleId:  pulumi.String("string"),
	},
	WarehouseId: pulumi.String("string"),
})

    resource "clickhouse_service" "serviceResource" {
  cloud_provider = "string"
  region         = "string"
  ip_accesses {
    description = "string"
    source      = "string"
  }
  double_sha1_password_hash          = "string"
  enable_core_dumps                  = false
  encryption_assumed_role_identifier = "string"
  encryption_key                     = "string"
  endpoints = {
    https = {
      host = "string"
      port = 0
    }
    mysql = {
      enabled = false
      host    = "string"
      port    = 0
    }
    nativesecure = {
      host = "string"
      port = 0
    }
  }
  idle_scaling          = false
  idle_timeout_minutes  = 0
  byoc_id               = "string"
  max_replica_memory_gb = 0
  backup_configuration = {
    backup_period_in_hours           = 0
    backup_retention_period_in_hours = 0
    backup_start_time                = "string"
  }
  min_replica_memory_gb = 0
  compliance_type       = "string"
  name                  = "string"
  num_replicas          = 0
  password              = "string"
  password_hash         = "string"
  password_wo           = "string"
  password_wo_version   = 0
  query_api_endpoints = {
    api_key_ids     = ["string"]
    roles           = ["string"]
    allowed_origins = "string"
  }
  readonly        = false
  backup_id       = "string"
  release_channel = "string"
  tags = {
    "string" = "string"
  }
  tier = "string"
  transparent_data_encryption = {
    enabled = false
    role_id = "string"
  }
  warehouse_id = "string"
}

    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .cloudProvider("string")
    .region("string")
    .ipAccesses(ServiceIpAccessArgs.builder()
        .description("string")
        .source("string")
        .build())
    .doubleSha1PasswordHash("string")
    .enableCoreDumps(false)
    .encryptionAssumedRoleIdentifier("string")
    .encryptionKey("string")
    .endpoints(ServiceEndpointsArgs.builder()
        .https(ServiceEndpointsHttpsArgs.builder()
            .host("string")
            .port(0)
            .build())
        .mysql(ServiceEndpointsMysqlArgs.builder()
            .enabled(false)
            .host("string")
            .port(0)
            .build())
        .nativesecure(ServiceEndpointsNativesecureArgs.builder()
            .host("string")
            .port(0)
            .build())
        .build())
    .idleScaling(false)
    .idleTimeoutMinutes(0)
    .byocId("string")
    .maxReplicaMemoryGb(0)
    .backupConfiguration(ServiceBackupConfigurationArgs.builder()
        .backupPeriodInHours(0)
        .backupRetentionPeriodInHours(0)
        .backupStartTime("string")
        .build())
    .minReplicaMemoryGb(0)
    .complianceType("string")
    .name("string")
    .numReplicas(0)
    .password("string")
    .passwordHash("string")
    .passwordWo("string")
    .passwordWoVersion(0)
    .queryApiEndpoints(ServiceQueryApiEndpointsArgs.builder()
        .apiKeyIds("string")
        .roles("string")
        .allowedOrigins("string")
        .build())
    .readonly(false)
    .backupId("string")
    .releaseChannel("string")
    .tags(Map.of("string", "string"))
    .tier("string")
    .transparentDataEncryption(ServiceTransparentDataEncryptionArgs.builder()
        .enabled(false)
        .roleId("string")
        .build())
    .warehouseId("string")
    .build());

    service_resource = clickhouse.Service("serviceResource",
    cloud_provider="string",
    region="string",
    ip_accesses=[{
        "description": "string",
        "source": "string",
    }],
    double_sha1_password_hash="string",
    enable_core_dumps=False,
    encryption_assumed_role_identifier="string",
    encryption_key="string",
    endpoints={
        "https": {
            "host": "string",
            "port": 0,
        },
        "mysql": {
            "enabled": False,
            "host": "string",
            "port": 0,
        },
        "nativesecure": {
            "host": "string",
            "port": 0,
        },
    },
    idle_scaling=False,
    idle_timeout_minutes=0,
    byoc_id="string",
    max_replica_memory_gb=0,
    backup_configuration={
        "backup_period_in_hours": 0,
        "backup_retention_period_in_hours": 0,
        "backup_start_time": "string",
    },
    min_replica_memory_gb=0,
    compliance_type="string",
    name="string",
    num_replicas=0,
    password="string",
    password_hash="string",
    password_wo="string",
    password_wo_version=0,
    query_api_endpoints={
        "api_key_ids": ["string"],
        "roles": ["string"],
        "allowed_origins": "string",
    },
    readonly=False,
    backup_id="string",
    release_channel="string",
    tags={
        "string": "string",
    },
    tier="string",
    transparent_data_encryption={
        "enabled": False,
        "role_id": "string",
    },
    warehouse_id="string")

    const serviceResource = new clickhouse.Service("serviceResource", {
    cloudProvider: "string",
    region: "string",
    ipAccesses: [{
        description: "string",
        source: "string",
    }],
    doubleSha1PasswordHash: "string",
    enableCoreDumps: false,
    encryptionAssumedRoleIdentifier: "string",
    encryptionKey: "string",
    endpoints: {
        https: {
            host: "string",
            port: 0,
        },
        mysql: {
            enabled: false,
            host: "string",
            port: 0,
        },
        nativesecure: {
            host: "string",
            port: 0,
        },
    },
    idleScaling: false,
    idleTimeoutMinutes: 0,
    byocId: "string",
    maxReplicaMemoryGb: 0,
    backupConfiguration: {
        backupPeriodInHours: 0,
        backupRetentionPeriodInHours: 0,
        backupStartTime: "string",
    },
    minReplicaMemoryGb: 0,
    complianceType: "string",
    name: "string",
    numReplicas: 0,
    password: "string",
    passwordHash: "string",
    passwordWo: "string",
    passwordWoVersion: 0,
    queryApiEndpoints: {
        apiKeyIds: ["string"],
        roles: ["string"],
        allowedOrigins: "string",
    },
    readonly: false,
    backupId: "string",
    releaseChannel: "string",
    tags: {
        string: "string",
    },
    tier: "string",
    transparentDataEncryption: {
        enabled: false,
        roleId: "string",
    },
    warehouseId: "string",
});

    type: clickhouse:Service
properties:
    backupConfiguration:
        backupPeriodInHours: 0
        backupRetentionPeriodInHours: 0
        backupStartTime: string
    backupId: string
    byocId: string
    cloudProvider: string
    complianceType: string
    doubleSha1PasswordHash: string
    enableCoreDumps: false
    encryptionAssumedRoleIdentifier: string
    encryptionKey: string
    endpoints:
        https:
            host: string
            port: 0
        mysql:
            enabled: false
            host: string
            port: 0
        nativesecure:
            host: string
            port: 0
    idleScaling: false
    idleTimeoutMinutes: 0
    ipAccesses:
        - description: string
          source: string
    maxReplicaMemoryGb: 0
    minReplicaMemoryGb: 0
    name: string
    numReplicas: 0
    password: string
    passwordHash: string
    passwordWo: string
    passwordWoVersion: 0
    queryApiEndpoints:
        allowedOrigins: string
        apiKeyIds:
            - string
        roles:
            - string
    readonly: false
    region: string
    releaseChannel: string
    tags:
        string: string
    tier: string
    transparentDataEncryption:
        enabled: false
        roleId: string
    warehouseId: string

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

    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    IpAccesses List<Pulumiverse.Clickhouse.Inputs.ServiceIpAccess>
    List of IP addresses allowed to access the service.
    Region string
    Region within the cloud provider in which the service is deployed in.
    BackupConfiguration Pulumiverse.Clickhouse.Inputs.ServiceBackupConfiguration
    Configuration of service backup settings.
    BackupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    ByocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    ComplianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    EnableCoreDumps bool
    Enable core dumps for the service.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    EncryptionKey string
    Custom encryption key ARN.
    Endpoints Pulumiverse.Clickhouse.Inputs.ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    MaxReplicaMemoryGb int
    Maximum memory of a single replica during auto-scaling in GiB.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    MinReplicaMemoryGb int
    Minimum memory of a single replica during auto-scaling in GiB.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service.
    Password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    PasswordWoVersion int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    QueryApiEndpoints Pulumiverse.Clickhouse.Inputs.ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    Readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    ReleaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    Tags Dictionary<string, string>
    Tags associated with the service as key-value pairs.
    Tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    TransparentDataEncryption Pulumiverse.Clickhouse.Inputs.ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    WarehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    IpAccesses []ServiceIpAccessArgs
    List of IP addresses allowed to access the service.
    Region string
    Region within the cloud provider in which the service is deployed in.
    BackupConfiguration ServiceBackupConfigurationArgs
    Configuration of service backup settings.
    BackupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    ByocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    ComplianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    EnableCoreDumps bool
    Enable core dumps for the service.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    EncryptionKey string
    Custom encryption key ARN.
    Endpoints ServiceEndpointsArgs
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    MaxReplicaMemoryGb int
    Maximum memory of a single replica during auto-scaling in GiB.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    MinReplicaMemoryGb int
    Minimum memory of a single replica during auto-scaling in GiB.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service.
    Password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    PasswordWoVersion int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    QueryApiEndpoints ServiceQueryApiEndpointsArgs
    Configuration of the query API endpoints feature.
    Readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    ReleaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    Tags map[string]string
    Tags associated with the service as key-value pairs.
    Tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    TransparentDataEncryption ServiceTransparentDataEncryptionArgs
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    WarehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    cloud_provider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ip_accesses list(object)
    List of IP addresses allowed to access the service.
    region string
    Region within the cloud provider in which the service is deployed in.
    backup_configuration object
    Configuration of service backup settings.
    backup_id string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byoc_id string
    BYOC ID related to the cloud provider account you want to create this service into.
    compliance_type string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    double_sha1_password_hash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enable_core_dumps bool
    Enable core dumps for the service.
    encryption_assumed_role_identifier string
    Custom role identifier ARN.
    encryption_key string
    Custom encryption key ARN.
    endpoints object
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    max_replica_memory_gb number
    Maximum memory of a single replica during auto-scaling in GiB.
    max_total_memory_gb number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    min_replica_memory_gb number
    Minimum memory of a single replica during auto-scaling in GiB.
    min_total_memory_gb number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name string
    User defined identifier for the service.
    num_replicas number
    Number of replicas for the service.
    password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_hash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_wo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    password_wo_version number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    query_api_endpoints object
    Configuration of the query API endpoints feature.
    readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    release_channel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags map(string)
    Tags associated with the service as key-value pairs.
    tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparent_data_encryption object
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouse_id string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses List<ServiceIpAccess>
    List of IP addresses allowed to access the service.
    region String
    Region within the cloud provider in which the service is deployed in.
    backupConfiguration ServiceBackupConfiguration
    Configuration of service backup settings.
    backupId String
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId String
    BYOC ID related to the cloud provider account you want to create this service into.
    complianceType String
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps Boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier String
    Custom role identifier ARN.
    encryptionKey String
    Custom encryption key ARN.
    endpoints ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Integer
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    maxReplicaMemoryGb Integer
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb Integer
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb Integer
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb Integer
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name String
    User defined identifier for the service.
    numReplicas Integer
    Number of replicas for the service.
    password String
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion Integer
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    queryApiEndpoints ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    readonly Boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    releaseChannel String
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Map<String,String>
    Tags associated with the service as key-value pairs.
    tier String
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId String
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    cloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses ServiceIpAccess[]
    List of IP addresses allowed to access the service.
    region string
    Region within the cloud provider in which the service is deployed in.
    backupConfiguration ServiceBackupConfiguration
    Configuration of service backup settings.
    backupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    complianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    encryptionKey string
    Custom encryption key ARN.
    endpoints ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    idleScaling boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    maxReplicaMemoryGb number
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb number
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name string
    User defined identifier for the service.
    numReplicas number
    Number of replicas for the service.
    password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    queryApiEndpoints ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    readonly boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    releaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags {[key: string]: string}
    Tags associated with the service as key-value pairs.
    tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    cloud_provider str
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ip_accesses Sequence[ServiceIpAccessArgs]
    List of IP addresses allowed to access the service.
    region str
    Region within the cloud provider in which the service is deployed in.
    backup_configuration ServiceBackupConfigurationArgs
    Configuration of service backup settings.
    backup_id str
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byoc_id str
    BYOC ID related to the cloud provider account you want to create this service into.
    compliance_type str
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    double_sha1_password_hash str
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enable_core_dumps bool
    Enable core dumps for the service.
    encryption_assumed_role_identifier str
    Custom role identifier ARN.
    encryption_key str
    Custom encryption key ARN.
    endpoints ServiceEndpointsArgs
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    max_replica_memory_gb int
    Maximum memory of a single replica during auto-scaling in GiB.
    max_total_memory_gb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    min_replica_memory_gb int
    Minimum memory of a single replica during auto-scaling in GiB.
    min_total_memory_gb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name str
    User defined identifier for the service.
    num_replicas int
    Number of replicas for the service.
    password str
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_hash str
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    password_wo_version int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    query_api_endpoints ServiceQueryApiEndpointsArgs
    Configuration of the query API endpoints feature.
    readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    release_channel str
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Mapping[str, str]
    Tags associated with the service as key-value pairs.
    tier str
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparent_data_encryption ServiceTransparentDataEncryptionArgs
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouse_id str
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses List<Property Map>
    List of IP addresses allowed to access the service.
    region String
    Region within the cloud provider in which the service is deployed in.
    backupConfiguration Property Map
    Configuration of service backup settings.
    backupId String
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId String
    BYOC ID related to the cloud provider account you want to create this service into.
    complianceType String
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps Boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier String
    Custom role identifier ARN.
    encryptionKey String
    Custom encryption key ARN.
    endpoints Property Map
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    maxReplicaMemoryGb Number
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb Number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb Number
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb Number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name String
    User defined identifier for the service.
    numReplicas Number
    Number of replicas for the service.
    password String
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion Number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    queryApiEndpoints Property Map
    Configuration of the query API endpoints feature.
    readonly Boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    releaseChannel String
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Map<String>
    Tags associated with the service as key-value pairs.
    tier String
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption Property Map
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId String
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.

    Outputs

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

    IamRole string
    IAM role used for accessing objects in s3.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    PrivateEndpointConfig Pulumiverse.Clickhouse.Outputs.ServicePrivateEndpointConfig
    Service config for private endpoints
    IamRole string
    IAM role used for accessing objects in s3.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    PrivateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints
    iam_role string
    IAM role used for accessing objects in s3.
    id string
    The provider-assigned unique ID for this managed resource.
    is_primary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    private_endpoint_config object
    Service config for private endpoints
    iamRole String
    IAM role used for accessing objects in s3.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints
    iamRole string
    IAM role used for accessing objects in s3.
    id string
    The provider-assigned unique ID for this managed resource.
    isPrimary boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints
    iam_role str
    IAM role used for accessing objects in s3.
    id str
    The provider-assigned unique ID for this managed resource.
    is_primary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    private_endpoint_config ServicePrivateEndpointConfig
    Service config for private endpoints
    iamRole String
    IAM role used for accessing objects in s3.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    privateEndpointConfig Property Map
    Service config for private endpoints

    Look up Existing Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_configuration: Optional[ServiceBackupConfigurationArgs] = None,
        backup_id: Optional[str] = None,
        byoc_id: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        compliance_type: Optional[str] = None,
        double_sha1_password_hash: Optional[str] = None,
        enable_core_dumps: Optional[bool] = None,
        encryption_assumed_role_identifier: Optional[str] = None,
        encryption_key: Optional[str] = None,
        endpoints: Optional[ServiceEndpointsArgs] = None,
        iam_role: Optional[str] = None,
        idle_scaling: Optional[bool] = None,
        idle_timeout_minutes: Optional[int] = None,
        ip_accesses: Optional[Sequence[ServiceIpAccessArgs]] = None,
        is_primary: Optional[bool] = None,
        max_replica_memory_gb: Optional[int] = None,
        max_total_memory_gb: Optional[int] = None,
        min_replica_memory_gb: Optional[int] = None,
        min_total_memory_gb: Optional[int] = None,
        name: Optional[str] = None,
        num_replicas: Optional[int] = None,
        password: Optional[str] = None,
        password_hash: Optional[str] = None,
        password_wo: Optional[str] = None,
        password_wo_version: Optional[int] = None,
        private_endpoint_config: Optional[ServicePrivateEndpointConfigArgs] = None,
        query_api_endpoints: Optional[ServiceQueryApiEndpointsArgs] = None,
        readonly: Optional[bool] = None,
        region: Optional[str] = None,
        release_channel: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tier: Optional[str] = None,
        transparent_data_encryption: Optional[ServiceTransparentDataEncryptionArgs] = None,
        warehouse_id: Optional[str] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    resources:  _:    type: clickhouse:Service    get:      id: ${id}
    import {
  to = clickhouse_service.example
  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:
    BackupConfiguration Pulumiverse.Clickhouse.Inputs.ServiceBackupConfiguration
    Configuration of service backup settings.
    BackupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    ByocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ComplianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    EnableCoreDumps bool
    Enable core dumps for the service.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    EncryptionKey string
    Custom encryption key ARN.
    Endpoints Pulumiverse.Clickhouse.Inputs.ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    IamRole string
    IAM role used for accessing objects in s3.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    IpAccesses List<Pulumiverse.Clickhouse.Inputs.ServiceIpAccess>
    List of IP addresses allowed to access the service.
    IsPrimary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    MaxReplicaMemoryGb int
    Maximum memory of a single replica during auto-scaling in GiB.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    MinReplicaMemoryGb int
    Minimum memory of a single replica during auto-scaling in GiB.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service.
    Password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    PasswordWoVersion int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    PrivateEndpointConfig Pulumiverse.Clickhouse.Inputs.ServicePrivateEndpointConfig
    Service config for private endpoints
    QueryApiEndpoints Pulumiverse.Clickhouse.Inputs.ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    Readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    Region string
    Region within the cloud provider in which the service is deployed in.
    ReleaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    Tags Dictionary<string, string>
    Tags associated with the service as key-value pairs.
    Tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    TransparentDataEncryption Pulumiverse.Clickhouse.Inputs.ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    WarehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    BackupConfiguration ServiceBackupConfigurationArgs
    Configuration of service backup settings.
    BackupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    ByocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ComplianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    EnableCoreDumps bool
    Enable core dumps for the service.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    EncryptionKey string
    Custom encryption key ARN.
    Endpoints ServiceEndpointsArgs
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    IamRole string
    IAM role used for accessing objects in s3.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    IpAccesses []ServiceIpAccessArgs
    List of IP addresses allowed to access the service.
    IsPrimary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    MaxReplicaMemoryGb int
    Maximum memory of a single replica during auto-scaling in GiB.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    MinReplicaMemoryGb int
    Minimum memory of a single replica during auto-scaling in GiB.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service.
    Password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    PasswordWoVersion int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    PrivateEndpointConfig ServicePrivateEndpointConfigArgs
    Service config for private endpoints
    QueryApiEndpoints ServiceQueryApiEndpointsArgs
    Configuration of the query API endpoints feature.
    Readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    Region string
    Region within the cloud provider in which the service is deployed in.
    ReleaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    Tags map[string]string
    Tags associated with the service as key-value pairs.
    Tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    TransparentDataEncryption ServiceTransparentDataEncryptionArgs
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    WarehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    backup_configuration object
    Configuration of service backup settings.
    backup_id string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byoc_id string
    BYOC ID related to the cloud provider account you want to create this service into.
    cloud_provider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    compliance_type string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    double_sha1_password_hash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enable_core_dumps bool
    Enable core dumps for the service.
    encryption_assumed_role_identifier string
    Custom role identifier ARN.
    encryption_key string
    Custom encryption key ARN.
    endpoints object
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    iam_role string
    IAM role used for accessing objects in s3.
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    ip_accesses list(object)
    List of IP addresses allowed to access the service.
    is_primary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    max_replica_memory_gb number
    Maximum memory of a single replica during auto-scaling in GiB.
    max_total_memory_gb number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    min_replica_memory_gb number
    Minimum memory of a single replica during auto-scaling in GiB.
    min_total_memory_gb number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name string
    User defined identifier for the service.
    num_replicas number
    Number of replicas for the service.
    password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_hash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_wo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    password_wo_version number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    private_endpoint_config object
    Service config for private endpoints
    query_api_endpoints object
    Configuration of the query API endpoints feature.
    readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    region string
    Region within the cloud provider in which the service is deployed in.
    release_channel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags map(string)
    Tags associated with the service as key-value pairs.
    tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparent_data_encryption object
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouse_id string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    backupConfiguration ServiceBackupConfiguration
    Configuration of service backup settings.
    backupId String
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId String
    BYOC ID related to the cloud provider account you want to create this service into.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    complianceType String
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps Boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier String
    Custom role identifier ARN.
    encryptionKey String
    Custom encryption key ARN.
    endpoints ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    iamRole String
    IAM role used for accessing objects in s3.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Integer
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    ipAccesses List<ServiceIpAccess>
    List of IP addresses allowed to access the service.
    isPrimary Boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    maxReplicaMemoryGb Integer
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb Integer
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb Integer
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb Integer
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name String
    User defined identifier for the service.
    numReplicas Integer
    Number of replicas for the service.
    password String
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion Integer
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints
    queryApiEndpoints ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    readonly Boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    region String
    Region within the cloud provider in which the service is deployed in.
    releaseChannel String
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Map<String,String>
    Tags associated with the service as key-value pairs.
    tier String
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId String
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    backupConfiguration ServiceBackupConfiguration
    Configuration of service backup settings.
    backupId string
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId string
    BYOC ID related to the cloud provider account you want to create this service into.
    cloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    complianceType string
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier string
    Custom role identifier ARN.
    encryptionKey string
    Custom encryption key ARN.
    endpoints ServiceEndpoints
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    iamRole string
    IAM role used for accessing objects in s3.
    idleScaling boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    ipAccesses ServiceIpAccess[]
    List of IP addresses allowed to access the service.
    isPrimary boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    maxReplicaMemoryGb number
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb number
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name string
    User defined identifier for the service.
    numReplicas number
    Number of replicas for the service.
    password string
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash string
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints
    queryApiEndpoints ServiceQueryApiEndpoints
    Configuration of the query API endpoints feature.
    readonly boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    region string
    Region within the cloud provider in which the service is deployed in.
    releaseChannel string
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags {[key: string]: string}
    Tags associated with the service as key-value pairs.
    tier string
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption ServiceTransparentDataEncryption
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId string
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    backup_configuration ServiceBackupConfigurationArgs
    Configuration of service backup settings.
    backup_id str
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byoc_id str
    BYOC ID related to the cloud provider account you want to create this service into.
    cloud_provider str
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    compliance_type str
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    double_sha1_password_hash str
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enable_core_dumps bool
    Enable core dumps for the service.
    encryption_assumed_role_identifier str
    Custom role identifier ARN.
    encryption_key str
    Custom encryption key ARN.
    endpoints ServiceEndpointsArgs
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    iam_role str
    IAM role used for accessing objects in s3.
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    ip_accesses Sequence[ServiceIpAccessArgs]
    List of IP addresses allowed to access the service.
    is_primary bool
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    max_replica_memory_gb int
    Maximum memory of a single replica during auto-scaling in GiB.
    max_total_memory_gb int
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    min_replica_memory_gb int
    Minimum memory of a single replica during auto-scaling in GiB.
    min_total_memory_gb int
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name str
    User defined identifier for the service.
    num_replicas int
    Number of replicas for the service.
    password str
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_hash str
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    password_wo_version int
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    private_endpoint_config ServicePrivateEndpointConfigArgs
    Service config for private endpoints
    query_api_endpoints ServiceQueryApiEndpointsArgs
    Configuration of the query API endpoints feature.
    readonly bool
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    region str
    Region within the cloud provider in which the service is deployed in.
    release_channel str
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Mapping[str, str]
    Tags associated with the service as key-value pairs.
    tier str
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparent_data_encryption ServiceTransparentDataEncryptionArgs
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouse_id str
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.
    backupConfiguration Property Map
    Configuration of service backup settings.
    backupId String
    ID of the backup to restore when creating new service. If specified, the service will be created as a restore operation
    byocId String
    BYOC ID related to the cloud provider account you want to create this service into.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    complianceType String
    Compliance type of the service. Can be 'hipaa', 'pci'. Required for organizations that wish to deploy their services in the hipaa/pci compliant environment. NOTE: hipaa/pci compliance should be enabled for your ClickHouse organization before using this field.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password or passwordWo is specified.
    enableCoreDumps Boolean
    Enable core dumps for the service.
    encryptionAssumedRoleIdentifier String
    Custom role identifier ARN.
    encryptionKey String
    Custom encryption key ARN.
    endpoints Property Map
    Allow to enable and configure additional endpoints (read protocols) to expose on the ClickHouse service.
    iamRole String
    IAM role used for accessing objects in s3.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idleScaling is enabled.
    ipAccesses List<Property Map>
    List of IP addresses allowed to access the service.
    isPrimary Boolean
    If true, it indicates this is a primary service using its own data. If false it means this service is a secondary service, thus using data from a warehouse.
    maxReplicaMemoryGb Number
    Maximum memory of a single replica during auto-scaling in GiB.
    maxTotalMemoryGb Number
    Maximum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use maxReplicaMemoryGb instead

    minReplicaMemoryGb Number
    Minimum memory of a single replica during auto-scaling in GiB.
    minTotalMemoryGb Number
    Minimum total memory of all workers during auto-scaling in GiB.

    Deprecated: Please use minReplicaMemoryGb instead

    name String
    User defined identifier for the service.
    numReplicas Number
    Number of replicas for the service.
    password String
    Password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password, passwordWo, or passwordHash must be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the default user (write-only, not persisted to state). Use this instead of password to avoid storing the password hash in Terraform state.
    passwordWoVersion Number
    Version number for passwordwo. Increment this to trigger a password update when using passwordwo.
    privateEndpointConfig Property Map
    Service config for private endpoints
    queryApiEndpoints Property Map
    Configuration of the query API endpoints feature.
    readonly Boolean
    Indicates if this service should be read only. Only allowed for secondary services, those which share data with another service (i.e. when warehouseId field is set).
    region String
    Region within the cloud provider in which the service is deployed in.
    releaseChannel String
    Release channel to use for this service. Can be 'default', 'fast' or 'slow'.
    tags Map<String>
    Tags associated with the service as key-value pairs.
    tier String
    Tier of the service: 'development', 'production'. Required for organizations using the Legacy ClickHouse Cloud Tiers, must be omitted for organizations using the new ClickHouse Cloud Tiers.
    transparentDataEncryption Property Map
    Configuration of the Transparent Data Encryption (TDE) feature. Requires an organization with the Enterprise plan.
    warehouseId String
    Set it to the 'warehouse_id' attribute of another service to share the data with it. The service must be in the same cloud and region.

    Supporting Types

    ServiceBackupConfiguration, ServiceBackupConfigurationArgs

    BackupPeriodInHours int
    Interval in hours between each backup.
    BackupRetentionPeriodInHours int
    How long in hours to keep a backup before deleting it.
    BackupStartTime string
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    BackupPeriodInHours int
    Interval in hours between each backup.
    BackupRetentionPeriodInHours int
    How long in hours to keep a backup before deleting it.
    BackupStartTime string
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    backup_period_in_hours number
    Interval in hours between each backup.
    backup_retention_period_in_hours number
    How long in hours to keep a backup before deleting it.
    backup_start_time string
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    backupPeriodInHours Integer
    Interval in hours between each backup.
    backupRetentionPeriodInHours Integer
    How long in hours to keep a backup before deleting it.
    backupStartTime String
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    backupPeriodInHours number
    Interval in hours between each backup.
    backupRetentionPeriodInHours number
    How long in hours to keep a backup before deleting it.
    backupStartTime string
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    backup_period_in_hours int
    Interval in hours between each backup.
    backup_retention_period_in_hours int
    How long in hours to keep a backup before deleting it.
    backup_start_time str
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.
    backupPeriodInHours Number
    Interval in hours between each backup.
    backupRetentionPeriodInHours Number
    How long in hours to keep a backup before deleting it.
    backupStartTime String
    Time of the day in UTC that indicates the start time of a 2 hours window to be used for backup. If set, backupperiodin_hours must be null and backups are created once a day.

    ServiceEndpoints, ServiceEndpointsArgs

    ServiceEndpointsHttps, ServiceEndpointsHttpsArgs

    Host string
    Endpoint host.
    Port int
    Endpoint port.
    Host string
    Endpoint host.
    Port int
    Endpoint port.
    host string
    Endpoint host.
    port number
    Endpoint port.
    host String
    Endpoint host.
    port Integer
    Endpoint port.
    host string
    Endpoint host.
    port number
    Endpoint port.
    host str
    Endpoint host.
    port int
    Endpoint port.
    host String
    Endpoint host.
    port Number
    Endpoint port.

    ServiceEndpointsMysql, ServiceEndpointsMysqlArgs

    Enabled bool
    Wether to enable the mysql endpoint or not.
    Host string
    Endpoint host.
    Port int
    Endpoint port.
    Enabled bool
    Wether to enable the mysql endpoint or not.
    Host string
    Endpoint host.
    Port int
    Endpoint port.
    enabled bool
    Wether to enable the mysql endpoint or not.
    host string
    Endpoint host.
    port number
    Endpoint port.
    enabled Boolean
    Wether to enable the mysql endpoint or not.
    host String
    Endpoint host.
    port Integer
    Endpoint port.
    enabled boolean
    Wether to enable the mysql endpoint or not.
    host string
    Endpoint host.
    port number
    Endpoint port.
    enabled bool
    Wether to enable the mysql endpoint or not.
    host str
    Endpoint host.
    port int
    Endpoint port.
    enabled Boolean
    Wether to enable the mysql endpoint or not.
    host String
    Endpoint host.
    port Number
    Endpoint port.

    ServiceEndpointsNativesecure, ServiceEndpointsNativesecureArgs

    Host string
    Endpoint host.
    Port int
    Endpoint port.
    Host string
    Endpoint host.
    Port int
    Endpoint port.
    host string
    Endpoint host.
    port number
    Endpoint port.
    host String
    Endpoint host.
    port Integer
    Endpoint port.
    host string
    Endpoint host.
    port number
    Endpoint port.
    host str
    Endpoint host.
    port int
    Endpoint port.
    host String
    Endpoint host.
    port Number
    Endpoint port.

    ServiceIpAccess, ServiceIpAccessArgs

    Description string
    Description of the IP address.
    Source string
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    Description string
    Description of the IP address.
    Source string
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    description string
    Description of the IP address.
    source string
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    description String
    Description of the IP address.
    source String
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    description string
    Description of the IP address.
    source string
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    description str
    Description of the IP address.
    source str
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0
    description String
    Description of the IP address.
    source String
    IP address allowed to access the service. In case you want to set the ipAccess to anywhere you should set source to 0.0.0.0/0

    ServicePrivateEndpointConfig, ServicePrivateEndpointConfigArgs

    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    PrivateDnsHostname string
    Private DNS Hostname of the VPC you created.
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    PrivateDnsHostname string
    Private DNS Hostname of the VPC you created.
    endpoint_service_id string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    private_dns_hostname string
    Private DNS Hostname of the VPC you created.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    privateDnsHostname String
    Private DNS Hostname of the VPC you created.
    endpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    privateDnsHostname string
    Private DNS Hostname of the VPC you created.
    endpoint_service_id str
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    private_dns_hostname str
    Private DNS Hostname of the VPC you created.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource.
    privateDnsHostname String
    Private DNS Hostname of the VPC you created.

    ServiceQueryApiEndpoints, ServiceQueryApiEndpointsArgs

    ApiKeyIds List<string>
    The UUIDs of the API Keys to grant access to the query API.
    Roles List<string>
    The Database role that will be used to run the query.
    AllowedOrigins string
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    ApiKeyIds []string
    The UUIDs of the API Keys to grant access to the query API.
    Roles []string
    The Database role that will be used to run the query.
    AllowedOrigins string
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    api_key_ids list(string)
    The UUIDs of the API Keys to grant access to the query API.
    roles list(string)
    The Database role that will be used to run the query.
    allowed_origins string
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    apiKeyIds List<String>
    The UUIDs of the API Keys to grant access to the query API.
    roles List<String>
    The Database role that will be used to run the query.
    allowedOrigins String
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    apiKeyIds string[]
    The UUIDs of the API Keys to grant access to the query API.
    roles string[]
    The Database role that will be used to run the query.
    allowedOrigins string
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    api_key_ids Sequence[str]
    The UUIDs of the API Keys to grant access to the query API.
    roles Sequence[str]
    The Database role that will be used to run the query.
    allowed_origins str
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only
    apiKeyIds List<String>
    The UUIDs of the API Keys to grant access to the query API.
    roles List<String>
    The Database role that will be used to run the query.
    allowedOrigins String
    Comma separated list of domain names to be allowed cross-origin resource sharing (CORS) access to the query API. Leave this field empty to restrict access to backend servers only

    ServiceTransparentDataEncryption, ServiceTransparentDataEncryptionArgs

    Enabled bool
    If true, TDE is enabled for the service.
    RoleId string
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    Enabled bool
    If true, TDE is enabled for the service.
    RoleId string
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    enabled bool
    If true, TDE is enabled for the service.
    role_id string
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    enabled Boolean
    If true, TDE is enabled for the service.
    roleId String
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    enabled boolean
    If true, TDE is enabled for the service.
    roleId string
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    enabled bool
    If true, TDE is enabled for the service.
    role_id str
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.
    enabled Boolean
    If true, TDE is enabled for the service.
    roleId String
    ID of Role to be used for granting access to the Encryption Key. This is an ARN for AWS services and a Service Account Identifier for GCP.

    Import

    The pulumi import command can be used, for example:

    Services can be imported by specifying the UUID.

    $ pulumi import clickhouse:index/service:Service example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

    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.1
    published on Thursday, May 21, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-clickhouse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial