Skip to content

DBCluster

This class encapsulates and extends the ROS resource type DATASOURCE::ClickHouse::DBCluster, which is used to query the information about an ApsaraDB for ClickHouse cluster.

Initializers 

from ros_cdk_clickhouse import datasource
datasource.DBCluster(
  scope: Construct,
  id: str,
  db_cluster_id: typing.Union[str, IResolvable],
  refresh_options: 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.
db_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterId: Instance ID.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

db_cluster_idRequired

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

Property dbClusterId: Instance ID.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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 

from ros_cdk_clickhouse import datasource
datasource.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: Alibaba Cloud account.
attr_bid ros_cdk_core.IResolvable Attribute Bid: The ID of the business process flow.
attr_category ros_cdk_core.IResolvable Attribute Category: Copy configuration, value description:.
attr_commodity_code ros_cdk_core.IResolvable Attribute CommodityCode: Buy Product Code.
attr_connection_string ros_cdk_core.IResolvable Attribute ConnectionString: Connection string.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the resource.
attr_db_cluster_id ros_cdk_core.IResolvable Attribute DBClusterId: Instance ID.
attr_db_cluster_ip_array_name ros_cdk_core.IResolvable Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
attr_db_cluster_name ros_cdk_core.IResolvable Attribute DBClusterName: The cluster description information.
attr_db_cluster_network_type ros_cdk_core.IResolvable Attribute DbClusterNetworkType: Network type.
attr_db_cluster_type ros_cdk_core.IResolvable Attribute DBClusterType: Instance type.
attr_db_node_class ros_cdk_core.IResolvable Attribute DbNodeClass: Set the node type.
attr_db_node_count ros_cdk_core.IResolvable Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
attr_db_node_storage ros_cdk_core.IResolvable Attribute DbNodeStorage: Single-node storage space.
attr_encryption_key ros_cdk_core.IResolvable Attribute EncryptionKey: Key management service KMS key ID.
attr_encryption_type ros_cdk_core.IResolvable Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
attr_engine ros_cdk_core.IResolvable Attribute Engine: Engine.
attr_engine_version ros_cdk_core.IResolvable Attribute EngineVersion: The engine version.
attr_expire_time ros_cdk_core.IResolvable Attribute ExpireTime: The expiration time.
attr_is_expired ros_cdk_core.IResolvable Attribute IsExpired: If the instance has expired.
attr_lock_mode ros_cdk_core.IResolvable Attribute LockMode: The lock mode.
attr_lock_reason ros_cdk_core.IResolvable Attribute LockReason: Lock reason.
attr_maintain_time ros_cdk_core.IResolvable Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The paymen type of the resource.
attr_port ros_cdk_core.IResolvable Attribute Port: Connection port.
attr_public_connection_string ros_cdk_core.IResolvable Attribute PublicConnectionString: A public IP address for the connection.
attr_public_ip_addr ros_cdk_core.IResolvable Attribute PublicIpAddr: Public IP address.
attr_public_port ros_cdk_core.IResolvable Attribute PublicPort: Public network port.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_scale_out_status ros_cdk_core.IResolvable Attribute ScaleOutStatus: Scale state.
attr_security_ips ros_cdk_core.IResolvable Attribute SecurityIps: The whitelist supports the following two formats:.
attr_storage_type ros_cdk_core.IResolvable Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
attr_support_backup ros_cdk_core.IResolvable Attribute SupportBackup: Support fallback scheme.
attr_support_https_port ros_cdk_core.IResolvable Attribute SupportHttpsPort: The system supports http port number.
attr_support_mysql_port ros_cdk_core.IResolvable Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
attr_support_oss ros_cdk_core.IResolvable Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
attr_vpc_cloud_instance_id ros_cdk_core.IResolvable Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: VPC ID.
attr_vpc_ip_addr ros_cdk_core.IResolvable Attribute VpcIpAddr: VPC IP address.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: Switch ID.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: On behalf of the zone resource attribute field.

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: Alibaba Cloud account.

attr_bidRequired 

attr_bid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bid: The ID of the business process flow.

attr_categoryRequired 

attr_category: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Category: Copy configuration, value description:.

attr_commodity_codeRequired 

attr_commodity_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CommodityCode: Buy Product Code.

attr_connection_stringRequired 

attr_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionString: Connection string.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the resource.

attr_db_cluster_idRequired 

attr_db_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterId: Instance ID.

attr_db_cluster_ip_array_nameRequired 

attr_db_cluster_ip_array_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.

attr_db_cluster_nameRequired 

attr_db_cluster_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterName: The cluster description information.

attr_db_cluster_network_typeRequired 

attr_db_cluster_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbClusterNetworkType: Network type.

Currently, only VPC is supported.

attr_db_cluster_typeRequired 

attr_db_cluster_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBClusterType: Instance type.

attr_db_node_classRequired 

attr_db_node_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeClass: Set the node type.

attr_db_node_countRequired 

attr_db_node_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.

attr_db_node_storageRequired 

attr_db_node_storage: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeStorage: Single-node storage space.

Value range: 100 GB to 32000GB.

attr_encryption_keyRequired 

attr_encryption_key: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EncryptionKey: Key management service KMS key ID.

attr_encryption_typeRequired 

attr_encryption_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

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: The engine version.

attr_expire_timeRequired 

attr_expire_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpireTime: The expiration time.

attr_is_expiredRequired 

attr_is_expired: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsExpired: If the instance has expired.

attr_lock_modeRequired 

attr_lock_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockMode: The lock mode.

attr_lock_reasonRequired 

attr_lock_reason: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockReason: Lock reason.

attr_maintain_timeRequired 

attr_maintain_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The paymen type of the resource.

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: A public IP address for the connection.

attr_public_ip_addrRequired 

attr_public_ip_addr: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicIpAddr: Public IP address.

attr_public_portRequired 

attr_public_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicPort: Public network port.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_scale_out_statusRequired 

attr_scale_out_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ScaleOutStatus: Scale state.

attr_security_ipsRequired 

attr_security_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIps: The whitelist supports the following two formats:.

attr_storage_typeRequired 

attr_storage_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.

attr_support_backupRequired 

attr_support_backup: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupportBackup: Support fallback scheme.

attr_support_https_portRequired 

attr_support_https_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupportHttpsPort: The system supports http port number.

attr_support_mysql_portRequired 

attr_support_mysql_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupportMysqlPort: Supports Mysql, and those of the ports.

attr_support_ossRequired 

attr_support_oss: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.

attr_vpc_cloud_instance_idRequired 

attr_vpc_cloud_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: VPC ID.

attr_vpc_ip_addrRequired 

attr_vpc_ip_addr: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcIpAddr: VPC IP address.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: Switch ID.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: On behalf of the zone resource attribute field.