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 

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: AliUid.
AttrBid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Bid: BusinessID.
AttrCategory AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Category: The edition of the cluster.
AttrCommodityCode AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CommodityCode: Product Code.
AttrConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ConnectionString: ConnectionString.
AttrDbClusterDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterDescription: The description of the cluster.
AttrDbClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterId: The id of DBCluster.
AttrDbClusterNetworkType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
AttrDbClusterType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterType: The specification of the cluster.
AttrDbClusterVersion AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterVersion: Version, value: 19.15.2.2.
AttrDbNodeClass AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBNodeClass: DBNodeClass.
AttrDbNodeCount AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBNodeCount: The number of nodes.
AttrDbNodeStorage AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBNodeStorage: The storage capacity of a single node.
AttrDbNodeStorageType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbNodeStorageType: Instance node storage type.
AttrEncryptionKey AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EncryptionKey: KMS key ID.
AttrEncryptionType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
AttrEngine AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Engine: Engine.
AttrEngineVersion AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EngineVersion: EngineVersion.
AttrIsExpired AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IsExpired: IsExpired.
AttrLockMode AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LockMode: LockMode.
AttrLockReason AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LockReason: Reason for lock.
AttrPaymentType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PaymentType: PayType.
AttrPeriod AlibabaCloud.SDK.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 AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Port: Connection port.
AttrPublicConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PublicConnectionString: Internet connection address.
AttrPublicPort AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PublicPort: PublicPort.
AttrStorageType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute StorageType: StorageType.
AttrVpcCloudInstanceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcCloudInstanceId: VpcCloudInstanceId.
AttrVpcId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcId: VpcId.
AttrVSwitchId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VSwitchId: VSwitchId.
AttrZoneId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ZoneId: ZoneId.

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

AttrBidRequired 

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

Attribute Bid: BusinessID.

AttrCategoryRequired 

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

Attribute Category: The edition of the cluster.

AttrCommodityCodeRequired 

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

Attribute CommodityCode: Product Code.

AttrConnectionStringRequired 

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

Attribute ConnectionString: ConnectionString.

AttrDbClusterDescriptionRequired 

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

Attribute DBClusterDescription: The description of the cluster.

AttrDbClusterIdRequired 

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

Attribute DBClusterId: The id of DBCluster.

AttrDbClusterNetworkTypeRequired 

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

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

AttrDbClusterTypeRequired 

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

Attribute DBClusterType: The specification of the cluster.

AttrDbClusterVersionRequired 

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

Attribute DBClusterVersion: Version, value: 19.15.2.2.

AttrDbNodeClassRequired 

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

Attribute DBNodeClass: DBNodeClass.

AttrDbNodeCountRequired 

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

Attribute DBNodeCount: The number of nodes.

AttrDbNodeStorageRequired 

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

Attribute DBNodeStorage: The storage capacity of a single node.

AttrDbNodeStorageTypeRequired 

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

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

AttrEncryptionKeyRequired 

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

Attribute EncryptionKey: KMS key ID.

AttrEncryptionTypeRequired 

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

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

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

AttrIsExpiredRequired 

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

Attribute IsExpired: IsExpired.

AttrLockModeRequired 

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

Attribute LockMode: LockMode.

AttrLockReasonRequired 

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

Attribute LockReason: Reason for lock.

AttrPaymentTypeRequired 

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

Attribute PaymentType: PayType.

AttrPeriodRequired 

public IResolvable AttrPeriod { get; }
  • Type: AlibabaCloud.SDK.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 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: Internet connection address.

AttrPublicPortRequired 

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

Attribute PublicPort: PublicPort.

AttrStorageTypeRequired 

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

Attribute StorageType: StorageType.

AttrVpcCloudInstanceIdRequired 

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

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

AttrVpcIdRequired 

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

Attribute VpcId: VpcId.

AttrVSwitchIdRequired 

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

Attribute VSwitchId: VSwitchId.

AttrZoneIdRequired 

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

Attribute ZoneId: ZoneId.