Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. clickhouse
  5. DbCluster
Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.clickhouse.DbCluster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a Click House DBCluster resource.

    For information about Click House DBCluster and how to use it, see What is DBCluster.

    NOTE: Available since v1.134.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const region = config.get("region") || "cn-hangzhou";
const name = config.get("name") || "tf-example";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultGetRegions = alicloud.clickhouse.getRegions({
    regionId: region,
});
const defaultNetwork = new alicloud.vpc.Network("default", {
    vpcName: name,
    cidrBlock: "10.4.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vswitchName: name,
    cidrBlock: "10.4.0.0/24",
    vpcId: defaultNetwork.id,
    zoneId: defaultGetRegions.then(defaultGetRegions => defaultGetRegions.regions?.[0]?.zoneIds?.[0]?.zoneId),
});
const defaultDbCluster = new alicloud.clickhouse.DbCluster("default", {
    dbClusterVersion: "23.8",
    category: "Basic",
    dbClusterClass: "S8",
    dbClusterNetworkType: "vpc",
    dbNodeGroupCount: 1,
    paymentType: "PayAsYouGo",
    dbNodeStorage: "100",
    storageType: "cloud_essd",
    vswitchId: defaultSwitch.id,
    vpcId: defaultNetwork.id,
    resourceGroupId: _default.then(_default => _default.groups?.[0]?.id),
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
region = config.get("region")
if region is None:
    region = "cn-hangzhou"
name = config.get("name")
if name is None:
    name = "tf-example"
default = alicloud.resourcemanager.get_resource_groups()
default_get_regions = alicloud.clickhouse.get_regions(region_id=region)
default_network = alicloud.vpc.Network("default",
    vpc_name=name,
    cidr_block="10.4.0.0/16")
default_switch = alicloud.vpc.Switch("default",
    vswitch_name=name,
    cidr_block="10.4.0.0/24",
    vpc_id=default_network.id,
    zone_id=default_get_regions.regions[0].zone_ids[0].zone_id)
default_db_cluster = alicloud.clickhouse.DbCluster("default",
    db_cluster_version="23.8",
    category="Basic",
    db_cluster_class="S8",
    db_cluster_network_type="vpc",
    db_node_group_count=1,
    payment_type="PayAsYouGo",
    db_node_storage="100",
    storage_type="cloud_essd",
    vswitch_id=default_switch.id,
    vpc_id=default_network.id,
    resource_group_id=default.groups[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/clickhouse"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		region := "cn-hangzhou"
		if param := cfg.Get("region"); param != "" {
			region = param
		}
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetRegions, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			RegionId: pulumi.StringRef(region),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(defaultGetRegions.Regions[0].ZoneIds[0].ZoneId),
		})
		if err != nil {
			return err
		}
		_, err = clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("23.8"),
			Category:             pulumi.String("Basic"),
			DbClusterClass:       pulumi.String("S8"),
			DbClusterNetworkType: pulumi.String("vpc"),
			DbNodeGroupCount:     pulumi.Int(1),
			PaymentType:          pulumi.String("PayAsYouGo"),
			DbNodeStorage:        pulumi.String("100"),
			StorageType:          pulumi.String("cloud_essd"),
			VswitchId:            defaultSwitch.ID(),
			VpcId:                defaultNetwork.ID(),
			ResourceGroupId:      pulumi.String(_default.Groups[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var region = config.Get("region") ?? "cn-hangzhou";
    var name = config.Get("name") ?? "tf-example";
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultGetRegions = AliCloud.ClickHouse.GetRegions.Invoke(new()
    {
        RegionId = region,
    });

    var defaultNetwork = new AliCloud.Vpc.Network("default", new()
    {
        VpcName = name,
        CidrBlock = "10.4.0.0/16",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VswitchName = name,
        CidrBlock = "10.4.0.0/24",
        VpcId = defaultNetwork.Id,
        ZoneId = defaultGetRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.ZoneIds[0]?.ZoneId),
    });

    var defaultDbCluster = new AliCloud.ClickHouse.DbCluster("default", new()
    {
        DbClusterVersion = "23.8",
        Category = "Basic",
        DbClusterClass = "S8",
        DbClusterNetworkType = "vpc",
        DbNodeGroupCount = 1,
        PaymentType = "PayAsYouGo",
        DbNodeStorage = "100",
        StorageType = "cloud_essd",
        VswitchId = defaultSwitch.Id,
        VpcId = defaultNetwork.Id,
        ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Groups[0]?.Id)),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.clickhouse.ClickhouseFunctions;
import com.pulumi.alicloud.clickhouse.inputs.GetRegionsArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.clickhouse.DbCluster;
import com.pulumi.alicloud.clickhouse.DbClusterArgs;
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) {
        final var config = ctx.config();
        final var region = config.get("region").orElse("cn-hangzhou");
        final var name = config.get("name").orElse("tf-example");
        final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .build());

        final var defaultGetRegions = ClickhouseFunctions.getRegions(GetRegionsArgs.builder()
            .regionId(region)
            .build());

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("10.4.0.0/16")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName(name)
            .cidrBlock("10.4.0.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(defaultGetRegions.regions()[0].zoneIds()[0].zoneId())
            .build());

        var defaultDbCluster = new DbCluster("defaultDbCluster", DbClusterArgs.builder()
            .dbClusterVersion("23.8")
            .category("Basic")
            .dbClusterClass("S8")
            .dbClusterNetworkType("vpc")
            .dbNodeGroupCount(1)
            .paymentType("PayAsYouGo")
            .dbNodeStorage("100")
            .storageType("cloud_essd")
            .vswitchId(defaultSwitch.id())
            .vpcId(defaultNetwork.id())
            .resourceGroupId(default_.groups()[0].id())
            .build());

    }
}

    configuration:
  region:
    type: string
    default: cn-hangzhou
  name:
    type: string
    default: tf-example
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    name: default
    properties:
      vpcName: ${name}
      cidrBlock: 10.4.0.0/16
  defaultSwitch:
    type: alicloud:vpc:Switch
    name: default
    properties:
      vswitchName: ${name}
      cidrBlock: 10.4.0.0/24
      vpcId: ${defaultNetwork.id}
      zoneId: ${defaultGetRegions.regions[0].zoneIds[0].zoneId}
  defaultDbCluster:
    type: alicloud:clickhouse:DbCluster
    name: default
    properties:
      dbClusterVersion: '23.8'
      category: Basic
      dbClusterClass: S8
      dbClusterNetworkType: vpc
      dbNodeGroupCount: '1'
      paymentType: PayAsYouGo
      dbNodeStorage: '100'
      storageType: cloud_essd
      vswitchId: ${defaultSwitch.id}
      vpcId: ${defaultNetwork.id}
      resourceGroupId: ${default.groups[0].id}
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
  defaultGetRegions:
    fn::invoke:
      function: alicloud:clickhouse:getRegions
      arguments:
        regionId: ${region}

    Create DbCluster Resource

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

    Constructor syntax

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

@overload
def DbCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              db_node_group_count: Optional[int] = None,
              category: Optional[str] = None,
              storage_type: Optional[str] = None,
              payment_type: Optional[str] = None,
              db_cluster_class: Optional[str] = None,
              db_node_storage: Optional[str] = None,
              db_cluster_network_type: Optional[str] = None,
              db_cluster_version: Optional[str] = None,
              maintain_time: Optional[str] = None,
              period: Optional[str] = None,
              encryption_key: Optional[str] = None,
              encryption_type: Optional[str] = None,
              allocate_public_connection: Optional[bool] = None,
              multi_zone_vswitch_lists: Optional[Sequence[DbClusterMultiZoneVswitchListArgs]] = None,
              db_cluster_access_white_lists: Optional[Sequence[DbClusterDbClusterAccessWhiteListArgs]] = None,
              db_cluster_description: Optional[str] = None,
              renewal_status: Optional[str] = None,
              resource_group_id: Optional[str] = None,
              status: Optional[str] = None,
              cold_storage: Optional[str] = None,
              used_time: Optional[str] = None,
              vpc_id: Optional[str] = None,
              vswitch_id: Optional[str] = None,
              zone_id: Optional[str] = None)
    func NewDbCluster(ctx *Context, name string, args DbClusterArgs, opts ...ResourceOption) (*DbCluster, error)
    public DbCluster(string name, DbClusterArgs args, CustomResourceOptions? opts = null)
    public DbCluster(String name, DbClusterArgs args)
public DbCluster(String name, DbClusterArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args DbClusterArgs
    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 DbClusterArgs
    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 DbClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbClusterArgs
    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 dbClusterResource = new AliCloud.ClickHouse.DbCluster("dbClusterResource", new()
{
    DbNodeGroupCount = 0,
    Category = "string",
    StorageType = "string",
    PaymentType = "string",
    DbClusterClass = "string",
    DbNodeStorage = "string",
    DbClusterNetworkType = "string",
    DbClusterVersion = "string",
    MaintainTime = "string",
    Period = "string",
    EncryptionKey = "string",
    EncryptionType = "string",
    AllocatePublicConnection = false,
    MultiZoneVswitchLists = new[]
    {
        new AliCloud.ClickHouse.Inputs.DbClusterMultiZoneVswitchListArgs
        {
            VswitchId = "string",
            ZoneId = "string",
        },
    },
    DbClusterAccessWhiteLists = new[]
    {
        new AliCloud.ClickHouse.Inputs.DbClusterDbClusterAccessWhiteListArgs
        {
            DbClusterIpArrayAttribute = "string",
            DbClusterIpArrayName = "string",
            SecurityIpList = "string",
        },
    },
    DbClusterDescription = "string",
    RenewalStatus = "string",
    ResourceGroupId = "string",
    Status = "string",
    ColdStorage = "string",
    UsedTime = "string",
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});

    example, err := clickhouse.NewDbCluster(ctx, "dbClusterResource", &clickhouse.DbClusterArgs{
	DbNodeGroupCount:         pulumi.Int(0),
	Category:                 pulumi.String("string"),
	StorageType:              pulumi.String("string"),
	PaymentType:              pulumi.String("string"),
	DbClusterClass:           pulumi.String("string"),
	DbNodeStorage:            pulumi.String("string"),
	DbClusterNetworkType:     pulumi.String("string"),
	DbClusterVersion:         pulumi.String("string"),
	MaintainTime:             pulumi.String("string"),
	Period:                   pulumi.String("string"),
	EncryptionKey:            pulumi.String("string"),
	EncryptionType:           pulumi.String("string"),
	AllocatePublicConnection: pulumi.Bool(false),
	MultiZoneVswitchLists: clickhouse.DbClusterMultiZoneVswitchListArray{
		&clickhouse.DbClusterMultiZoneVswitchListArgs{
			VswitchId: pulumi.String("string"),
			ZoneId:    pulumi.String("string"),
		},
	},
	DbClusterAccessWhiteLists: clickhouse.DbClusterDbClusterAccessWhiteListArray{
		&clickhouse.DbClusterDbClusterAccessWhiteListArgs{
			DbClusterIpArrayAttribute: pulumi.String("string"),
			DbClusterIpArrayName:      pulumi.String("string"),
			SecurityIpList:            pulumi.String("string"),
		},
	},
	DbClusterDescription: pulumi.String("string"),
	RenewalStatus:        pulumi.String("string"),
	ResourceGroupId:      pulumi.String("string"),
	Status:               pulumi.String("string"),
	ColdStorage:          pulumi.String("string"),
	UsedTime:             pulumi.String("string"),
	VpcId:                pulumi.String("string"),
	VswitchId:            pulumi.String("string"),
	ZoneId:               pulumi.String("string"),
})

    var dbClusterResource = new com.pulumi.alicloud.clickhouse.DbCluster("dbClusterResource", com.pulumi.alicloud.clickhouse.DbClusterArgs.builder()
    .dbNodeGroupCount(0)
    .category("string")
    .storageType("string")
    .paymentType("string")
    .dbClusterClass("string")
    .dbNodeStorage("string")
    .dbClusterNetworkType("string")
    .dbClusterVersion("string")
    .maintainTime("string")
    .period("string")
    .encryptionKey("string")
    .encryptionType("string")
    .allocatePublicConnection(false)
    .multiZoneVswitchLists(DbClusterMultiZoneVswitchListArgs.builder()
        .vswitchId("string")
        .zoneId("string")
        .build())
    .dbClusterAccessWhiteLists(DbClusterDbClusterAccessWhiteListArgs.builder()
        .dbClusterIpArrayAttribute("string")
        .dbClusterIpArrayName("string")
        .securityIpList("string")
        .build())
    .dbClusterDescription("string")
    .renewalStatus("string")
    .resourceGroupId("string")
    .status("string")
    .coldStorage("string")
    .usedTime("string")
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());

    db_cluster_resource = alicloud.clickhouse.DbCluster("dbClusterResource",
    db_node_group_count=0,
    category="string",
    storage_type="string",
    payment_type="string",
    db_cluster_class="string",
    db_node_storage="string",
    db_cluster_network_type="string",
    db_cluster_version="string",
    maintain_time="string",
    period="string",
    encryption_key="string",
    encryption_type="string",
    allocate_public_connection=False,
    multi_zone_vswitch_lists=[{
        "vswitch_id": "string",
        "zone_id": "string",
    }],
    db_cluster_access_white_lists=[{
        "db_cluster_ip_array_attribute": "string",
        "db_cluster_ip_array_name": "string",
        "security_ip_list": "string",
    }],
    db_cluster_description="string",
    renewal_status="string",
    resource_group_id="string",
    status="string",
    cold_storage="string",
    used_time="string",
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")

    const dbClusterResource = new alicloud.clickhouse.DbCluster("dbClusterResource", {
    dbNodeGroupCount: 0,
    category: "string",
    storageType: "string",
    paymentType: "string",
    dbClusterClass: "string",
    dbNodeStorage: "string",
    dbClusterNetworkType: "string",
    dbClusterVersion: "string",
    maintainTime: "string",
    period: "string",
    encryptionKey: "string",
    encryptionType: "string",
    allocatePublicConnection: false,
    multiZoneVswitchLists: [{
        vswitchId: "string",
        zoneId: "string",
    }],
    dbClusterAccessWhiteLists: [{
        dbClusterIpArrayAttribute: "string",
        dbClusterIpArrayName: "string",
        securityIpList: "string",
    }],
    dbClusterDescription: "string",
    renewalStatus: "string",
    resourceGroupId: "string",
    status: "string",
    coldStorage: "string",
    usedTime: "string",
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});

    type: alicloud:clickhouse:DbCluster
properties:
    allocatePublicConnection: false
    category: string
    coldStorage: string
    dbClusterAccessWhiteLists:
        - dbClusterIpArrayAttribute: string
          dbClusterIpArrayName: string
          securityIpList: string
    dbClusterClass: string
    dbClusterDescription: string
    dbClusterNetworkType: string
    dbClusterVersion: string
    dbNodeGroupCount: 0
    dbNodeStorage: string
    encryptionKey: string
    encryptionType: string
    maintainTime: string
    multiZoneVswitchLists:
        - vswitchId: string
          zoneId: string
    paymentType: string
    period: string
    renewalStatus: string
    resourceGroupId: string
    status: string
    storageType: string
    usedTime: string
    vpcId: string
    vswitchId: string
    zoneId: string

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

    Category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    DbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    DbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    DbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    DbNodeGroupCount int
    The db node group count. The number should between 1 and 48.
    DbNodeStorage string
    The db node storage.
    PaymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    StorageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    AllocatePublicConnection bool
    Whether to enable public connection. Value options: true, false.
    ColdStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    DbClusterAccessWhiteLists List<Pulumi.AliCloud.ClickHouse.Inputs.DbClusterDbClusterAccessWhiteList>
    The db cluster access white list. See db_cluster_access_white_list below.
    DbClusterDescription string
    The DBCluster description.
    EncryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    EncryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    MaintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    MultiZoneVswitchLists List<Pulumi.AliCloud.ClickHouse.Inputs.DbClusterMultiZoneVswitchList>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    Period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    RenewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    UsedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    VpcId string
    The id of the VPC.
    VswitchId string
    The vswitch id of DBCluster.
    ZoneId string
    The zone ID of the instance.
    Category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    DbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    DbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    DbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    DbNodeGroupCount int
    The db node group count. The number should between 1 and 48.
    DbNodeStorage string
    The db node storage.
    PaymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    StorageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    AllocatePublicConnection bool
    Whether to enable public connection. Value options: true, false.
    ColdStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    DbClusterAccessWhiteLists []DbClusterDbClusterAccessWhiteListArgs
    The db cluster access white list. See db_cluster_access_white_list below.
    DbClusterDescription string
    The DBCluster description.
    EncryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    EncryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    MaintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    MultiZoneVswitchLists []DbClusterMultiZoneVswitchListArgs
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    Period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    RenewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    UsedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    VpcId string
    The id of the VPC.
    VswitchId string
    The vswitch id of DBCluster.
    ZoneId string
    The zone ID of the instance.
    category String
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    dbClusterClass String
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterNetworkType String
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion String
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount Integer
    The db node group count. The number should between 1 and 48.
    dbNodeStorage String
    The db node storage.
    paymentType String
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    storageType String
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    allocatePublicConnection Boolean
    Whether to enable public connection. Value options: true, false.
    coldStorage String
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    dbClusterAccessWhiteLists List<DbClusterDbClusterAccessWhiteList>
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterDescription String
    The DBCluster description.
    encryptionKey String
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType String
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime String
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists List<DbClusterMultiZoneVswitchList>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    period String
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    renewalStatus String
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    usedTime String
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId String
    The id of the VPC.
    vswitchId String
    The vswitch id of DBCluster.
    zoneId String
    The zone ID of the instance.
    category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    dbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount number
    The db node group count. The number should between 1 and 48.
    dbNodeStorage string
    The db node storage.
    paymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    storageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    allocatePublicConnection boolean
    Whether to enable public connection. Value options: true, false.
    coldStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    dbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteList[]
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterDescription string
    The DBCluster description.
    encryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists DbClusterMultiZoneVswitchList[]
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    renewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId string
    The ID of the resource group.
    status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    usedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId string
    The id of the VPC.
    vswitchId string
    The vswitch id of DBCluster.
    zoneId string
    The zone ID of the instance.
    category str
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    db_cluster_class str
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    db_cluster_network_type str
    The DBCluster network type. Valid values: vpc.
    db_cluster_version str
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    db_node_group_count int
    The db node group count. The number should between 1 and 48.
    db_node_storage str
    The db node storage.
    payment_type str
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    storage_type str
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    allocate_public_connection bool
    Whether to enable public connection. Value options: true, false.
    cold_storage str
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    db_cluster_access_white_lists Sequence[DbClusterDbClusterAccessWhiteListArgs]
    The db cluster access white list. See db_cluster_access_white_list below.
    db_cluster_description str
    The DBCluster description.
    encryption_key str
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryption_type str
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintain_time str
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multi_zone_vswitch_lists Sequence[DbClusterMultiZoneVswitchListArgs]
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    period str
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    renewal_status str
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resource_group_id str
    The ID of the resource group.
    status str
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    used_time str
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpc_id str
    The id of the VPC.
    vswitch_id str
    The vswitch id of DBCluster.
    zone_id str
    The zone ID of the instance.
    category String
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    dbClusterClass String
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterNetworkType String
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion String
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount Number
    The db node group count. The number should between 1 and 48.
    dbNodeStorage String
    The db node storage.
    paymentType String
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    storageType String
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    allocatePublicConnection Boolean
    Whether to enable public connection. Value options: true, false.
    coldStorage String
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    dbClusterAccessWhiteLists List<Property Map>
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterDescription String
    The DBCluster description.
    encryptionKey String
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType String
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime String
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists List<Property Map>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    period String
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    renewalStatus String
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    usedTime String
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId String
    The id of the VPC.
    vswitchId String
    The vswitch id of DBCluster.
    zoneId String
    The zone ID of the instance.

    Outputs

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

    ConnectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    (Available since v1.196.0) The connection port of the cluster.
    PublicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    ConnectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    (Available since v1.196.0) The connection port of the cluster.
    PublicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    connectionString String
    (Available since v1.196.0) - The connection string of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString String
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    connectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    port string
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    connection_string str
    (Available since v1.196.0) - The connection string of the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    port str
    (Available since v1.196.0) The connection port of the cluster.
    public_connection_string str
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    connectionString String
    (Available since v1.196.0) - The connection string of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString String
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.

    Look up Existing DbCluster Resource

    Get an existing DbCluster 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?: DbClusterState, opts?: CustomResourceOptions): DbCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocate_public_connection: Optional[bool] = None,
        category: Optional[str] = None,
        cold_storage: Optional[str] = None,
        connection_string: Optional[str] = None,
        db_cluster_access_white_lists: Optional[Sequence[DbClusterDbClusterAccessWhiteListArgs]] = None,
        db_cluster_class: Optional[str] = None,
        db_cluster_description: Optional[str] = None,
        db_cluster_network_type: Optional[str] = None,
        db_cluster_version: Optional[str] = None,
        db_node_group_count: Optional[int] = None,
        db_node_storage: Optional[str] = None,
        encryption_key: Optional[str] = None,
        encryption_type: Optional[str] = None,
        maintain_time: Optional[str] = None,
        multi_zone_vswitch_lists: Optional[Sequence[DbClusterMultiZoneVswitchListArgs]] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        port: Optional[str] = None,
        public_connection_string: Optional[str] = None,
        renewal_status: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        status: Optional[str] = None,
        storage_type: Optional[str] = None,
        used_time: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> DbCluster
    func GetDbCluster(ctx *Context, name string, id IDInput, state *DbClusterState, opts ...ResourceOption) (*DbCluster, error)
    public static DbCluster Get(string name, Input<string> id, DbClusterState? state, CustomResourceOptions? opts = null)
    public static DbCluster get(String name, Output<String> id, DbClusterState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:clickhouse:DbCluster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllocatePublicConnection bool
    Whether to enable public connection. Value options: true, false.
    Category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    ColdStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    ConnectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    DbClusterAccessWhiteLists List<Pulumi.AliCloud.ClickHouse.Inputs.DbClusterDbClusterAccessWhiteList>
    The db cluster access white list. See db_cluster_access_white_list below.
    DbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    DbClusterDescription string
    The DBCluster description.
    DbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    DbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    DbNodeGroupCount int
    The db node group count. The number should between 1 and 48.
    DbNodeStorage string
    The db node storage.
    EncryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    EncryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    MaintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    MultiZoneVswitchLists List<Pulumi.AliCloud.ClickHouse.Inputs.DbClusterMultiZoneVswitchList>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    PaymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    Period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    Port string
    (Available since v1.196.0) The connection port of the cluster.
    PublicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    RenewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    StorageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    UsedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    VpcId string
    The id of the VPC.
    VswitchId string
    The vswitch id of DBCluster.
    ZoneId string
    The zone ID of the instance.
    AllocatePublicConnection bool
    Whether to enable public connection. Value options: true, false.
    Category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    ColdStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    ConnectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    DbClusterAccessWhiteLists []DbClusterDbClusterAccessWhiteListArgs
    The db cluster access white list. See db_cluster_access_white_list below.
    DbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    DbClusterDescription string
    The DBCluster description.
    DbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    DbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    DbNodeGroupCount int
    The db node group count. The number should between 1 and 48.
    DbNodeStorage string
    The db node storage.
    EncryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    EncryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    MaintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    MultiZoneVswitchLists []DbClusterMultiZoneVswitchListArgs
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    PaymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    Period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    Port string
    (Available since v1.196.0) The connection port of the cluster.
    PublicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    RenewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    StorageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    UsedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    VpcId string
    The id of the VPC.
    VswitchId string
    The vswitch id of DBCluster.
    ZoneId string
    The zone ID of the instance.
    allocatePublicConnection Boolean
    Whether to enable public connection. Value options: true, false.
    category String
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    coldStorage String
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    connectionString String
    (Available since v1.196.0) - The connection string of the cluster.
    dbClusterAccessWhiteLists List<DbClusterDbClusterAccessWhiteList>
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterClass String
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterDescription String
    The DBCluster description.
    dbClusterNetworkType String
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion String
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount Integer
    The db node group count. The number should between 1 and 48.
    dbNodeStorage String
    The db node storage.
    encryptionKey String
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType String
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime String
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists List<DbClusterMultiZoneVswitchList>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    paymentType String
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    period String
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    port String
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString String
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    renewalStatus String
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    storageType String
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    usedTime String
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId String
    The id of the VPC.
    vswitchId String
    The vswitch id of DBCluster.
    zoneId String
    The zone ID of the instance.
    allocatePublicConnection boolean
    Whether to enable public connection. Value options: true, false.
    category string
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    coldStorage string
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    connectionString string
    (Available since v1.196.0) - The connection string of the cluster.
    dbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteList[]
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterClass string
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterDescription string
    The DBCluster description.
    dbClusterNetworkType string
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion string
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount number
    The db node group count. The number should between 1 and 48.
    dbNodeStorage string
    The db node storage.
    encryptionKey string
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType string
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime string
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists DbClusterMultiZoneVswitchList[]
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    paymentType string
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    period string
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    port string
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString string
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    renewalStatus string
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId string
    The ID of the resource group.
    status string
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    storageType string
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    usedTime string
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId string
    The id of the VPC.
    vswitchId string
    The vswitch id of DBCluster.
    zoneId string
    The zone ID of the instance.
    allocate_public_connection bool
    Whether to enable public connection. Value options: true, false.
    category str
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    cold_storage str
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    connection_string str
    (Available since v1.196.0) - The connection string of the cluster.
    db_cluster_access_white_lists Sequence[DbClusterDbClusterAccessWhiteListArgs]
    The db cluster access white list. See db_cluster_access_white_list below.
    db_cluster_class str
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    db_cluster_description str
    The DBCluster description.
    db_cluster_network_type str
    The DBCluster network type. Valid values: vpc.
    db_cluster_version str
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    db_node_group_count int
    The db node group count. The number should between 1 and 48.
    db_node_storage str
    The db node storage.
    encryption_key str
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryption_type str
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintain_time str
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multi_zone_vswitch_lists Sequence[DbClusterMultiZoneVswitchListArgs]
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    payment_type str
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    period str
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    port str
    (Available since v1.196.0) The connection port of the cluster.
    public_connection_string str
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    renewal_status str
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resource_group_id str
    The ID of the resource group.
    status str
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    storage_type str
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    used_time str
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpc_id str
    The id of the VPC.
    vswitch_id str
    The vswitch id of DBCluster.
    zone_id str
    The zone ID of the instance.
    allocatePublicConnection Boolean
    Whether to enable public connection. Value options: true, false.
    category String
    The Category of DBCluster. Valid values: Basic,HighAvailability.
    coldStorage String
    Whether to use cold storage. Valid values: ENABLE, DISABLE, default to DISABLE. When it's set to ENABLE, cold storage will be used, and cold_storage cannot be set to DISABLE again.
    connectionString String
    (Available since v1.196.0) - The connection string of the cluster.
    dbClusterAccessWhiteLists List<Property Map>
    The db cluster access white list. See db_cluster_access_white_list below.
    dbClusterClass String
    The DBCluster class. According to the category, db_cluster_class has two value ranges:

    • Under the condition that the category is the Basic, Valid values: LS20, LS40, LS80,S8, S16, S32, S64,S80, S104.
    • Under the condition that the category is the HighAvailability, Valid values: LC20, LC40, LC80,C8, C16, C32, C64, C80, C104.
    dbClusterDescription String
    The DBCluster description.
    dbClusterNetworkType String
    The DBCluster network type. Valid values: vpc.
    dbClusterVersion String
    The DBCluster version. Valid values: 20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8. NOTE: 19.15.2.2 is no longer supported. From version 1.191.0, db_cluster_version can be set to 22.8.5.29.
    dbNodeGroupCount Number
    The db node group count. The number should between 1 and 48.
    dbNodeStorage String
    The db node storage.
    encryptionKey String
    Key management service KMS key ID. It is valid and required when encryption_type is CloudDisk.
    encryptionType String
    Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
    maintainTime String
    The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.
    multiZoneVswitchLists List<Property Map>
    The zone IDs and corresponding vswitch IDs and zone IDs of multi-zone setup. if set, a multi-zone DBCluster will be created. Currently only support 2 available zones, primary zone not included. See multi_zone_vswitch_list below.
    paymentType String
    The payment type of the resource. Valid values: PayAsYouGo,Subscription.
    period String
    Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when payment_type is Subscription. Valid values: Month, Year.
    port String
    (Available since v1.196.0) The connection port of the cluster.
    publicConnectionString String
    (Available since v1.245.0) The public connection string of the cluster. Only valid when allocate_public_connection is true.
    renewalStatus String
    The renewal status of the resource. Valid values: AutoRenewal,Normal. It is valid and required when payment_type is Subscription. When renewal_status is set to AutoRenewal, the resource is renewed automatically.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.
    storageType String
    Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
    usedTime String
    The used time of DBCluster. It is valid and required when payment_type is Subscription. item choices: [1-9] when period is Month, [1-3] when period is Year.
    vpcId String
    The id of the VPC.
    vswitchId String
    The vswitch id of DBCluster.
    zoneId String
    The zone ID of the instance.

    Supporting Types

    DbClusterDbClusterAccessWhiteList, DbClusterDbClusterAccessWhiteListArgs

    DbClusterIpArrayAttribute string
    Field db_cluster_ip_array_attribute has been removed from provider.
    DbClusterIpArrayName string
    Whitelist group name.
    SecurityIpList string
    The IP address list under the whitelist group.
    DbClusterIpArrayAttribute string
    Field db_cluster_ip_array_attribute has been removed from provider.
    DbClusterIpArrayName string
    Whitelist group name.
    SecurityIpList string
    The IP address list under the whitelist group.
    dbClusterIpArrayAttribute String
    Field db_cluster_ip_array_attribute has been removed from provider.
    dbClusterIpArrayName String
    Whitelist group name.
    securityIpList String
    The IP address list under the whitelist group.
    dbClusterIpArrayAttribute string
    Field db_cluster_ip_array_attribute has been removed from provider.
    dbClusterIpArrayName string
    Whitelist group name.
    securityIpList string
    The IP address list under the whitelist group.
    db_cluster_ip_array_attribute str
    Field db_cluster_ip_array_attribute has been removed from provider.
    db_cluster_ip_array_name str
    Whitelist group name.
    security_ip_list str
    The IP address list under the whitelist group.
    dbClusterIpArrayAttribute String
    Field db_cluster_ip_array_attribute has been removed from provider.
    dbClusterIpArrayName String
    Whitelist group name.
    securityIpList String
    The IP address list under the whitelist group.

    DbClusterMultiZoneVswitchList, DbClusterMultiZoneVswitchListArgs

    VswitchId string
    The ID of the vswitch.
    ZoneId string
    The zone ID of the vswitch.
    VswitchId string
    The ID of the vswitch.
    ZoneId string
    The zone ID of the vswitch.
    vswitchId String
    The ID of the vswitch.
    zoneId String
    The zone ID of the vswitch.
    vswitchId string
    The ID of the vswitch.
    zoneId string
    The zone ID of the vswitch.
    vswitch_id str
    The ID of the vswitch.
    zone_id str
    The zone ID of the vswitch.
    vswitchId String
    The ID of the vswitch.
    zoneId String
    The zone ID of the vswitch.

    Import

    Click House DBCluster can be imported using the id, e.g.

    $ pulumi import alicloud:clickhouse/dbCluster:DbCluster example <id>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
    pulumi/pulumi-alicloud