Skip to content

EnterpriseDBClusterProps

Properties for defining a EnterpriseDBCluster.

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

Initializer

import { EnterpriseDBClusterProps } from '@alicloud/ros-cdk-clickhouse'
const enterpriseDBClusterProps: EnterpriseDBClusterProps = { ... }

Properties

Name Type Description
engine string | @alicloud/ros-cdk-core.IResolvable Property engine: The engine type.
nodeCount number | @alicloud/ros-cdk-core.IResolvable Property nodeCount: The number of nodes.
nodeScaleMax number | @alicloud/ros-cdk-core.IResolvable Property nodeScaleMax: The maximum number of nodes for scaling.
nodeScaleMin number | @alicloud/ros-cdk-core.IResolvable Property nodeScaleMin: The minimum number of nodes for scaling.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the VSwitch.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone.
backupSetId string | @alicloud/ros-cdk-core.IResolvable Property backupSetId: The ID of the backup set.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: The description of the database instance.
dbTimeZone string | @alicloud/ros-cdk-core.IResolvable Property dbTimeZone: The time zone of the database, which must be an IANA time zone identifier.
deploySchema string | @alicloud/ros-cdk-core.IResolvable Property deploySchema: The deployment schema.
multiZone @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MultiZoneProperty[] Property multiZone: Multi-zone configuration.
publicConnectionSetting @alicloud/ros-cdk-core.IResolvable | PublicConnectionSettingProperty Property publicConnectionSetting: The public connection setting.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
sourceDbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property sourceDbInstanceId: The ID of the source instance.
storageQuota number | @alicloud/ros-cdk-core.IResolvable Property storageQuota: The storage quota.
storageType string | @alicloud/ros-cdk-core.IResolvable Property storageType: The type of storage.
tags TagsProperty[] Property tags: Tags to attach to clickhouse_enterprise_db.

engineRequired

public readonly engine: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engine: The engine type.


nodeCountRequired

public readonly nodeCount: number | IResolvable;
  • Type: number | @alicloud/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.


nodeScaleMaxRequired

public readonly nodeScaleMax: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property nodeScaleMax: The maximum number of nodes for scaling.


nodeScaleMinRequired

public readonly nodeScaleMin: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property nodeScaleMin: The minimum number of nodes for scaling.


vpcIdRequired

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.


vSwitchIdRequired

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch.


zoneIdRequired

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The ID of the zone.


backupSetIdOptional

public readonly backupSetId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupSetId: The ID of the backup set.


dbInstanceDescriptionOptional

public readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: The description of the database instance.


dbTimeZoneOptional

public readonly dbTimeZone: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


deploySchemaOptional

public readonly deploySchema: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property deploySchema: The deployment schema.


multiZoneOptional

public readonly multiZone: IResolvable | IResolvable | MultiZoneProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MultiZoneProperty[]

Property multiZone: Multi-zone configuration.


publicConnectionSettingOptional

public readonly publicConnectionSetting: IResolvable | PublicConnectionSettingProperty;

Property publicConnectionSetting: The public connection setting.


resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.


sourceDbInstanceIdOptional

public readonly sourceDbInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property sourceDbInstanceId: The ID of the source instance.

This parameter is required when restoring from a backup.


storageQuotaOptional

public readonly storageQuota: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property storageQuota: The storage quota.


storageTypeOptional

public readonly storageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property storageType: The type of storage.


tagsOptional

public readonly tags: 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.