alicloud logo
Alibaba Cloud v3.29.0, Jan 20 23

alicloud.clickhouse.DbCluster

Provides a Click House DBCluster resource.

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

NOTE: Available in v1.134.0+.

Example Usage

Basic Usage

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

return await Deployment.RunAsync(() => 
{
    var defaultRegions = AliCloud.ClickHouse.GetRegions.Invoke(new()
    {
        Current = true,
    });

    var defaultNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "default-NODELETING",
    });

    var defaultSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        VpcId = defaultNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        ZoneId = defaultRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.ZoneIds[0]?.ZoneId),
    });

    var defaultDbCluster = new AliCloud.ClickHouse.DbCluster("defaultDbCluster", new()
    {
        DbClusterVersion = "20.3.10.75",
        Category = "Basic",
        DbClusterClass = "S8",
        DbClusterNetworkType = "vpc",
        DbNodeGroupCount = 1,
        PaymentType = "PayAsYouGo",
        DbNodeStorage = "500",
        StorageType = "cloud_essd",
        VswitchId = defaultSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
        DbClusterAccessWhiteLists = new[]
        {
            new AliCloud.ClickHouse.Inputs.DbClusterDbClusterAccessWhiteListArgs
            {
                DbClusterIpArrayAttribute = "test",
                DbClusterIpArrayName = "test",
                SecurityIpList = "192.168.0.1",
            },
        },
    });

});
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"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultRegions, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("default-NODELETING"),
		}, nil)
		if err != nil {
			return err
		}
		defaultSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			VpcId:  pulumi.StringRef(defaultNetworks.Ids[0]),
			ZoneId: pulumi.StringRef(defaultRegions.Regions[0].ZoneIds[0].ZoneId),
		}, nil)
		if err != nil {
			return err
		}
		_, err = clickhouse.NewDbCluster(ctx, "defaultDbCluster", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("20.3.10.75"),
			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:            *pulumi.String(defaultSwitches.Ids[0]),
			DbClusterAccessWhiteLists: clickhouse.DbClusterDbClusterAccessWhiteListArray{
				&clickhouse.DbClusterDbClusterAccessWhiteListArgs{
					DbClusterIpArrayAttribute: pulumi.String("test"),
					DbClusterIpArrayName:      pulumi.String("test"),
					SecurityIpList:            pulumi.String("192.168.0.1"),
				},
			},
		})
		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.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.clickhouse.DbCluster;
import com.pulumi.alicloud.clickhouse.DbClusterArgs;
import com.pulumi.alicloud.clickhouse.inputs.DbClusterDbClusterAccessWhiteListArgs;
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 defaultRegions = ClickhouseFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .build());

        final var defaultNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("default-NODELETING")
            .build());

        final var defaultSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .vpcId(defaultNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
            .zoneId(defaultRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].zoneIds()[0].zoneId()))
            .build());

        var defaultDbCluster = new DbCluster("defaultDbCluster", DbClusterArgs.builder()        
            .dbClusterVersion("20.3.10.75")
            .category("Basic")
            .dbClusterClass("S8")
            .dbClusterNetworkType("vpc")
            .dbNodeGroupCount("1")
            .paymentType("PayAsYouGo")
            .dbNodeStorage("500")
            .storageType("cloud_essd")
            .vswitchId(defaultSwitches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
            .dbClusterAccessWhiteLists(DbClusterDbClusterAccessWhiteListArgs.builder()
                .dbClusterIpArrayAttribute("test")
                .dbClusterIpArrayName("test")
                .securityIpList("192.168.0.1")
                .build())
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

default_regions = alicloud.clickhouse.get_regions(current=True)
default_networks = alicloud.vpc.get_networks(name_regex="default-NODELETING")
default_switches = alicloud.vpc.get_switches(vpc_id=default_networks.ids[0],
    zone_id=default_regions.regions[0].zone_ids[0].zone_id)
default_db_cluster = alicloud.clickhouse.DbCluster("defaultDbCluster",
    db_cluster_version="20.3.10.75",
    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_switches.ids[0],
    db_cluster_access_white_lists=[alicloud.clickhouse.DbClusterDbClusterAccessWhiteListArgs(
        db_cluster_ip_array_attribute="test",
        db_cluster_ip_array_name="test",
        security_ip_list="192.168.0.1",
    )])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultRegions = alicloud.clickhouse.getRegions({
    current: true,
});
const defaultNetworks = alicloud.vpc.getNetworks({
    nameRegex: "default-NODELETING",
});
const defaultSwitches = Promise.all([defaultNetworks, defaultRegions]).then(([defaultNetworks, defaultRegions]) => alicloud.vpc.getSwitches({
    vpcId: defaultNetworks.ids?.[0],
    zoneId: defaultRegions.regions?.[0]?.zoneIds?.[0]?.zoneId,
}));
const defaultDbCluster = new alicloud.clickhouse.DbCluster("defaultDbCluster", {
    dbClusterVersion: "20.3.10.75",
    category: "Basic",
    dbClusterClass: "S8",
    dbClusterNetworkType: "vpc",
    dbNodeGroupCount: 1,
    paymentType: "PayAsYouGo",
    dbNodeStorage: "500",
    storageType: "cloud_essd",
    vswitchId: defaultSwitches.then(defaultSwitches => defaultSwitches.ids?.[0]),
    dbClusterAccessWhiteLists: [{
        dbClusterIpArrayAttribute: "test",
        dbClusterIpArrayName: "test",
        securityIpList: "192.168.0.1",
    }],
});
resources:
  defaultDbCluster:
    type: alicloud:clickhouse:DbCluster
    properties:
      dbClusterVersion: 20.3.10.75
      category: Basic
      dbClusterClass: S8
      dbClusterNetworkType: vpc
      dbNodeGroupCount: '1'
      paymentType: PayAsYouGo
      dbNodeStorage: '500'
      storageType: cloud_essd
      vswitchId: ${defaultSwitches.ids[0]}
      dbClusterAccessWhiteLists:
        - dbClusterIpArrayAttribute: test
          dbClusterIpArrayName: test
          securityIpList: 192.168.0.1
variables:
  defaultRegions:
    fn::invoke:
      Function: alicloud:clickhouse:getRegions
      Arguments:
        current: true
  defaultNetworks:
    fn::invoke:
      Function: alicloud:vpc:getNetworks
      Arguments:
        nameRegex: default-NODELETING
  defaultSwitches:
    fn::invoke:
      Function: alicloud:vpc:getSwitches
      Arguments:
        vpcId: ${defaultNetworks.ids[0]}
        zoneId: ${defaultRegions.regions[0].zoneIds[0].zoneId}

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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.DbClusterDbClusterAccessWhiteListArgs>

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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<DbClusterDbClusterAccessWhiteListArgs>

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 DbClusterDbClusterAccessWhiteListArgs[]

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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.

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 in 1.196.0+) - The connection string of the cluster.

Id string

The provider-assigned unique ID for this managed resource.

Port string

(Available in 1.196.0+) The connection port of the cluster.

ConnectionString string

(Available in 1.196.0+) - The connection string of the cluster.

Id string

The provider-assigned unique ID for this managed resource.

Port string

(Available in 1.196.0+) The connection port of the cluster.

connectionString String

(Available in 1.196.0+) - The connection string of the cluster.

id String

The provider-assigned unique ID for this managed resource.

port String

(Available in 1.196.0+) The connection port of the cluster.

connectionString string

(Available in 1.196.0+) - The connection string of the cluster.

id string

The provider-assigned unique ID for this managed resource.

port string

(Available in 1.196.0+) The connection port of the cluster.

connection_string str

(Available in 1.196.0+) - The connection string of the cluster.

id str

The provider-assigned unique ID for this managed resource.

port str

(Available in 1.196.0+) The connection port of the cluster.

connectionString String

(Available in 1.196.0+) - The connection string of the cluster.

id String

The provider-assigned unique ID for this managed resource.

port String

(Available in 1.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 in 1.196.0+) - The connection string of the cluster.

DbClusterAccessWhiteLists List<Pulumi.AliCloud.ClickHouse.Inputs.DbClusterDbClusterAccessWhiteListArgs>

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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 in 1.196.0+) - The connection string of the cluster.

DbClusterAccessWhiteLists []DbClusterDbClusterAccessWhiteListArgs

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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 in 1.196.0+) - The connection string of the cluster.

dbClusterAccessWhiteLists List<DbClusterDbClusterAccessWhiteListArgs>

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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 in 1.196.0+) - The connection string of the cluster.

dbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteListArgs[]

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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 in 1.196.0+) - The connection string of the cluster.

db_cluster_access_white_lists Sequence[DbClusterDbClusterAccessWhiteListArgs]

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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 in 1.196.0+) - The connection string of the cluster.

dbClusterAccessWhiteLists List<Property Map>

The db cluster access white list.

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: S4-NEW, S8, S16, S32, S64, S104.
  • Under the condition that the category is the HighAvailability, Valid values: C4-NEW, C8, C16, C32, C64, 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 in 1.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

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.