DBCluster

• Implements: IDBCluster

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

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: AliUid.

AttrBid^Required

public object AttrBid { get; }

• Type: object

Attribute Bid: BusinessID.

AttrCategory^Required

public object AttrCategory { get; }

• Type: object

Attribute Category: The edition of the cluster.

AttrCommodityCode^Required

public object AttrCommodityCode { get; }

• Type: object

Attribute CommodityCode: Product Code.

AttrConnectionString^Required

public object AttrConnectionString { get; }

• Type: object

Attribute ConnectionString: ConnectionString.

AttrDbClusterDescription^Required

public object AttrDbClusterDescription { get; }

• Type: object

Attribute DBClusterDescription: The description of the cluster.

AttrDbClusterId^Required

public object AttrDbClusterId { get; }

• Type: object

Attribute DBClusterId: The id of DBCluster.

AttrDbClusterNetworkType^Required

public object AttrDbClusterNetworkType { get; }

• Type: object

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

AttrDbClusterType^Required

public object AttrDbClusterType { get; }

• Type: object

Attribute DBClusterType: The specification of the cluster.

AttrDbClusterVersion^Required

public object AttrDbClusterVersion { get; }

• Type: object

Attribute DBClusterVersion: Version, value: 19.15.2.2.

AttrDbNodeClass^Required

public object AttrDbNodeClass { get; }

• Type: object

Attribute DBNodeClass: DBNodeClass.

AttrDbNodeCount^Required

public object AttrDbNodeCount { get; }

• Type: object

Attribute DBNodeCount: The number of nodes.

AttrDbNodeStorage^Required

public object AttrDbNodeStorage { get; }

• Type: object

Attribute DBNodeStorage: The storage capacity of a single node.

AttrDbNodeStorageType^Required

public object AttrDbNodeStorageType { get; }

• Type: object

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

AttrEncryptionKey^Required

public object AttrEncryptionKey { get; }

• Type: object

Attribute EncryptionKey: KMS key ID.

AttrEncryptionType^Required

public object AttrEncryptionType { get; }

• Type: object

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

AttrEngine^Required

public object AttrEngine { get; }

• Type: object

Attribute Engine: Engine.

AttrEngineVersion^Required

public object AttrEngineVersion { get; }

• Type: object

Attribute EngineVersion: EngineVersion.

AttrIsExpired^Required

public object AttrIsExpired { get; }

• Type: object

Attribute IsExpired: IsExpired.

AttrLockMode^Required

public object AttrLockMode { get; }

• Type: object

Attribute LockMode: LockMode.

AttrLockReason^Required

public object AttrLockReason { get; }

• Type: object

Attribute LockReason: Reason for lock.

AttrPaymentType^Required

public object AttrPaymentType { get; }

• Type: object

Attribute PaymentType: PayType.

AttrPeriod^Required

public object AttrPeriod { get; }

• Type: object

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 object AttrPort { get; }

• Type: object

Attribute Port: Connection port.

AttrPublicConnectionString^Required

public object AttrPublicConnectionString { get; }

• Type: object

Attribute PublicConnectionString: Internet connection address.

AttrPublicPort^Required

public object AttrPublicPort { get; }

• Type: object

Attribute PublicPort: PublicPort.

AttrStorageType^Required

public object AttrStorageType { get; }

• Type: object

Attribute StorageType: StorageType.

AttrVpcCloudInstanceId^Required

public object AttrVpcCloudInstanceId { get; }

• Type: object

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

AttrVpcId^Required

public object AttrVpcId { get; }

• Type: object

Attribute VpcId: VpcId.

AttrVSwitchId^Required

public object AttrVSwitchId { get; }

• Type: object

Attribute VSwitchId: VSwitchId.

AttrZoneId^Required

public object AttrZoneId { get; }

• Type: object

Attribute ZoneId: ZoneId.

Props^Required

public DBClusterProps Props { get; }

• Type: DBClusterProps