Skip to content

DBCluster

This class encapsulates and extends the ROS resource type DATASOURCE::ClickHouse::DBCluster, which is used to query the information about an ApsaraDB for ClickHouse cluster.

Initializers 

import { datasource } from '@alicloud/ros-cdk-clickhouse'
new datasource.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 { datasource } from '@alicloud/ros-cdk-clickhouse'
datasource.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: Alibaba Cloud account.
attrBid @alicloud/ros-cdk-core.IResolvable Attribute Bid: The ID of the business process flow.
attrCategory @alicloud/ros-cdk-core.IResolvable Attribute Category: Copy configuration, value description:.
attrCommodityCode @alicloud/ros-cdk-core.IResolvable Attribute CommodityCode: Buy Product Code.
attrConnectionString @alicloud/ros-cdk-core.IResolvable Attribute ConnectionString: Connection string.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the resource.
attrDbClusterId @alicloud/ros-cdk-core.IResolvable Attribute DBClusterId: Instance ID.
attrDbClusterIpArrayName @alicloud/ros-cdk-core.IResolvable Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
attrDbClusterName @alicloud/ros-cdk-core.IResolvable Attribute DBClusterName: The cluster description information.
attrDbClusterNetworkType @alicloud/ros-cdk-core.IResolvable Attribute DbClusterNetworkType: Network type.
attrDbClusterType @alicloud/ros-cdk-core.IResolvable Attribute DBClusterType: Instance type.
attrDbNodeClass @alicloud/ros-cdk-core.IResolvable Attribute DbNodeClass: Set the node type.
attrDbNodeCount @alicloud/ros-cdk-core.IResolvable Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
attrDbNodeStorage @alicloud/ros-cdk-core.IResolvable Attribute DbNodeStorage: Single-node storage space.
attrEncryptionKey @alicloud/ros-cdk-core.IResolvable Attribute EncryptionKey: Key management service KMS key ID.
attrEncryptionType @alicloud/ros-cdk-core.IResolvable Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
attrEngine @alicloud/ros-cdk-core.IResolvable Attribute Engine: Engine.
attrEngineVersion @alicloud/ros-cdk-core.IResolvable Attribute EngineVersion: The engine version.
attrExpireTime @alicloud/ros-cdk-core.IResolvable Attribute ExpireTime: The expiration time.
attrIsExpired @alicloud/ros-cdk-core.IResolvable Attribute IsExpired: If the instance has expired.
attrLockMode @alicloud/ros-cdk-core.IResolvable Attribute LockMode: The lock mode.
attrLockReason @alicloud/ros-cdk-core.IResolvable Attribute LockReason: Lock reason.
attrMaintainTime @alicloud/ros-cdk-core.IResolvable Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The paymen type of the resource.
attrPort @alicloud/ros-cdk-core.IResolvable Attribute Port: Connection port.
attrPublicConnectionString @alicloud/ros-cdk-core.IResolvable Attribute PublicConnectionString: A public IP address for the connection.
attrPublicIpAddr @alicloud/ros-cdk-core.IResolvable Attribute PublicIpAddr: Public IP address.
attrPublicPort @alicloud/ros-cdk-core.IResolvable Attribute PublicPort: Public network port.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrScaleOutStatus @alicloud/ros-cdk-core.IResolvable Attribute ScaleOutStatus: Scale state.
attrSecurityIps @alicloud/ros-cdk-core.IResolvable Attribute SecurityIps: The whitelist supports the following two formats:.
attrStorageType @alicloud/ros-cdk-core.IResolvable Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
attrSupportBackup @alicloud/ros-cdk-core.IResolvable Attribute SupportBackup: Support fallback scheme.
attrSupportHttpsPort @alicloud/ros-cdk-core.IResolvable Attribute SupportHttpsPort: The system supports http port number.
attrSupportMysqlPort @alicloud/ros-cdk-core.IResolvable Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
attrSupportOss @alicloud/ros-cdk-core.IResolvable Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
attrVpcCloudInstanceId @alicloud/ros-cdk-core.IResolvable Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: VPC ID.
attrVpcIpAddr @alicloud/ros-cdk-core.IResolvable Attribute VpcIpAddr: VPC IP address.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: Switch ID.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: On behalf of the zone resource attribute field.

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: Alibaba Cloud account.

attrBidRequired 

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

Attribute Bid: The ID of the business process flow.

attrCategoryRequired 

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

Attribute Category: Copy configuration, value description:.

attrCommodityCodeRequired 

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

Attribute CommodityCode: Buy Product Code.

attrConnectionStringRequired 

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

Attribute ConnectionString: Connection string.

attrCreateTimeRequired 

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

Attribute CreateTime: The creation time of the resource.

attrDbClusterIdRequired 

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

Attribute DBClusterId: Instance ID.

attrDbClusterIpArrayNameRequired 

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

Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.

attrDbClusterNameRequired 

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

Attribute DBClusterName: The cluster description information.

attrDbClusterNetworkTypeRequired 

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

Attribute DbClusterNetworkType: Network type.

Currently, only VPC is supported.

attrDbClusterTypeRequired 

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

Attribute DBClusterType: Instance type.

attrDbNodeClassRequired 

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

Attribute DbNodeClass: Set the node type.

attrDbNodeCountRequired 

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

Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.

attrDbNodeStorageRequired 

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

Attribute DbNodeStorage: Single-node storage space.

Value range: 100 GB to 32000GB.

attrEncryptionKeyRequired 

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

Attribute EncryptionKey: Key management service KMS key ID.

attrEncryptionTypeRequired 

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

Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

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: The engine version.

attrExpireTimeRequired 

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

Attribute ExpireTime: The expiration time.

attrIsExpiredRequired 

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

Attribute IsExpired: If the instance has expired.

attrLockModeRequired 

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

Attribute LockMode: The lock mode.

attrLockReasonRequired 

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

Attribute LockReason: Lock reason.

attrMaintainTimeRequired 

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

Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.

attrPaymentTypeRequired 

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

Attribute PaymentType: The paymen type of the resource.

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: A public IP address for the connection.

attrPublicIpAddrRequired 

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

Attribute PublicIpAddr: Public IP address.

attrPublicPortRequired 

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

Attribute PublicPort: Public network port.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrScaleOutStatusRequired 

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

Attribute ScaleOutStatus: Scale state.

attrSecurityIpsRequired 

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

Attribute SecurityIps: The whitelist supports the following two formats:.

attrStorageTypeRequired 

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

Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.

attrSupportBackupRequired 

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

Attribute SupportBackup: Support fallback scheme.

attrSupportHttpsPortRequired 

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

Attribute SupportHttpsPort: The system supports http port number.

attrSupportMysqlPortRequired 

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

Attribute SupportMysqlPort: Supports Mysql, and those of the ports.

attrSupportOssRequired 

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

Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.

attrVpcCloudInstanceIdRequired 

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

Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.

attrVpcIdRequired 

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

Attribute VpcId: VPC ID.

attrVpcIpAddrRequired 

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

Attribute VpcIpAddr: VPC IP address.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Switch ID.

attrZoneIdRequired 

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

Attribute ZoneId: On behalf of the zone resource attribute field.