Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. clickhouse
  5. DbCluster
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.clickhouse.DbCluster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 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

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf-example";
    var defaultRegions = AliCloud.ClickHouse.GetRegions.Invoke(new()
    {
        Current = true,
    });

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

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

    var defaultDbCluster = new AliCloud.ClickHouse.DbCluster("defaultDbCluster", new()
    {
        DbClusterVersion = "22.8.5.29",
        Category = "Basic",
        DbClusterClass = "S8",
        DbClusterNetworkType = "vpc",
        DbNodeGroupCount = 1,
        PaymentType = "PayAsYouGo",
        DbNodeStorage = "500",
        StorageType = "cloud_essd",
        VswitchId = defaultSwitch.Id,
        VpcId = defaultNetwork.Id,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/clickhouse"
	"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, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		defaultRegions, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      *pulumi.String(defaultRegions.Regions[0].ZoneIds[0].ZoneId),
		})
		if err != nil {
			return err
		}
		_, err = clickhouse.NewDbCluster(ctx, "defaultDbCluster", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("22.8.5.29"),
			Category:             pulumi.String("Basic"),
			DbClusterClass:       pulumi.String("S8"),
			DbClusterNetworkType: pulumi.String("vpc"),
			DbNodeGroupCount:     pulumi.Int(1),
			PaymentType:          pulumi.String("PayAsYouGo"),
			DbNodeStorage:        pulumi.String("500"),
			StorageType:          pulumi.String("cloud_essd"),
			VswitchId:            defaultSwitch.ID(),
			VpcId:                defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.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 name = config.get("name").orElse("tf-example");
        final var defaultRegions = ClickhouseFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .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(defaultRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].zoneIds()[0].zoneId()))
            .build());

        var defaultDbCluster = new DbCluster("defaultDbCluster", DbClusterArgs.builder()        
            .dbClusterVersion("22.8.5.29")
            .category("Basic")
            .dbClusterClass("S8")
            .dbClusterNetworkType("vpc")
            .dbNodeGroupCount("1")
            .paymentType("PayAsYouGo")
            .dbNodeStorage("500")
            .storageType("cloud_essd")
            .vswitchId(defaultSwitch.id())
            .vpcId(defaultNetwork.id())
            .build());

    }
}

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
default_regions = alicloud.clickhouse.get_regions(current=True)
default_network = alicloud.vpc.Network("defaultNetwork",
    vpc_name=name,
    cidr_block="10.4.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    vswitch_name=name,
    cidr_block="10.4.0.0/24",
    vpc_id=default_network.id,
    zone_id=default_regions.regions[0].zone_ids[0].zone_id)
default_db_cluster = alicloud.clickhouse.DbCluster("defaultDbCluster",
    db_cluster_version="22.8.5.29",
    category="Basic",
    db_cluster_class="S8",
    db_cluster_network_type="vpc",
    db_node_group_count=1,
    payment_type="PayAsYouGo",
    db_node_storage="500",
    storage_type="cloud_essd",
    vswitch_id=default_switch.id,
    vpc_id=default_network.id)

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

const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const defaultRegions = alicloud.clickhouse.getRegions({
    current: true,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
    vpcName: name,
    cidrBlock: "10.4.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vswitchName: name,
    cidrBlock: "10.4.0.0/24",
    vpcId: defaultNetwork.id,
    zoneId: defaultRegions.then(defaultRegions => defaultRegions.regions?.[0]?.zoneIds?.[0]?.zoneId),
});
const defaultDbCluster = new alicloud.clickhouse.DbCluster("defaultDbCluster", {
    dbClusterVersion: "22.8.5.29",
    category: "Basic",
    dbClusterClass: "S8",
    dbClusterNetworkType: "vpc",
    dbNodeGroupCount: 1,
    paymentType: "PayAsYouGo",
    dbNodeStorage: "500",
    storageType: "cloud_essd",
    vswitchId: defaultSwitch.id,
    vpcId: defaultNetwork.id,
});

    configuration:
  name:
    type: string
    default: tf-example
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    properties:
      vpcName: ${name}
      cidrBlock: 10.4.0.0/16
  defaultSwitch:
    type: alicloud:vpc:Switch
    properties:
      vswitchName: ${name}
      cidrBlock: 10.4.0.0/24
      vpcId: ${defaultNetwork.id}
      zoneId: ${defaultRegions.regions[0].zoneIds[0].zoneId}
  defaultDbCluster:
    type: alicloud:clickhouse:DbCluster
    properties:
      dbClusterVersion: 22.8.5.29
      category: Basic
      dbClusterClass: S8
      dbClusterNetworkType: vpc
      dbNodeGroupCount: '1'
      paymentType: PayAsYouGo
      dbNodeStorage: '500'
      storageType: cloud_essd
      vswitchId: ${defaultSwitch.id}
      vpcId: ${defaultNetwork.id}
variables:
  defaultRegions:
    fn::invoke:
      Function: alicloud:clickhouse:getRegions
      Arguments:
        current: true

    Create DbCluster Resource

    new DbCluster(name: string, args: DbClusterArgs, opts?: CustomResourceOptions);
    @overload
def DbCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              category: 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,
              payment_type: Optional[str] = None,
              period: 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)
@overload
def DbCluster(resource_name: str,
              args: DbClusterArgs,
              opts: Optional[ResourceOptions] = 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.
    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.

    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

    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. 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.

    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.

    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.

    Period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    Status string

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    UsedTime string

    The used time of DBCluster.

    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. 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.

    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.

    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.

    Period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    Status string

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    UsedTime string

    The used time of DBCluster.

    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. 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.

    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.

    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.

    period String

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    status String

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    usedTime String

    The used time of DBCluster.

    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. 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.

    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.

    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.

    period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    status string

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    usedTime string

    The used time of DBCluster.

    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. 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.

    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.

    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.

    period str

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    status str

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    used_time str

    The used time of DBCluster.

    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. 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.

    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.

    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.

    period String

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    status String

    The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing.

    usedTime String

    The used time of DBCluster.

    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.

    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.

    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.

    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.

    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.

    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.

    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,
        category: 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,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        port: 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Category string

    The Category of DBCluster. Valid values: Basic,HighAvailability.

    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. 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.

    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.

    PaymentType string

    The payment type of the resource. Valid values: PayAsYouGo,Subscription.

    Period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    Port string

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    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. 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.

    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.

    PaymentType string

    The payment type of the resource. Valid values: PayAsYouGo,Subscription.

    Period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    Port string

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    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. 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.

    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.

    paymentType String

    The payment type of the resource. Valid values: PayAsYouGo,Subscription.

    period String

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    port String

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    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. 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.

    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.

    paymentType string

    The payment type of the resource. Valid values: PayAsYouGo,Subscription.

    period string

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    port string

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    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. 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.

    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.

    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. Valid values: Month, Year.

    port str

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    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. 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.

    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.

    paymentType String

    The payment type of the resource. Valid values: PayAsYouGo,Subscription.

    period String

    Pre-paid cluster of the pay-as-you-go cycle. Valid values: Month, Year.

    port String

    (Available since v1.196.0) The connection port of the cluster.

    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.

    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.

    Import

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

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

    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.43.1 published on Monday, Sep 11, 2023 by Pulumi
    pulumi/pulumi-alicloud