com.aliyun.ros.cdk.clickhouse

Interface DBClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DBClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.85.0 (build 08ee592)",
           date="2023-12-26T06:30:14.253Z")
public interface DBClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a DBCluster.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DBClusterProps.Builder A builder for DBClusterProps
static class	DBClusterProps.Jsii$Proxy An implementation for DBClusterProps

Method Summary

Modifier and Type	Method and Description
static DBClusterProps.Builder	builder()
Object	getCategory() Property category: The edition of the cluster.
default Object	getDbClusterDescription() Property dbClusterDescription: The description of the cluster.
Object	getDbClusterNetworkType() Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
Object	getDbClusterType() Property dbClusterType: The specification of the cluster.
Object	getDbClusterVersion() Property dbClusterVersion: Version, value: 19.15.2.2.
Object	getDbNodeCount() Property dbNodeCount: The number of nodes.
Object	getDbNodeStorage() Property dbNodeStorage: The storage capacity of a single node.
Object	getDbNodeStorageType() Property dbNodeStorageType: Instance node storage type.
default Object	getEncryptionKey() Property encryptionKey: KMS key ID.
default Object	getEncryptionType() Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
Object	getPaymentType() Property paymentType: The billing method of the cluster.
default Object	getPeriod() Property period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory.
default Object	getUsedTime() Property usedTime: The subscription duration.
default Object	getVpcId() Property vpcId: VpcId.
default Object	getVSwitchId() Property vSwitchId: VSwitchId.
default Object	getZoneId() Property zoneId: ZoneId.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCategory

@NotNull
Object getCategory()

Property category: The edition of the cluster.

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

getDbClusterNetworkType

@NotNull
Object getDbClusterNetworkType()

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

getDbClusterType

@NotNull
Object getDbClusterType()

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.

getDbClusterVersion

@NotNull
Object getDbClusterVersion()

Property dbClusterVersion: Version, value: 19.15.2.2.

getDbNodeCount

@NotNull
Object getDbNodeCount()

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.

getDbNodeStorage

@NotNull
Object getDbNodeStorage()

Property dbNodeStorage: The storage capacity of a single node.

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

getDbNodeStorageType

@NotNull
Object getDbNodeStorageType()

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

getPaymentType

@NotNull
Object getPaymentType()

Property paymentType: The billing method of the cluster.

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

getDbClusterDescription

@Nullable
default Object getDbClusterDescription()

Property dbClusterDescription: The description of the cluster.

getEncryptionKey

@Nullable
default Object getEncryptionKey()

Property encryptionKey: KMS key ID.

getEncryptionType

@Nullable
default Object getEncryptionType()

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

getPeriod

@Nullable
default Object getPeriod()

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.

getUsedTime

@Nullable
default Object getUsedTime()

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.

getVpcId

@Nullable
default Object getVpcId()

Property vpcId: VpcId.

getVSwitchId

@Nullable
default Object getVSwitchId()

Property vSwitchId: VSwitchId.

getZoneId

@Nullable
default Object getZoneId()

Property zoneId: ZoneId.

builder

static DBClusterProps.Builder builder()

Returns:

a DBClusterProps.Builder of DBClusterProps