Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::DBCluster, which is used to create an ApsaraDB for ClickHouse cluster.

Initializers 

import { DBCluster } from '@alicloud/ros-cdk-clickhouse'
new DBCluster(scope: Construct, id: string, props: DBClusterProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DBClusterProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAliUid @alicloud/ros-cdk-core.IResolvable Attribute AliUid: AliUid.
attrBid @alicloud/ros-cdk-core.IResolvable Attribute Bid: BusinessID.
attrCategory @alicloud/ros-cdk-core.IResolvable Attribute Category: The edition of the cluster.
attrCommodityCode @alicloud/ros-cdk-core.IResolvable Attribute CommodityCode: Product Code.
attrConnectionString @alicloud/ros-cdk-core.IResolvable Attribute ConnectionString: ConnectionString.
attrDbClusterDescription @alicloud/ros-cdk-core.IResolvable Attribute DBClusterDescription: The description of the cluster.
attrDbClusterId @alicloud/ros-cdk-core.IResolvable Attribute DBClusterId: The id of DBCluster.
attrDbClusterNetworkType @alicloud/ros-cdk-core.IResolvable Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
attrDbClusterType @alicloud/ros-cdk-core.IResolvable Attribute DBClusterType: The specification of the cluster.
attrDbClusterVersion @alicloud/ros-cdk-core.IResolvable Attribute DBClusterVersion: Version, value: 19.15.2.2.
attrDbNodeClass @alicloud/ros-cdk-core.IResolvable Attribute DBNodeClass: DBNodeClass.
attrDbNodeCount @alicloud/ros-cdk-core.IResolvable Attribute DBNodeCount: The number of nodes.
attrDbNodeStorage @alicloud/ros-cdk-core.IResolvable Attribute DBNodeStorage: The storage capacity of a single node.
attrDbNodeStorageType @alicloud/ros-cdk-core.IResolvable Attribute DbNodeStorageType: Instance node storage type.
attrEncryptionKey @alicloud/ros-cdk-core.IResolvable Attribute EncryptionKey: KMS key ID.
attrEncryptionType @alicloud/ros-cdk-core.IResolvable Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
attrEngine @alicloud/ros-cdk-core.IResolvable Attribute Engine: Engine.
attrEngineVersion @alicloud/ros-cdk-core.IResolvable Attribute EngineVersion: EngineVersion.
attrIsExpired @alicloud/ros-cdk-core.IResolvable Attribute IsExpired: IsExpired.
attrLockMode @alicloud/ros-cdk-core.IResolvable Attribute LockMode: LockMode.
attrLockReason @alicloud/ros-cdk-core.IResolvable Attribute LockReason: Reason for lock.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: PayType.
attrPeriod @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 @alicloud/ros-cdk-core.IResolvable Attribute Port: Connection port.
attrPublicConnectionString @alicloud/ros-cdk-core.IResolvable Attribute PublicConnectionString: Internet connection address.
attrPublicPort @alicloud/ros-cdk-core.IResolvable Attribute PublicPort: PublicPort.
attrStorageType @alicloud/ros-cdk-core.IResolvable Attribute StorageType: StorageType.
attrVpcCloudInstanceId @alicloud/ros-cdk-core.IResolvable Attribute VpcCloudInstanceId: VpcCloudInstanceId.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: VpcId.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: VSwitchId.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: ZoneId.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAliUidRequired 

public readonly attrAliUid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AliUid: AliUid.

attrBidRequired 

public readonly attrBid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Bid: BusinessID.

attrCategoryRequired 

public readonly attrCategory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Category: The edition of the cluster.

attrCommodityCodeRequired 

public readonly attrCommodityCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CommodityCode: Product Code.

attrConnectionStringRequired 

public readonly attrConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ConnectionString: ConnectionString.

attrDbClusterDescriptionRequired 

public readonly attrDbClusterDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterDescription: The description of the cluster.

attrDbClusterIdRequired 

public readonly attrDbClusterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterId: The id of DBCluster.

attrDbClusterNetworkTypeRequired 

public readonly attrDbClusterNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDbClusterTypeRequired 

public readonly attrDbClusterType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterType: The specification of the cluster.

attrDbClusterVersionRequired 

public readonly attrDbClusterVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attrDbNodeClassRequired 

public readonly attrDbNodeClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBNodeClass: DBNodeClass.

attrDbNodeCountRequired 

public readonly attrDbNodeCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBNodeCount: The number of nodes.

attrDbNodeStorageRequired 

public readonly attrDbNodeStorage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBNodeStorage: The storage capacity of a single node.

attrDbNodeStorageTypeRequired 

public readonly attrDbNodeStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attrEncryptionKeyRequired 

public readonly attrEncryptionKey: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EncryptionKey: KMS key ID.

attrEncryptionTypeRequired 

public readonly attrEncryptionType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrEngineRequired 

public readonly attrEngine: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Engine: Engine.

attrEngineVersionRequired 

public readonly attrEngineVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EngineVersion: EngineVersion.

attrIsExpiredRequired 

public readonly attrIsExpired: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IsExpired: IsExpired.

attrLockModeRequired 

public readonly attrLockMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LockMode: LockMode.

attrLockReasonRequired 

public readonly attrLockReason: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LockReason: Reason for lock.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: PayType.

attrPeriodRequired 

public readonly attrPeriod: IResolvable;
  • Type: @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.

attrPortRequired 

public readonly attrPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Port: Connection port.

attrPublicConnectionStringRequired 

public readonly attrPublicConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicConnectionString: Internet connection address.

attrPublicPortRequired 

public readonly attrPublicPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicPort: PublicPort.

attrStorageTypeRequired 

public readonly attrStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageType: StorageType.

attrVpcCloudInstanceIdRequired 

public readonly attrVpcCloudInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: VpcId.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: VSwitchId.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: ZoneId.