Skip to content

IEnterpriseDBCluster

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_clickhouse.datasource.EnterpriseDBCluster, ros_cdk_clickhouse.datasource.IEnterpriseDBCluster

Represents a EnterpriseDBCluster.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_category typing.Union[str, ros_cdk_core.IResolvable] Attribute Category: Type, value description: enterprise: Enterprise Edition.
attr_charge_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ChargeType: The billing method.
attr_computing_group_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute ComputingGroupIds: The list of computing group IDs.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: The creation time of the cluster.
attr_db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Attribute DBInstanceId: The cluster ID.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The cluster description.
attr_disabled_ports typing.Union[str, ros_cdk_core.IResolvable] Attribute DisabledPorts: The specified database port is disabled.
attr_endpoints typing.Union[str, ros_cdk_core.IResolvable] Attribute Endpoints: List of Endpoint details.
attr_engine typing.Union[str, ros_cdk_core.IResolvable] Attribute Engine: The engine type.
attr_engine_minor_version typing.Union[str, ros_cdk_core.IResolvable] Attribute EngineMinorVersion: The minor version number of the cluster engine.
attr_engine_version typing.Union[str, ros_cdk_core.IResolvable] Attribute EngineVersion: The engine version.
attr_instance_network_type typing.Union[str, ros_cdk_core.IResolvable] Attribute InstanceNetworkType: The network type of the instance.
attr_maintain_end_time typing.Union[str, ros_cdk_core.IResolvable] Attribute MaintainEndTime: The end time of the maintenance window.
attr_maintain_start_time typing.Union[str, ros_cdk_core.IResolvable] Attribute MaintainStartTime: The maintainable time start time.
attr_multi_zones typing.Union[str, ros_cdk_core.IResolvable] Attribute MultiZones: The information about the zones.
attr_node_count typing.Union[str, ros_cdk_core.IResolvable] Attribute NodeCount: The number of nodes.
attr_nodes typing.Union[str, ros_cdk_core.IResolvable] Attribute Nodes: The Node information.
attr_node_scale_max typing.Union[str, ros_cdk_core.IResolvable] Attribute NodeScaleMax: The maximum value of serverless node auto scaling.
attr_node_scale_min typing.Union[str, ros_cdk_core.IResolvable] Attribute NodeScaleMin: Minimum number of Serverless nodes for auto-scaling.
attr_object_store_size typing.Union[str, ros_cdk_core.IResolvable] Attribute ObjectStoreSize: The size of the object storage space.
attr_resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceGroupId: The ID of the resource group.
attr_scale_max typing.Union[str, ros_cdk_core.IResolvable] Attribute ScaleMax: The maximum capacity for elastic scaling.
attr_scale_min typing.Union[str, ros_cdk_core.IResolvable] Attribute ScaleMin: The minimum capacity for elastic scaling.
attr_storage_quota typing.Union[str, ros_cdk_core.IResolvable] Attribute StorageQuota: Storage Pre-purchased Capacity (GB).
attr_storage_size typing.Union[str, ros_cdk_core.IResolvable] Attribute StorageSize: The size of the storage space.
attr_storage_type typing.Union[str, ros_cdk_core.IResolvable] Attribute StorageType: The storage type.
attr_tags typing.Union[str, ros_cdk_core.IResolvable] Attribute Tags: The details of the tags.
attr_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VpcId: The VPC ID.
attr_vswitch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VswitchId: The VSwitch ID.
attr_zone_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ZoneId: The zone ID.
props EnterpriseDBClusterProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_categoryRequired

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

Attribute Category: Type, value description: enterprise: Enterprise Edition.


attr_charge_typeRequired

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

Attribute ChargeType: The billing method.

Enterprise Edition clusters use the pay-as-you-go billing method.


attr_computing_group_idsRequired

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

Attribute ComputingGroupIds: The list of computing group IDs.


attr_create_timeRequired

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

Attribute CreateTime: The creation time of the cluster.


attr_db_instance_idRequired

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

Attribute DBInstanceId: The cluster ID.


attr_descriptionRequired

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

Attribute Description: The cluster description.


attr_disabled_portsRequired

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

Attribute DisabledPorts: The specified database port is disabled.

Multiple ports separated by commas (,) are supported.


attr_endpointsRequired

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

Attribute Endpoints: List of Endpoint details.


attr_engineRequired

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

Attribute Engine: The engine type.


attr_engine_minor_versionRequired

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

Attribute EngineMinorVersion: The minor version number of the cluster engine.


attr_engine_versionRequired

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

Attribute EngineVersion: The engine version.


attr_instance_network_typeRequired

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

Attribute InstanceNetworkType: The network type of the instance.


attr_maintain_end_timeRequired

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

Attribute MaintainEndTime: The end time of the maintenance window.


attr_maintain_start_timeRequired

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

Attribute MaintainStartTime: The maintainable time start time.


attr_multi_zonesRequired

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

Attribute MultiZones: The information about the zones.


attr_node_countRequired

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

Attribute NodeCount: The number of nodes.

The value range is 2-16. Required when you use NodeScaleMin and NodeScaleMax to configure an elastic interval.


attr_nodesRequired

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

Attribute Nodes: The Node information.


attr_node_scale_maxRequired

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

Attribute NodeScaleMax: The maximum value of serverless node auto scaling.


attr_node_scale_minRequired

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

Attribute NodeScaleMin: Minimum number of Serverless nodes for auto-scaling.


attr_object_store_sizeRequired

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

Attribute ObjectStoreSize: The size of the object storage space.


attr_resource_group_idRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attr_scale_maxRequired

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

Attribute ScaleMax: The maximum capacity for elastic scaling.


attr_scale_minRequired

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

Attribute ScaleMin: The minimum capacity for elastic scaling.


attr_storage_quotaRequired

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

Attribute StorageQuota: Storage Pre-purchased Capacity (GB).


attr_storage_sizeRequired

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

Attribute StorageSize: The size of the storage space.

Unit: GB.


attr_storage_typeRequired

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

Attribute StorageType: The storage type.


attr_tagsRequired

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

Attribute Tags: The details of the tags.


attr_vpc_idRequired

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

Attribute VpcId: The VPC ID.


attr_vswitch_idRequired

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

Attribute VswitchId: The VSwitch ID.


attr_zone_idRequired

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

Attribute ZoneId: The zone ID.


propsRequired

props: EnterpriseDBClusterProps