DBCluster

• Implements: IDBCluster

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_bak: typing.Union[str, IResolvable] = None,
  v_switch_bak2: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zond_id_bak2: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  zone_id_bak: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

category^Required

• 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_type^Required

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

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

db_cluster_type^Required

• 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_version^Required

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

Property dbClusterVersion: Version, value: 19.15.2.2.

db_node_count^Required

• 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_storage^Required

• 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_type^Required

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

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

payment_type^Required

• 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_description^Optional

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

Property dbClusterDescription: The description of the cluster.

encryption_key^Optional

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

Property encryptionKey: KMS key ID.

encryption_type^Optional

• 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^Optional

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

Property period: The unit of the subscription duration.

used_time^Optional

• 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_id^Optional

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

Property vpcId: VpcId.

v_switch_bak^Optional

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

Property vSwitchBak: The ID of the secondary VSwitch.

v_switch_bak2^Optional

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

Property vSwitchBak2: The ID of the third VSwitch.

v_switch_id^Optional

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

Property vSwitchId: VSwitchId.

zond_id_bak2^Optional

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

Property zondIdBak2: The ID of the third zone.

zone_id^Optional

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

Property zoneId: ZoneId.

zone_id_bak^Optional

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

Property zoneIdBak: The ID of the secondary zone.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_ali_uid^Required

attr_ali_uid: typing.Union[str, IResolvable]

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

Attribute AliUid: AliUid.

attr_bid^Required

attr_bid: typing.Union[str, IResolvable]

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

Attribute Bid: BusinessID.

attr_category^Required

attr_category: typing.Union[str, IResolvable]

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

Attribute Category: The edition of the cluster.

attr_commodity_code^Required

attr_commodity_code: typing.Union[str, IResolvable]

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

Attribute CommodityCode: Product Code.

attr_connection_string^Required

attr_connection_string: typing.Union[str, IResolvable]

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

Attribute ConnectionString: ConnectionString.

attr_db_cluster_description^Required

attr_db_cluster_description: typing.Union[str, IResolvable]

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

Attribute DBClusterDescription: The description of the cluster.

attr_db_cluster_id^Required

attr_db_cluster_id: typing.Union[str, IResolvable]

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

Attribute DBClusterId: The id of DBCluster.

attr_db_cluster_network_type^Required

attr_db_cluster_network_type: typing.Union[str, IResolvable]

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

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

attr_db_cluster_type^Required

attr_db_cluster_type: typing.Union[str, IResolvable]

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

Attribute DBClusterType: The specification of the cluster.

attr_db_cluster_version^Required

attr_db_cluster_version: typing.Union[str, IResolvable]

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

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attr_db_node_class^Required

attr_db_node_class: typing.Union[str, IResolvable]

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

Attribute DBNodeClass: DBNodeClass.

attr_db_node_count^Required

attr_db_node_count: typing.Union[str, IResolvable]

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

Attribute DBNodeCount: The number of nodes.

attr_db_node_storage^Required

attr_db_node_storage: typing.Union[str, IResolvable]

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

Attribute DBNodeStorage: The storage capacity of a single node.

attr_db_node_storage_type^Required

attr_db_node_storage_type: typing.Union[str, IResolvable]

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

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attr_encryption_key^Required

attr_encryption_key: typing.Union[str, IResolvable]

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

Attribute EncryptionKey: KMS key ID.

attr_encryption_type^Required

attr_encryption_type: typing.Union[str, IResolvable]

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

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

attr_engine^Required

attr_engine: typing.Union[str, IResolvable]

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

Attribute Engine: Engine.

attr_engine_version^Required

attr_engine_version: typing.Union[str, IResolvable]

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

Attribute EngineVersion: EngineVersion.

attr_is_expired^Required

attr_is_expired: typing.Union[str, IResolvable]

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

Attribute IsExpired: IsExpired.

attr_lock_mode^Required

attr_lock_mode: typing.Union[str, IResolvable]

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

Attribute LockMode: LockMode.

attr_lock_reason^Required

attr_lock_reason: typing.Union[str, IResolvable]

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

Attribute LockReason: Reason for lock.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: PayType.

attr_period^Required

attr_period: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: Connection port.

attr_public_connection_string^Required

attr_public_connection_string: typing.Union[str, IResolvable]

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

Attribute PublicConnectionString: Internet connection address.

attr_public_port^Required

attr_public_port: typing.Union[str, IResolvable]

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

Attribute PublicPort: PublicPort.

attr_storage_type^Required

attr_storage_type: typing.Union[str, IResolvable]

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

Attribute StorageType: StorageType.

attr_vpc_cloud_instance_id^Required

attr_vpc_cloud_instance_id: typing.Union[str, IResolvable]

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

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: VpcId.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: VSwitchId.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: ZoneId.

props^Required

props: DBClusterProps

• Type: DBClusterProps