Skip to content

DBClusterProps

Properties for defining a DBCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-clickhouse-dbcluster

Initializer 

import { DBClusterProps } from '@alicloud/ros-cdk-clickhouse'
const dBClusterProps: DBClusterProps = { ... }

Properties

Name Type Description
category string | @alicloud/ros-cdk-core.IResolvable Property category: The edition of the cluster.
dbClusterNetworkType string | @alicloud/ros-cdk-core.IResolvable Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
dbClusterType string | @alicloud/ros-cdk-core.IResolvable Property dbClusterType: The specification of the cluster.
dbClusterVersion string | @alicloud/ros-cdk-core.IResolvable Property dbClusterVersion: Version, value: 19.15.2.2.
dbNodeCount number | @alicloud/ros-cdk-core.IResolvable Property dbNodeCount: The number of nodes.
dbNodeStorage number | @alicloud/ros-cdk-core.IResolvable Property dbNodeStorage: The storage capacity of a single node.
dbNodeStorageType string | @alicloud/ros-cdk-core.IResolvable Property dbNodeStorageType: Instance node storage type.
paymentType string | @alicloud/ros-cdk-core.IResolvable Property paymentType: The billing method of the cluster.
dbClusterDescription string | @alicloud/ros-cdk-core.IResolvable Property dbClusterDescription: The description of the cluster.
encryptionKey string | @alicloud/ros-cdk-core.IResolvable Property encryptionKey: KMS key ID.
encryptionType string | @alicloud/ros-cdk-core.IResolvable Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
period string | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.
usedTime number | @alicloud/ros-cdk-core.IResolvable Property usedTime: The subscription duration.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: VpcId.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: VSwitchId.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: ZoneId.

categoryRequired 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The edition of the cluster.

Valid values: Basic: Single-replica Edition HighAvailability: Double-replica Edition

dbClusterNetworkTypeRequired 

public readonly dbClusterNetworkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.

dbClusterTypeRequired 

public readonly dbClusterType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterType: The specification of the cluster.

If the cluster is of the Single-replica Edition, the following values are valid: S4: 4 cores, 16 GB. S8: 8 cores, 32 GB. S16: 16 cores, 64 GB. S32: 32 cores, 128 GB. S64: 64 cores, 256 GB. S104: 104 cores, 384 GB. If the cluster is of the Double-replica Edition, the following values are valid: C4: 4 cores, 16 GB. C8: 8 cores, 32 GB. C16: 16 cores, 64 GB. C32: 32 cores, 128 GB. C64: 64 cores, 256 GB. C104: 104 cores, 384 GB.

dbClusterVersionRequired 

public readonly dbClusterVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterVersion: Version, value: 19.15.2.2.

dbNodeCountRequired 

public readonly dbNodeCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property dbNodeCount: The number of nodes.

If the cluster is of the Single-replica Edition, the value ranges from 1 to 48. If the cluster is of the Double-replica Edition, the value ranges from 1 to 24.

dbNodeStorageRequired 

public readonly dbNodeStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property dbNodeStorage: The storage capacity of a single node.

Valid values: 100 to 32000. Unit: GB. Note self value is a multiple of 100.

dbNodeStorageTypeRequired 

public readonly dbNodeStorageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

paymentTypeRequired 

public readonly paymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property paymentType: The billing method of the cluster.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription

dbClusterDescriptionOptional 

public readonly dbClusterDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterDescription: The description of the cluster.

encryptionKeyOptional 

public readonly encryptionKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property encryptionKey: KMS key ID.

encryptionTypeOptional 

public readonly encryptionType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.

periodOptional 

public readonly period: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.

usedTimeOptional 

public readonly usedTime: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property usedTime: The subscription duration.

Valid values: When Period is Month, it could be from 1 to 9, 12, 24, 36. When Period is Year, it could be from 1 to 3.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: VpcId.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: VSwitchId.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: ZoneId.