Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::DBCluster, which is used to create an ApsaraDB for ClickHouse cluster.

Initializers 

import ros_cdk_clickhouse
ros_cdk_clickhouse.DBCluster(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

categoryRequired

  • 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

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

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

db_cluster_typeRequired

  • 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

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

Property dbClusterVersion: Version, value: 19.15.2.2.

db_node_countRequired

  • 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

  • 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

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

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

payment_typeRequired

  • 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

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

Property dbClusterDescription: The description of the cluster.

encryption_keyOptional

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

Property encryptionKey: KMS key ID.

encryption_typeOptional

  • 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

  • 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

  • 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

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

Property vpcId: VpcId.

v_switch_idOptional

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

Property vSwitchId: VSwitchId.

zone_idOptional

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

Property zoneId: ZoneId.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_clickhouse
ros_cdk_clickhouse.DBCluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_ali_uid ros_cdk_core.IResolvable Attribute AliUid: AliUid.
attr_bid ros_cdk_core.IResolvable Attribute Bid: BusinessID.
attr_category ros_cdk_core.IResolvable Attribute Category: The edition of the cluster.
attr_commodity_code ros_cdk_core.IResolvable Attribute CommodityCode: Product Code.
attr_connection_string ros_cdk_core.IResolvable Attribute ConnectionString: ConnectionString.
attr_db_cluster_description ros_cdk_core.IResolvable Attribute DBClusterDescription: The description of the cluster.
attr_db_cluster_id ros_cdk_core.IResolvable Attribute DBClusterId: The id of DBCluster.
attr_db_cluster_network_type ros_cdk_core.IResolvable Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
attr_db_cluster_type ros_cdk_core.IResolvable Attribute DBClusterType: The specification of the cluster.
attr_db_cluster_version ros_cdk_core.IResolvable Attribute DBClusterVersion: Version, value: 19.15.2.2.
attr_db_node_class ros_cdk_core.IResolvable Attribute DBNodeClass: DBNodeClass.
attr_db_node_count ros_cdk_core.IResolvable Attribute DBNodeCount: The number of nodes.
attr_db_node_storage ros_cdk_core.IResolvable Attribute DBNodeStorage: The storage capacity of a single node.
attr_db_node_storage_type ros_cdk_core.IResolvable Attribute DbNodeStorageType: Instance node storage type.
attr_encryption_key ros_cdk_core.IResolvable Attribute EncryptionKey: KMS key ID.
attr_encryption_type ros_cdk_core.IResolvable Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
attr_engine ros_cdk_core.IResolvable Attribute Engine: Engine.
attr_engine_version ros_cdk_core.IResolvable Attribute EngineVersion: EngineVersion.
attr_is_expired ros_cdk_core.IResolvable Attribute IsExpired: IsExpired.
attr_lock_mode ros_cdk_core.IResolvable Attribute LockMode: LockMode.
attr_lock_reason ros_cdk_core.IResolvable Attribute LockReason: Reason for lock.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: PayType.
attr_period ros_cdk_core.IResolvable Attribute 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.
attr_port ros_cdk_core.IResolvable Attribute Port: Connection port.
attr_public_connection_string ros_cdk_core.IResolvable Attribute PublicConnectionString: Internet connection address.
attr_public_port ros_cdk_core.IResolvable Attribute PublicPort: PublicPort.
attr_storage_type ros_cdk_core.IResolvable Attribute StorageType: StorageType.
attr_vpc_cloud_instance_id ros_cdk_core.IResolvable Attribute VpcCloudInstanceId: VpcCloudInstanceId.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: VpcId.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: VSwitchId.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: ZoneId.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_ali_uidRequired 

attr_ali_uid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AliUid: AliUid.

attr_bidRequired 

attr_bid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bid: BusinessID.

attr_categoryRequired 

attr_category: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Category: The edition of the cluster.

attr_commodity_codeRequired 

attr_commodity_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CommodityCode: Product Code.

attr_connection_stringRequired 

attr_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionString: ConnectionString.

attr_db_cluster_descriptionRequired 

attr_db_cluster_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterDescription: The description of the cluster.

attr_db_cluster_idRequired 

attr_db_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterId: The id of DBCluster.

attr_db_cluster_network_typeRequired 

attr_db_cluster_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.

attr_db_cluster_typeRequired 

attr_db_cluster_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterType: The specification of the cluster.

attr_db_cluster_versionRequired 

attr_db_cluster_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attr_db_node_classRequired 

attr_db_node_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBNodeClass: DBNodeClass.

attr_db_node_countRequired 

attr_db_node_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBNodeCount: The number of nodes.

attr_db_node_storageRequired 

attr_db_node_storage: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBNodeStorage: The storage capacity of a single node.

attr_db_node_storage_typeRequired 

attr_db_node_storage_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attr_encryption_keyRequired 

attr_encryption_key: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EncryptionKey: KMS key ID.

attr_encryption_typeRequired 

attr_encryption_type: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_engineRequired 

attr_engine: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Engine: Engine.

attr_engine_versionRequired 

attr_engine_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineVersion: EngineVersion.

attr_is_expiredRequired 

attr_is_expired: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsExpired: IsExpired.

attr_lock_modeRequired 

attr_lock_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockMode: LockMode.

attr_lock_reasonRequired 

attr_lock_reason: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockReason: Reason for lock.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: PayType.

attr_periodRequired 

attr_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute 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.

attr_portRequired 

attr_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Port: Connection port.

attr_public_connection_stringRequired 

attr_public_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicConnectionString: Internet connection address.

attr_public_portRequired 

attr_public_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicPort: PublicPort.

attr_storage_typeRequired 

attr_storage_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageType: StorageType.

attr_vpc_cloud_instance_idRequired 

attr_vpc_cloud_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: VpcId.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: VSwitchId.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: ZoneId.