Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import com.aliyun.ros.cdk.clickhouse.DBClusterProps;
DBClusterProps.builder()
    .category(java.lang.String)
    .category(IResolvable)
    .dbClusterNetworkType(java.lang.String)
    .dbClusterNetworkType(IResolvable)
    .dbClusterType(java.lang.String)
    .dbClusterType(IResolvable)
    .dbClusterVersion(java.lang.String)
    .dbClusterVersion(IResolvable)
    .dbNodeCount(java.lang.Number)
    .dbNodeCount(IResolvable)
    .dbNodeStorage(java.lang.Number)
    .dbNodeStorage(IResolvable)
    .dbNodeStorageType(java.lang.String)
    .dbNodeStorageType(IResolvable)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .encryptionType(java.lang.String)
//  .encryptionType(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .usedTime(java.lang.Number)
//  .usedTime(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The edition of the cluster.
dbClusterNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
dbClusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterType: The specification of the cluster.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterVersion: Version, value: 19.15.2.2.
dbNodeCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeCount: The number of nodes.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorage: The storage capacity of a single node.
dbNodeStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorageType: Instance node storage type.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The billing method of the cluster.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterDescription: The description of the cluster.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encryptionKey: KMS key ID.
encryptionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
period java.lang.String OR com.aliyun.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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property usedTime: The subscription duration.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VpcId.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: VSwitchId.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: ZoneId.

categoryRequired 

public java.lang.Object getCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property category: The edition of the cluster.

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

dbClusterNetworkTypeRequired 

public java.lang.Object getDbClusterNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dbClusterTypeRequired 

public java.lang.Object getDbClusterType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbClusterVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterVersion: Version, value: 19.15.2.2.

dbNodeCountRequired 

public java.lang.Object getDbNodeCount();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDbNodeStorage();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDbNodeStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

paymentTypeRequired 

public java.lang.Object getPaymentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The billing method of the cluster.

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

dbClusterDescriptionOptional 

public java.lang.Object getDbClusterDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterDescription: The description of the cluster.

encryptionKeyOptional 

public java.lang.Object getEncryptionKey();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property encryptionKey: KMS key ID.

encryptionTypeOptional 

public java.lang.Object getEncryptionType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getUsedTime();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: VpcId.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: VSwitchId.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: ZoneId.