DBCluster

• Implements: IDBCluster

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

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• Type: DBClusterProps

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 { DBCluster } from '@alicloud/ros-cdk-clickhouse'
DBCluster.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

attrAliUid^Required

public readonly attrAliUid: string | IResolvable;

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

Attribute AliUid: AliUid.

attrBid^Required

public readonly attrBid: string | IResolvable;

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

Attribute Bid: BusinessID.

attrCategory^Required

public readonly attrCategory: string | IResolvable;

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

Attribute Category: The edition of the cluster.

attrCommodityCode^Required

public readonly attrCommodityCode: string | IResolvable;

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

Attribute CommodityCode: Product Code.

attrConnectionString^Required

public readonly attrConnectionString: string | IResolvable;

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

Attribute ConnectionString: ConnectionString.

attrDbClusterDescription^Required

public readonly attrDbClusterDescription: string | IResolvable;

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

Attribute DBClusterDescription: The description of the cluster.

attrDbClusterId^Required

public readonly attrDbClusterId: string | IResolvable;

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

Attribute DBClusterId: The id of DBCluster.

attrDbClusterNetworkType^Required

public readonly attrDbClusterNetworkType: string | IResolvable;

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

Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.

attrDbClusterType^Required

public readonly attrDbClusterType: string | IResolvable;

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

Attribute DBClusterType: The specification of the cluster.

attrDbClusterVersion^Required

public readonly attrDbClusterVersion: string | IResolvable;

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

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attrDbNodeClass^Required

public readonly attrDbNodeClass: string | IResolvable;

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

Attribute DBNodeClass: DBNodeClass.

attrDbNodeCount^Required

public readonly attrDbNodeCount: string | IResolvable;

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

Attribute DBNodeCount: The number of nodes.

attrDbNodeStorage^Required

public readonly attrDbNodeStorage: string | IResolvable;

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

Attribute DBNodeStorage: The storage capacity of a single node.

attrDbNodeStorageType^Required

public readonly attrDbNodeStorageType: string | IResolvable;

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

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attrEncryptionKey^Required

public readonly attrEncryptionKey: string | IResolvable;

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

Attribute EncryptionKey: KMS key ID.

attrEncryptionType^Required

public readonly attrEncryptionType: string | IResolvable;

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

Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.

attrEngine^Required

public readonly attrEngine: string | IResolvable;

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

Attribute Engine: Engine.

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

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

Attribute EngineVersion: EngineVersion.

attrIsExpired^Required

public readonly attrIsExpired: string | IResolvable;

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

Attribute IsExpired: IsExpired.

attrLockMode^Required

public readonly attrLockMode: string | IResolvable;

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

Attribute LockMode: LockMode.

attrLockReason^Required

public readonly attrLockReason: string | IResolvable;

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

Attribute LockReason: Reason for lock.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: PayType.

attrPeriod^Required

public readonly attrPeriod: string | IResolvable;

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

Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.

attrPort^Required

public readonly attrPort: string | IResolvable;

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

Attribute Port: Connection port.

attrPublicConnectionString^Required

public readonly attrPublicConnectionString: string | IResolvable;

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

Attribute PublicConnectionString: Internet connection address.

attrPublicPort^Required

public readonly attrPublicPort: string | IResolvable;

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

Attribute PublicPort: PublicPort.

attrStorageType^Required

public readonly attrStorageType: string | IResolvable;

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

Attribute StorageType: StorageType.

attrVpcCloudInstanceId^Required

public readonly attrVpcCloudInstanceId: string | IResolvable;

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

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

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

Attribute VpcId: VpcId.

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: VSwitchId.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

Attribute ZoneId: ZoneId.

props^Required

public readonly props: DBClusterProps;

• Type: DBClusterProps