EnterpriseDBCluster

• Implements: @alicloud/ros-cdk-clickhouse.datasource.IEnterpriseDBCluster

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

Initializers

import { datasource } from '@alicloud/ros-cdk-clickhouse'
new datasource.EnterpriseDBCluster(scope: Construct, id: string, props: EnterpriseDBClusterProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: EnterpriseDBClusterProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-clickhouse'
datasource.EnterpriseDBCluster.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrCategory^Required

public readonly attrCategory: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrChargeType^Required

public readonly attrChargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ChargeType: The billing method.

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

attrComputingGroupIds^Required

public readonly attrComputingGroupIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ComputingGroupIds: The list of computing group IDs.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the cluster.

attrDbInstanceId^Required

public readonly attrDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceId: The cluster ID.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: The cluster description.

attrDisabledPorts^Required

public readonly attrDisabledPorts: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DisabledPorts: The specified database port is disabled.

Multiple ports separated by commas (,) are supported.

attrEndpoints^Required

public readonly attrEndpoints: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Endpoints: List of Endpoint details.

attrEngine^Required

public readonly attrEngine: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Engine: The engine type.

attrEngineMinorVersion^Required

public readonly attrEngineMinorVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EngineVersion: The engine version.

attrInstanceNetworkType^Required

public readonly attrInstanceNetworkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstanceNetworkType: The network type of the instance.

attrMaintainEndTime^Required

public readonly attrMaintainEndTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaintainEndTime: The end time of the maintenance window.

attrMaintainStartTime^Required

public readonly attrMaintainStartTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaintainStartTime: The maintainable time start time.

attrMultiZones^Required

public readonly attrMultiZones: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MultiZones: The information about the zones.

attrNodeCount^Required

public readonly attrNodeCount: string | IResolvable;

• Type: string | @alicloud/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.

attrNodes^Required

public readonly attrNodes: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Nodes: The Node information.

attrNodeScaleMax^Required

public readonly attrNodeScaleMax: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrNodeScaleMin^Required

public readonly attrNodeScaleMin: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrObjectStoreSize^Required

public readonly attrObjectStoreSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ObjectStoreSize: The size of the object storage space.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrScaleMax^Required

public readonly attrScaleMax: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScaleMax: The maximum capacity for elastic scaling.

attrScaleMin^Required

public readonly attrScaleMin: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScaleMin: The minimum capacity for elastic scaling.

attrStorageQuota^Required

public readonly attrStorageQuota: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrStorageSize^Required

public readonly attrStorageSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute StorageSize: The size of the storage space.

Unit: GB.

attrStorageType^Required

public readonly attrStorageType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute StorageType: The storage type.

attrTags^Required

public readonly attrTags: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The details of the tags.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The VPC ID.

attrVswitchId^Required

public readonly attrVswitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VswitchId: The VSwitch ID.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The zone ID.

props^Required

public readonly props: EnterpriseDBClusterProps;

• Type: EnterpriseDBClusterProps