com.aliyun.ros.cdk.clickhouse

Class DBCluster.Builder

java.lang.Object

com.aliyun.ros.cdk.clickhouse.DBCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DBCluster>

Enclosing class:

DBCluster

public static final class DBCluster.Builder
extends Object
implements software.amazon.jsii.Builder<DBCluster>

A fluent builder for DBCluster.

Method Summary

Modifier and Type	Method and Description
DBCluster	build()
DBCluster.Builder	category(com.aliyun.ros.cdk.core.IResolvable category) Property category: The edition of the cluster.
DBCluster.Builder	category(String category) Property category: The edition of the cluster.
static DBCluster.Builder	create(com.aliyun.ros.cdk.core.Construct scope, String id)
static DBCluster.Builder	create(com.aliyun.ros.cdk.core.Construct scope, String id, Boolean enableResourcePropertyConstraint)
DBCluster.Builder	dbClusterDescription(com.aliyun.ros.cdk.core.IResolvable dbClusterDescription) Property dbClusterDescription: The description of the cluster.
DBCluster.Builder	dbClusterDescription(String dbClusterDescription) Property dbClusterDescription: The description of the cluster.
DBCluster.Builder	dbClusterNetworkType(com.aliyun.ros.cdk.core.IResolvable dbClusterNetworkType) Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
DBCluster.Builder	dbClusterNetworkType(String dbClusterNetworkType) Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
DBCluster.Builder	dbClusterType(com.aliyun.ros.cdk.core.IResolvable dbClusterType) Property dbClusterType: The specification of the cluster.
DBCluster.Builder	dbClusterType(String dbClusterType) Property dbClusterType: The specification of the cluster.
DBCluster.Builder	dbClusterVersion(com.aliyun.ros.cdk.core.IResolvable dbClusterVersion) Property dbClusterVersion: Version, value: 19.15.2.2.
DBCluster.Builder	dbClusterVersion(String dbClusterVersion) Property dbClusterVersion: Version, value: 19.15.2.2.
DBCluster.Builder	dbNodeCount(com.aliyun.ros.cdk.core.IResolvable dbNodeCount) Property dbNodeCount: The number of nodes.
DBCluster.Builder	dbNodeCount(Number dbNodeCount) Property dbNodeCount: The number of nodes.
DBCluster.Builder	dbNodeStorage(com.aliyun.ros.cdk.core.IResolvable dbNodeStorage) Property dbNodeStorage: The storage capacity of a single node.
DBCluster.Builder	dbNodeStorage(Number dbNodeStorage) Property dbNodeStorage: The storage capacity of a single node.
DBCluster.Builder	dbNodeStorageType(com.aliyun.ros.cdk.core.IResolvable dbNodeStorageType) Property dbNodeStorageType: Instance node storage type.
DBCluster.Builder	dbNodeStorageType(String dbNodeStorageType) Property dbNodeStorageType: Instance node storage type.
DBCluster.Builder	encryptionKey(com.aliyun.ros.cdk.core.IResolvable encryptionKey) Property encryptionKey: KMS key ID.
DBCluster.Builder	encryptionKey(String encryptionKey) Property encryptionKey: KMS key ID.
DBCluster.Builder	encryptionType(com.aliyun.ros.cdk.core.IResolvable encryptionType) Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
DBCluster.Builder	encryptionType(String encryptionType) Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
DBCluster.Builder	paymentType(com.aliyun.ros.cdk.core.IResolvable paymentType) Property paymentType: The billing method of the cluster.
DBCluster.Builder	paymentType(String paymentType) Property paymentType: The billing method of the cluster.
DBCluster.Builder	period(com.aliyun.ros.cdk.core.IResolvable period) Property period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory.
DBCluster.Builder	period(String period) Property period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory.
DBCluster.Builder	usedTime(com.aliyun.ros.cdk.core.IResolvable usedTime) Property usedTime: The subscription duration.
DBCluster.Builder	usedTime(Number usedTime) Property usedTime: The subscription duration.
DBCluster.Builder	vpcId(com.aliyun.ros.cdk.core.IResolvable vpcId) Property vpcId: VpcId.
DBCluster.Builder	vpcId(String vpcId) Property vpcId: VpcId.
DBCluster.Builder	vSwitchId(com.aliyun.ros.cdk.core.IResolvable vSwitchId) Property vSwitchId: VSwitchId.
DBCluster.Builder	vSwitchId(String vSwitchId) Property vSwitchId: VSwitchId.
DBCluster.Builder	zoneId(com.aliyun.ros.cdk.core.IResolvable zoneId) Property zoneId: ZoneId.
DBCluster.Builder	zoneId(String zoneId) Property zoneId: ZoneId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DBCluster.Builder create(com.aliyun.ros.cdk.core.Construct scope,
                                       String id,
                                       Boolean enableResourcePropertyConstraint)

Parameters:

scope - This parameter is required.

id - This parameter is required.

enableResourcePropertyConstraint -

Returns:

a new instance of DBCluster.Builder.

create

public static DBCluster.Builder create(com.aliyun.ros.cdk.core.Construct scope,
                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DBCluster.Builder.

category

public DBCluster.Builder category(String category)

Property category: The edition of the cluster.

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

Parameters:

category - Property category: The edition of the cluster. This parameter is required.

Returns:

this

category

public DBCluster.Builder category(com.aliyun.ros.cdk.core.IResolvable category)

Property category: The edition of the cluster.

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

Parameters:

category - Property category: The edition of the cluster. This parameter is required.

Returns:

this

dbClusterNetworkType

public DBCluster.Builder dbClusterNetworkType(String dbClusterNetworkType)

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

Parameters:

dbClusterNetworkType - Property dbClusterNetworkType: Network type of the cluster instance, value: VPC. This parameter is required.

Returns:

this

dbClusterNetworkType

public DBCluster.Builder dbClusterNetworkType(com.aliyun.ros.cdk.core.IResolvable dbClusterNetworkType)

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

Parameters:

dbClusterNetworkType - Property dbClusterNetworkType: Network type of the cluster instance, value: VPC. This parameter is required.

Returns:

this

dbClusterType

public DBCluster.Builder dbClusterType(String dbClusterType)

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.

Parameters:

dbClusterType - Property dbClusterType: The specification of the cluster. This parameter is required.

Returns:

this

dbClusterType

public DBCluster.Builder dbClusterType(com.aliyun.ros.cdk.core.IResolvable dbClusterType)

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.

Parameters:

dbClusterType - Property dbClusterType: The specification of the cluster. This parameter is required.

Returns:

this

dbClusterVersion

public DBCluster.Builder dbClusterVersion(String dbClusterVersion)

Property dbClusterVersion: Version, value: 19.15.2.2.

Parameters:

dbClusterVersion - Property dbClusterVersion: Version, value: 19.15.2.2. This parameter is required.

Returns:

this

dbClusterVersion

public DBCluster.Builder dbClusterVersion(com.aliyun.ros.cdk.core.IResolvable dbClusterVersion)

Property dbClusterVersion: Version, value: 19.15.2.2.

Parameters:

dbClusterVersion - Property dbClusterVersion: Version, value: 19.15.2.2. This parameter is required.

Returns:

this

dbNodeCount

public DBCluster.Builder dbNodeCount(Number dbNodeCount)

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.

Parameters:

dbNodeCount - Property dbNodeCount: The number of nodes. This parameter is required.

Returns:

this

dbNodeCount

public DBCluster.Builder dbNodeCount(com.aliyun.ros.cdk.core.IResolvable dbNodeCount)

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.

Parameters:

dbNodeCount - Property dbNodeCount: The number of nodes. This parameter is required.

Returns:

this

dbNodeStorage

public DBCluster.Builder dbNodeStorage(Number dbNodeStorage)

Property dbNodeStorage: The storage capacity of a single node.

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

Parameters:

dbNodeStorage - Property dbNodeStorage: The storage capacity of a single node. This parameter is required.

Returns:

this

dbNodeStorage

public DBCluster.Builder dbNodeStorage(com.aliyun.ros.cdk.core.IResolvable dbNodeStorage)

Property dbNodeStorage: The storage capacity of a single node.

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

Parameters:

dbNodeStorage - Property dbNodeStorage: The storage capacity of a single node. This parameter is required.

Returns:

this

dbNodeStorageType

public DBCluster.Builder dbNodeStorageType(String dbNodeStorageType)

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

Parameters:

dbNodeStorageType - Property dbNodeStorageType: Instance node storage type. This parameter is required.

Returns:

this

dbNodeStorageType

public DBCluster.Builder dbNodeStorageType(com.aliyun.ros.cdk.core.IResolvable dbNodeStorageType)

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

Parameters:

dbNodeStorageType - Property dbNodeStorageType: Instance node storage type. This parameter is required.

Returns:

this

paymentType

public DBCluster.Builder paymentType(String paymentType)

Property paymentType: The billing method of the cluster.

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

Parameters:

paymentType - Property paymentType: The billing method of the cluster. This parameter is required.

Returns:

this

paymentType

public DBCluster.Builder paymentType(com.aliyun.ros.cdk.core.IResolvable paymentType)

Property paymentType: The billing method of the cluster.

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

Parameters:

paymentType - Property paymentType: The billing method of the cluster. This parameter is required.

Returns:

this

dbClusterDescription

public DBCluster.Builder dbClusterDescription(String dbClusterDescription)

Property dbClusterDescription: The description of the cluster.

Parameters:

dbClusterDescription - Property dbClusterDescription: The description of the cluster. This parameter is required.

Returns:

this

dbClusterDescription

public DBCluster.Builder dbClusterDescription(com.aliyun.ros.cdk.core.IResolvable dbClusterDescription)

Property dbClusterDescription: The description of the cluster.

Parameters:

dbClusterDescription - Property dbClusterDescription: The description of the cluster. This parameter is required.

Returns:

this

encryptionKey

public DBCluster.Builder encryptionKey(String encryptionKey)

Property encryptionKey: KMS key ID.

Parameters:

encryptionKey - Property encryptionKey: KMS key ID. This parameter is required.

Returns:

this

encryptionKey

public DBCluster.Builder encryptionKey(com.aliyun.ros.cdk.core.IResolvable encryptionKey)

Property encryptionKey: KMS key ID.

Parameters:

encryptionKey - Property encryptionKey: KMS key ID. This parameter is required.

Returns:

this

encryptionType

public DBCluster.Builder encryptionType(String encryptionType)

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

Parameters:

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

Returns:

this

encryptionType

public DBCluster.Builder encryptionType(com.aliyun.ros.cdk.core.IResolvable encryptionType)

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

Parameters:

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

Returns:

this

period

public DBCluster.Builder period(String period)

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.

Parameters:

period - 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. This parameter is required.

Returns:

this

period

public DBCluster.Builder period(com.aliyun.ros.cdk.core.IResolvable period)

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.

Parameters:

period - 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. This parameter is required.

Returns:

this

usedTime

public DBCluster.Builder usedTime(Number usedTime)

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.

Parameters:

usedTime - Property usedTime: The subscription duration. This parameter is required.

Returns:

this

usedTime

public DBCluster.Builder usedTime(com.aliyun.ros.cdk.core.IResolvable usedTime)

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.

Parameters:

usedTime - Property usedTime: The subscription duration. This parameter is required.

Returns:

this

vpcId

public DBCluster.Builder vpcId(String vpcId)

Property vpcId: VpcId.

Parameters:

vpcId - Property vpcId: VpcId. This parameter is required.

Returns:

this

vpcId

public DBCluster.Builder vpcId(com.aliyun.ros.cdk.core.IResolvable vpcId)

Property vpcId: VpcId.

Parameters:

vpcId - Property vpcId: VpcId. This parameter is required.

Returns:

this

vSwitchId

public DBCluster.Builder vSwitchId(String vSwitchId)

Property vSwitchId: VSwitchId.

Parameters:

vSwitchId - Property vSwitchId: VSwitchId. This parameter is required.

Returns:

this

vSwitchId

public DBCluster.Builder vSwitchId(com.aliyun.ros.cdk.core.IResolvable vSwitchId)

Property vSwitchId: VSwitchId.

Parameters:

vSwitchId - Property vSwitchId: VSwitchId. This parameter is required.

Returns:

this

zoneId

public DBCluster.Builder zoneId(String zoneId)

Property zoneId: ZoneId.

Parameters:

zoneId - Property zoneId: ZoneId. This parameter is required.

Returns:

this

zoneId

public DBCluster.Builder zoneId(com.aliyun.ros.cdk.core.IResolvable zoneId)

Property zoneId: ZoneId.

Parameters:

zoneId - Property zoneId: ZoneId. This parameter is required.

Returns:

this

build

public DBCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<DBCluster>

Returns:

a newly built instance of DBCluster.