Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import ros_cdk_clickhouse
ros_cdk_clickhouse.DBClusterProps(
  category: typing.Union[str, IResolvable],
  db_cluster_network_type: typing.Union[str, IResolvable],
  db_cluster_type: typing.Union[str, IResolvable],
  db_cluster_version: typing.Union[str, IResolvable],
  db_node_count: typing.Union[typing.Union[int, float], IResolvable],
  db_node_storage: typing.Union[typing.Union[int, float], IResolvable],
  db_node_storage_type: typing.Union[str, IResolvable],
  payment_type: typing.Union[str, IResolvable],
  db_cluster_description: typing.Union[str, IResolvable] = None,
  encryption_key: typing.Union[str, IResolvable] = None,
  encryption_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  used_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
category typing.Union[str, ros_cdk_core.IResolvable] Property category: The edition of the cluster.
db_cluster_network_type typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
db_cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterType: The specification of the cluster.
db_cluster_version typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterVersion: Version, value: 19.15.2.2.
db_node_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dbNodeCount: The number of nodes.
db_node_storage typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dbNodeStorage: The storage capacity of a single node.
db_node_storage_type typing.Union[str, ros_cdk_core.IResolvable] Property dbNodeStorageType: Instance node storage type.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: The billing method of the cluster.
db_cluster_description typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterDescription: The description of the cluster.
encryption_key typing.Union[str, ros_cdk_core.IResolvable] Property encryptionKey: KMS key ID.
encryption_type typing.Union[str, ros_cdk_core.IResolvable] Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
period typing.Union[str, 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.
used_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property usedTime: The subscription duration.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: VpcId.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: VSwitchId.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: ZoneId.

categoryRequired 

category: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property category: The edition of the cluster.

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

db_cluster_network_typeRequired 

db_cluster_network_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

db_cluster_typeRequired 

db_cluster_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

db_cluster_versionRequired 

db_cluster_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbClusterVersion: Version, value: 19.15.2.2.

db_node_countRequired 

db_node_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

db_node_storageRequired 

db_node_storage: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

db_node_storage_typeRequired 

db_node_storage_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

payment_typeRequired 

payment_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property paymentType: The billing method of the cluster.

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

db_cluster_descriptionOptional 

db_cluster_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbClusterDescription: The description of the cluster.

encryption_keyOptional 

encryption_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property encryptionKey: KMS key ID.

encryption_typeOptional 

encryption_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

periodOptional 

period: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

used_timeOptional 

used_time: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

vpc_idOptional 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: VpcId.

v_switch_idOptional 

v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: VSwitchId.

zone_idOptional 

zone_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: ZoneId.