EnterpriseDBCluster

• Implements: IEnterpriseDBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::EnterpriseDBCluster.

Initializers

import ros_cdk_clickhouse
ros_cdk_clickhouse.EnterpriseDBCluster(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

engine^Required

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

Property engine: The engine type.

node_count^Required

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

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

Property nodeScaleMax: The maximum number of nodes for scaling.

node_scale_min^Required

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

Property nodeScaleMin: The minimum number of nodes for scaling.

vpc_id^Required

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

Property vpcId: The ID of the VPC.

v_switch_id^Required

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

Property vSwitchId: The ID of the VSwitch.

zone_id^Required

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

Property zoneId: The ID of the zone.

backup_set_id^Optional

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

Property backupSetId: The ID of the backup set.

db_instance_description^Optional

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

Property dbInstanceDescription: The description of the database instance.

db_time_zone^Optional

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

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

Property deploySchema: The deployment schema.

multi_zone^Optional

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

Property multiZone: Multi-zone configuration.

public_connection_setting^Optional

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

Property publicConnectionSetting: The public connection setting.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

source_db_instance_id^Optional

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

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

Property storageQuota: The storage quota.

storage_type^Optional

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

Property storageType: The type of storage.

tags^Optional

• Type: 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.

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.EnterpriseDBCluster.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_db_instance_id^Required

attr_db_instance_id: typing.Union[str, IResolvable]

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

Attribute DBInstanceId: The ID of the database instance.

attr_private_connection_string^Required

attr_private_connection_string: typing.Union[str, IResolvable]

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

Attribute PrivateConnectionString: The private connection string.

attr_public_connection_string^Required

attr_public_connection_string: typing.Union[str, IResolvable]

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

Attribute PublicConnectionString: The public connection string.

props^Required

props: EnterpriseDBClusterProps

• Type: EnterpriseDBClusterProps