DBCluster

• Implements: AlibabaCloud.SDK.ROS.CDK.Clickhouse.datasource.IDBCluster

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);

Scope^Required

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

Id^Required

• Type: string

Props^Required

• Type: DBClusterProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

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.

Session^Required

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

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

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

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

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

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

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

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

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

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

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

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

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

AttrAliUid^Required

public object AttrAliUid { get; }

• Type: object

Attribute AliUid: Alibaba Cloud account.

AttrBid^Required

public object AttrBid { get; }

• Type: object

Attribute Bid: The ID of the business process flow.

AttrCategory^Required

public object AttrCategory { get; }

• Type: object

Attribute Category: Copy configuration, value description:.

AttrCommodityCode^Required

public object AttrCommodityCode { get; }

• Type: object

Attribute CommodityCode: Buy Product Code.

AttrConnectionString^Required

public object AttrConnectionString { get; }

• Type: object

Attribute ConnectionString: Connection string.

AttrCreateTime^Required

public object AttrCreateTime { get; }

• Type: object

Attribute CreateTime: The creation time of the resource.

AttrDbClusterId^Required

public object AttrDbClusterId { get; }

• Type: object

Attribute DBClusterId: Instance ID.

AttrDbClusterIpArrayName^Required

public object AttrDbClusterIpArrayName { get; }

• Type: object

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

AttrDbClusterName^Required

public object AttrDbClusterName { get; }

• Type: object

Attribute DBClusterName: The cluster description information.

AttrDbClusterNetworkType^Required

public object AttrDbClusterNetworkType { get; }

• Type: object

Attribute DbClusterNetworkType: Network type.

Currently, only VPC is supported.

AttrDbClusterType^Required

public object AttrDbClusterType { get; }

• Type: object

Attribute DBClusterType: Instance type.

AttrDbNodeClass^Required

public object AttrDbNodeClass { get; }

• Type: object

Attribute DbNodeClass: Set the node type.

AttrDbNodeCount^Required

public object AttrDbNodeCount { get; }

• Type: object

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

AttrDbNodeStorage^Required

public object AttrDbNodeStorage { get; }

• Type: object

Attribute DbNodeStorage: Single-node storage space.

Value range: 100 GB to 32000GB.

AttrEncryptionKey^Required

public object AttrEncryptionKey { get; }

• Type: object

Attribute EncryptionKey: Key management service KMS key ID.

AttrEncryptionType^Required

public object AttrEncryptionType { get; }

• Type: object

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

AttrEngine^Required

public object AttrEngine { get; }

• Type: object

Attribute Engine: Engine.

AttrEngineVersion^Required

public object AttrEngineVersion { get; }

• Type: object

Attribute EngineVersion: The engine version.

AttrExpireTime^Required

public object AttrExpireTime { get; }

• Type: object

Attribute ExpireTime: The expiration time.

AttrIsExpired^Required

public object AttrIsExpired { get; }

• Type: object

Attribute IsExpired: If the instance has expired.

AttrLockMode^Required

public object AttrLockMode { get; }

• Type: object

Attribute LockMode: The lock mode.

AttrLockReason^Required

public object AttrLockReason { get; }

• Type: object

Attribute LockReason: Lock reason.

AttrMaintainTime^Required

public object AttrMaintainTime { get; }

• Type: object

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

AttrPaymentType^Required

public object AttrPaymentType { get; }

• Type: object

Attribute PaymentType: The paymen type of the resource.

AttrPort^Required

public object AttrPort { get; }

• Type: object

Attribute Port: Connection port.

AttrPublicConnectionString^Required

public object AttrPublicConnectionString { get; }

• Type: object

Attribute PublicConnectionString: A public IP address for the connection.

AttrPublicIpAddr^Required

public object AttrPublicIpAddr { get; }

• Type: object

Attribute PublicIpAddr: Public IP address.

AttrPublicPort^Required

public object AttrPublicPort { get; }

• Type: object

Attribute PublicPort: Public network port.

AttrResourceGroupId^Required

public object AttrResourceGroupId { get; }

• Type: object

Attribute ResourceGroupId: The ID of the resource group.

AttrScaleOutStatus^Required

public object AttrScaleOutStatus { get; }

• Type: object

Attribute ScaleOutStatus: Scale state.

AttrSecurityIps^Required

public object AttrSecurityIps { get; }

• Type: object

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

AttrStorageType^Required

public object AttrStorageType { get; }

• Type: object

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

AttrSupportBackup^Required

public object AttrSupportBackup { get; }

• Type: object

Attribute SupportBackup: Support fallback scheme.

AttrSupportHttpsPort^Required

public object AttrSupportHttpsPort { get; }

• Type: object

Attribute SupportHttpsPort: The system supports http port number.

AttrSupportMysqlPort^Required

public object AttrSupportMysqlPort { get; }

• Type: object

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

AttrSupportOss^Required

public object AttrSupportOss { get; }

• Type: object

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

AttrVpcCloudInstanceId^Required

public object AttrVpcCloudInstanceId { get; }

• Type: object

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

AttrVpcId^Required

public object AttrVpcId { get; }

• Type: object

Attribute VpcId: VPC ID.

AttrVpcIpAddr^Required

public object AttrVpcIpAddr { get; }

• Type: object

Attribute VpcIpAddr: VPC IP address.

AttrVSwitchId^Required

public object AttrVSwitchId { get; }

• Type: object

Attribute VSwitchId: Switch ID.

AttrZoneId^Required

public object AttrZoneId { get; }

• Type: object

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

Props^Required

public DBClusterProps Props { get; }

• Type: DBClusterProps