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 

using AlibabaCloud.SDK.ROS.CDK.Clickhouse;
new DBCluster(Construct Scope, string Id, DBClusterProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props DBClusterProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired

EnableResourcePropertyConstraintOptional

  • Type: bool

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 

private string ToString()

Returns a string representation of this construct.

Synthesize 

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition 

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount 

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency 

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc 

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy 

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt 

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata 

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct 

using AlibabaCloud.SDK.ROS.CDK.Clickhouse;
DBCluster.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAliUid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute AliUid: Alibaba Cloud account.
AttrBid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Bid: The ID of the business process flow.
AttrCategory AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Category: Copy configuration, value description:.
AttrCommodityCode AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CommodityCode: Buy Product Code.
AttrConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ConnectionString: Connection string.
AttrCreateTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CreateTime: The creation time of the resource.
AttrDbClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterId: Instance ID.
AttrDbClusterIpArrayName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
AttrDbClusterName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterName: The cluster description information.
AttrDbClusterNetworkType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbClusterNetworkType: Network type.
AttrDbClusterType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterType: Instance type.
AttrDbNodeClass AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbNodeClass: Set the node type.
AttrDbNodeCount AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
AttrDbNodeStorage AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbNodeStorage: Single-node storage space.
AttrEncryptionKey AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EncryptionKey: Key management service KMS key ID.
AttrEncryptionType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
AttrEngine AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Engine: Engine.
AttrEngineVersion AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EngineVersion: The engine version.
AttrExpireTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ExpireTime: The expiration time.
AttrIsExpired AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IsExpired: If the instance has expired.
AttrLockMode AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LockMode: The lock mode.
AttrLockReason AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LockReason: Lock reason.
AttrMaintainTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
AttrPaymentType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PaymentType: The paymen type of the resource.
AttrPort AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Port: Connection port.
AttrPublicConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PublicConnectionString: A public IP address for the connection.
AttrPublicIpAddr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PublicIpAddr: Public IP address.
AttrPublicPort AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PublicPort: Public network port.
AttrResourceGroupId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
AttrScaleOutStatus AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ScaleOutStatus: Scale state.
AttrSecurityIps AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SecurityIps: The whitelist supports the following two formats:.
AttrStorageType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
AttrSupportBackup AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SupportBackup: Support fallback scheme.
AttrSupportHttpsPort AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SupportHttpsPort: The system supports http port number.
AttrSupportMysqlPort AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
AttrSupportOss AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
AttrVpcCloudInstanceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
AttrVpcId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcId: VPC ID.
AttrVpcIpAddr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcIpAddr: VPC IP address.
AttrVSwitchId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VSwitchId: Switch ID.
AttrZoneId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ZoneId: On behalf of the zone resource attribute field.

NodeRequired 

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

RefRequired 

public string Ref { get; }
  • Type: string

StackRequired 

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

ResourceOptional 

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAliUidRequired 

public IResolvable AttrAliUid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute AliUid: Alibaba Cloud account.

AttrBidRequired 

public IResolvable AttrBid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Bid: The ID of the business process flow.

AttrCategoryRequired 

public IResolvable AttrCategory { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Category: Copy configuration, value description:.

AttrCommodityCodeRequired 

public IResolvable AttrCommodityCode { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CommodityCode: Buy Product Code.

AttrConnectionStringRequired 

public IResolvable AttrConnectionString { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ConnectionString: Connection string.

AttrCreateTimeRequired 

public IResolvable AttrCreateTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CreateTime: The creation time of the resource.

AttrDbClusterIdRequired 

public IResolvable AttrDbClusterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBClusterId: Instance ID.

AttrDbClusterIpArrayNameRequired 

public IResolvable AttrDbClusterIpArrayName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrDbClusterNameRequired 

public IResolvable AttrDbClusterName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBClusterName: The cluster description information.

AttrDbClusterNetworkTypeRequired 

public IResolvable AttrDbClusterNetworkType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DbClusterNetworkType: Network type.

Currently, only VPC is supported.

AttrDbClusterTypeRequired 

public IResolvable AttrDbClusterType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBClusterType: Instance type.

AttrDbNodeClassRequired 

public IResolvable AttrDbNodeClass { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DbNodeClass: Set the node type.

AttrDbNodeCountRequired 

public IResolvable AttrDbNodeCount { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrDbNodeStorageRequired 

public IResolvable AttrDbNodeStorage { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DbNodeStorage: Single-node storage space.

Value range: 100 GB to 32000GB.

AttrEncryptionKeyRequired 

public IResolvable AttrEncryptionKey { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EncryptionKey: Key management service KMS key ID.

AttrEncryptionTypeRequired 

public IResolvable AttrEncryptionType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrEngineRequired 

public IResolvable AttrEngine { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Engine: Engine.

AttrEngineVersionRequired 

public IResolvable AttrEngineVersion { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EngineVersion: The engine version.

AttrExpireTimeRequired 

public IResolvable AttrExpireTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ExpireTime: The expiration time.

AttrIsExpiredRequired 

public IResolvable AttrIsExpired { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute IsExpired: If the instance has expired.

AttrLockModeRequired 

public IResolvable AttrLockMode { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute LockMode: The lock mode.

AttrLockReasonRequired 

public IResolvable AttrLockReason { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute LockReason: Lock reason.

AttrMaintainTimeRequired 

public IResolvable AttrMaintainTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrPaymentTypeRequired 

public IResolvable AttrPaymentType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PaymentType: The paymen type of the resource.

AttrPortRequired 

public IResolvable AttrPort { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Port: Connection port.

AttrPublicConnectionStringRequired 

public IResolvable AttrPublicConnectionString { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PublicConnectionString: A public IP address for the connection.

AttrPublicIpAddrRequired 

public IResolvable AttrPublicIpAddr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PublicIpAddr: Public IP address.

AttrPublicPortRequired 

public IResolvable AttrPublicPort { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PublicPort: Public network port.

AttrResourceGroupIdRequired 

public IResolvable AttrResourceGroupId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

AttrScaleOutStatusRequired 

public IResolvable AttrScaleOutStatus { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ScaleOutStatus: Scale state.

AttrSecurityIpsRequired 

public IResolvable AttrSecurityIps { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrStorageTypeRequired 

public IResolvable AttrStorageType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrSupportBackupRequired 

public IResolvable AttrSupportBackup { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SupportBackup: Support fallback scheme.

AttrSupportHttpsPortRequired 

public IResolvable AttrSupportHttpsPort { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SupportHttpsPort: The system supports http port number.

AttrSupportMysqlPortRequired 

public IResolvable AttrSupportMysqlPort { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrSupportOssRequired 

public IResolvable AttrSupportOss { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrVpcCloudInstanceIdRequired 

public IResolvable AttrVpcCloudInstanceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrVpcIdRequired 

public IResolvable AttrVpcId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute VpcId: VPC ID.

AttrVpcIpAddrRequired 

public IResolvable AttrVpcIpAddr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute VpcIpAddr: VPC IP address.

AttrVSwitchIdRequired 

public IResolvable AttrVSwitchId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute VSwitchId: Switch ID.

AttrZoneIdRequired 

public IResolvable AttrZoneId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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