pulumi-alicloud-kotlin/com.pulumi.alicloud.clickhouse.kotlin/DbClusterArgs

DbClusterArgs

data class DbClusterArgs(val category: Output<String>? = null, val dbClusterAccessWhiteLists: Output<List<DbClusterDbClusterAccessWhiteListArgs>>? = null, val dbClusterClass: Output<String>? = null, val dbClusterDescription: Output<String>? = null, val dbClusterNetworkType: Output<String>? = null, val dbClusterVersion: Output<String>? = null, val dbNodeGroupCount: Output<Int>? = null, val dbNodeStorage: Output<String>? = null, val encryptionKey: Output<String>? = null, val encryptionType: Output<String>? = null, val maintainTime: Output<String>? = null, val paymentType: Output<String>? = null, val period: Output<String>? = null, val status: Output<String>? = null, val storageType: Output<String>? = null, val usedTime: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<DbClusterArgs>

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

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());
    }
}
Content copied to clipboard

Import

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

$ pulumi import alicloud:clickhouse/dbCluster:DbCluster example <id>
Content copied to clipboard

Constructors

Link copied to clipboard
fun DbClusterArgs(category: Output<String>? = null, dbClusterAccessWhiteLists: Output<List<DbClusterDbClusterAccessWhiteListArgs>>? = null, dbClusterClass: Output<String>? = null, dbClusterDescription: Output<String>? = null, dbClusterNetworkType: Output<String>? = null, dbClusterVersion: Output<String>? = null, dbNodeGroupCount: Output<Int>? = null, dbNodeStorage: Output<String>? = null, encryptionKey: Output<String>? = null, encryptionType: Output<String>? = null, maintainTime: Output<String>? = null, paymentType: Output<String>? = null, period: Output<String>? = null, status: Output<String>? = null, storageType: Output<String>? = null, usedTime: Output<String>? = null, vpcId: Output<String>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DbClusterArgs

Properties

Link copied to clipboard
val category: Output<String>? = null

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

Link copied to clipboard
val dbClusterAccessWhiteLists: Output<List<DbClusterDbClusterAccessWhiteListArgs>>? = null

The db cluster access white list. See db_cluster_access_white_list below.

Link copied to clipboard
val dbClusterClass: Output<String>? = null

The DBCluster class. According to the category, db_cluster_class has two value ranges:

Link copied to clipboard
val dbClusterDescription: Output<String>? = null

The DBCluster description.

Link copied to clipboard
val dbClusterNetworkType: Output<String>? = null

The DBCluster network type. Valid values: vpc.

Link copied to clipboard
val dbClusterVersion: Output<String>? = null

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.

Link copied to clipboard
val dbNodeGroupCount: Output<Int>? = null

The db node group count. The number should between 1 and 48.

Link copied to clipboard
val dbNodeStorage: Output<String>? = null

The db node storage.

Link copied to clipboard
val encryptionKey: Output<String>? = null

Key management service KMS key ID.

Link copied to clipboard
val encryptionType: Output<String>? = null

Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

Link copied to clipboard
val maintainTime: Output<String>? = null

The maintenance window of DBCluster. Valid format: hh:mmZ-hh:mm Z.

Link copied to clipboard
val paymentType: Output<String>? = null

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

Link copied to clipboard
val period: Output<String>? = null

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

Link copied to clipboard
val status: Output<String>? = null

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

Link copied to clipboard
val storageType: Output<String>? = null

Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.

Link copied to clipboard
val usedTime: Output<String>? = null

The used time of DBCluster.

Link copied to clipboard
val vpcId: Output<String>? = null

The id of the VPC.

Link copied to clipboard
val vswitchId: Output<String>? = null

The vswitch id of DBCluster.

Link copied to clipboard
val zoneId: Output<String>? = null

The zone ID of the instance.