Skip to content

EnterpriseDBClusterProps

Properties for defining a EnterpriseDBCluster.

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

Initializer

import ros_cdk_clickhouse
ros_cdk_clickhouse.EnterpriseDBClusterProps(
  engine: typing.Union[str, IResolvable],
  node_count: typing.Union[typing.Union[int, float], IResolvable],
  node_scale_max: typing.Union[typing.Union[int, float], IResolvable],
  node_scale_min: typing.Union[typing.Union[int, float], IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  backup_set_id: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  db_time_zone: typing.Union[str, IResolvable] = None,
  deploy_schema: typing.Union[str, IResolvable] = None,
  multi_zone: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MultiZoneProperty]]] = None,
  public_connection_setting: typing.Union[IResolvable, PublicConnectionSettingProperty] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  source_db_instance_id: typing.Union[str, IResolvable] = None,
  storage_quota: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
engine typing.Union[str, ros_cdk_core.IResolvable] Property engine: The engine type.
node_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property nodeCount: The number of nodes.
node_scale_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property nodeScaleMax: The maximum number of nodes for scaling.
node_scale_min typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property nodeScaleMin: The minimum number of nodes for scaling.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone.
backup_set_id typing.Union[str, ros_cdk_core.IResolvable] Property backupSetId: The ID of the backup set.
db_instance_description typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceDescription: The description of the database instance.
db_time_zone typing.Union[str, ros_cdk_core.IResolvable] Property dbTimeZone: The time zone of the database, which must be an IANA time zone identifier.
deploy_schema typing.Union[str, ros_cdk_core.IResolvable] Property deploySchema: The deployment schema.
multi_zone typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MultiZoneProperty]]] Property multiZone: Multi-zone configuration.
public_connection_setting typing.Union[ros_cdk_core.IResolvable, PublicConnectionSettingProperty] Property publicConnectionSetting: The public connection setting.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
source_db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceDbInstanceId: The ID of the source instance.
storage_quota typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageQuota: The storage quota.
storage_type typing.Union[str, ros_cdk_core.IResolvable] Property storageType: The type of storage.
tags typing.List[TagsProperty] Property tags: Tags to attach to clickhouse_enterprise_db.

engineRequired

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

Property engine: The engine type.


node_countRequired

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

Property nodeCount: The number of nodes.

Valid values: 2 to 16. This parameter is required when you configure an elastic scaling range by using the NodeScaleMin and NodeScaleMax parameters.


node_scale_maxRequired

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

Property nodeScaleMax: The maximum number of nodes for scaling.


node_scale_minRequired

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

Property nodeScaleMin: The minimum number of nodes for scaling.


vpc_idRequired

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

Property vpcId: The ID of the VPC.


v_switch_idRequired

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

Property vSwitchId: The ID of the VSwitch.


zone_idRequired

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

Property zoneId: The ID of the zone.


backup_set_idOptional

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

Property backupSetId: The ID of the backup set.


db_instance_descriptionOptional

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

Property dbInstanceDescription: The description of the database instance.


db_time_zoneOptional

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

Property dbTimeZone: The time zone of the database, which must be an IANA time zone identifier.


deploy_schemaOptional

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

Property deploySchema: The deployment schema.


multi_zoneOptional

multi_zone: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MultiZoneProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MultiZoneProperty]]]

Property multiZone: Multi-zone configuration.


public_connection_settingOptional

public_connection_setting: typing.Union[IResolvable, PublicConnectionSettingProperty]

Property publicConnectionSetting: The public connection setting.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.


source_db_instance_idOptional

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

Property sourceDbInstanceId: The ID of the source instance.

This parameter is required when restoring from a backup.


storage_quotaOptional

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

Property storageQuota: The storage quota.


storage_typeOptional

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

Property storageType: The type of storage.


tagsOptional

tags: typing.List[TagsProperty]

Property tags: Tags to attach to clickhouse_enterprise_db.

Max support 20 tags to add during create clickhouse_enterprise_db. Each tag with two properties Key and Value, and Key is required.