RosDBCluster

This class is a base encapsulation around 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 RosDBCluster(Construct Scope, string Id, RosDBClusterProps Props, bool EnableResourcePropertyConstraint);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	- scope in which this resource is defined.
Id	string	- scoped id of the resource.
Props	RosDBClusterProps	- resource properties.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

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

scope in which this resource is defined.

---

Id^Required

• Type: string

scoped id of the resource.

---

Props^Required

• Type: RosDBClusterProps

resource properties.

---

EnableResourcePropertyConstraint^Required

• 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.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
AddCondition	No description.
AddCount	No description.
AddDeletionOverride	Syntactic sugar for addOverride(path, undefined).
AddDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc	No description.
AddMetaData	No description.
AddOverride	Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride	Adds an override to a resource property.
AddRosDependency	No description.
ApplyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
GetAtt	Returns a token for an runtime attribute of this resource.

---

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.

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

AddCondition

private void AddCondition(RosCondition Con)

Con^Required

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

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

---

AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Target^Required

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

---

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

---

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

Path^Required

• Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

Value^Required

• Type: object

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPath^Required

• Type: string

The path to the property.

---

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPath^Required

• Type: string

The path of the property.

---

Value^Required

• Type: object

The value.

---

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

Policy^Optional

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

---

Options^Optional

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

---

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeName^Required

• Type: string

The name of the attribute.

---

Static Functions

Name	Description
IsConstruct	Return whether the given object is a Construct.
IsRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource	Check whether the given construct is a RosResource.

---

IsConstruct

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

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Clickhouse;
RosDBCluster.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

X^Required

• Type: object

---

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Clickhouse;
RosDBCluster.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

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

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
CreationStack	string[]	No description.
LogicalId	string	The logical ID for this stack element.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this element is defined.
Ref	string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions	AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	string	ROS resource type.
AttrAliUid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrBid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCategory	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCommodityCode	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrConnectionString	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCreateTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterIpArrayName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterNetworkType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbNodeClass	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbNodeCount	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbNodeStorage	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrEncryptionKey	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrEncryptionType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrEngine	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrEngineVersion	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrExpireTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIsExpired	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrLockMode	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrLockReason	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrMaintainTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPaymentType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPort	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPublicConnectionString	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPublicIpAddr	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPublicPort	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrResourceGroupId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrScaleOutStatus	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSecurityIps	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrStorageType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSupportBackup	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSupportHttpsPort	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSupportMysqlPort	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSupportOss	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVpcCloudInstanceId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVpcId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVpcIpAddr	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVSwitchId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrZoneId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
DbClusterId	object	No description.
EnableResourcePropertyConstraint	bool	No description.
RefreshOptions	object	No description.

---

Node^Required

public ConstructNode Node { get; }

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

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

Stack^Required

public Stack Stack { get; }

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

Ref^Required

public string Ref { get; }

• Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

RosOptions^Required

public IRosResourceOptions RosOptions { get; }

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

Options for this resource, such as condition, update policy etc.

---

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

---

AttrAliUid^Required

public IResolvable AttrAliUid { get; }

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

---

AttrBid^Required

public IResolvable AttrBid { get; }

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

---

AttrCategory^Required

public IResolvable AttrCategory { get; }

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

---

AttrCommodityCode^Required

public IResolvable AttrCommodityCode { get; }

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

---

AttrConnectionString^Required

public IResolvable AttrConnectionString { get; }

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

---

AttrCreateTime^Required

public IResolvable AttrCreateTime { get; }

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

---

AttrDbClusterId^Required

public IResolvable AttrDbClusterId { get; }

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

---

AttrDbClusterIpArrayName^Required

public IResolvable AttrDbClusterIpArrayName { get; }

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

---

AttrDbClusterName^Required

public IResolvable AttrDbClusterName { get; }

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

---

AttrDbClusterNetworkType^Required

public IResolvable AttrDbClusterNetworkType { get; }

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

---

AttrDbClusterType^Required

public IResolvable AttrDbClusterType { get; }

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

---

AttrDbNodeClass^Required

public IResolvable AttrDbNodeClass { get; }

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

---

AttrDbNodeCount^Required

public IResolvable AttrDbNodeCount { get; }

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

---

AttrDbNodeStorage^Required

public IResolvable AttrDbNodeStorage { get; }

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

---

AttrEncryptionKey^Required

public IResolvable AttrEncryptionKey { get; }

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

---

AttrEncryptionType^Required

public IResolvable AttrEncryptionType { get; }

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

---

AttrEngine^Required

public IResolvable AttrEngine { get; }

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

---

AttrEngineVersion^Required

public IResolvable AttrEngineVersion { get; }

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

---

AttrExpireTime^Required

public IResolvable AttrExpireTime { get; }

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

---

AttrIsExpired^Required

public IResolvable AttrIsExpired { get; }

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

---

AttrLockMode^Required

public IResolvable AttrLockMode { get; }

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

---

AttrLockReason^Required

public IResolvable AttrLockReason { get; }

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

---

AttrMaintainTime^Required

public IResolvable AttrMaintainTime { get; }

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

---

AttrPaymentType^Required

public IResolvable AttrPaymentType { get; }

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

---

AttrPort^Required

public IResolvable AttrPort { get; }

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

---

AttrPublicConnectionString^Required

public IResolvable AttrPublicConnectionString { get; }

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

---

AttrPublicIpAddr^Required

public IResolvable AttrPublicIpAddr { get; }

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

---

AttrPublicPort^Required

public IResolvable AttrPublicPort { get; }

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

---

AttrResourceGroupId^Required

public IResolvable AttrResourceGroupId { get; }

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

---

AttrScaleOutStatus^Required

public IResolvable AttrScaleOutStatus { get; }

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

---

AttrSecurityIps^Required

public IResolvable AttrSecurityIps { get; }

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

---

AttrStorageType^Required

public IResolvable AttrStorageType { get; }

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

---

AttrSupportBackup^Required

public IResolvable AttrSupportBackup { get; }

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

---

AttrSupportHttpsPort^Required

public IResolvable AttrSupportHttpsPort { get; }

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

---

AttrSupportMysqlPort^Required

public IResolvable AttrSupportMysqlPort { get; }

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

---

AttrSupportOss^Required

public IResolvable AttrSupportOss { get; }

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

---

AttrVpcCloudInstanceId^Required

public IResolvable AttrVpcCloudInstanceId { get; }

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

---

AttrVpcId^Required

public IResolvable AttrVpcId { get; }

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

---

AttrVpcIpAddr^Required

public IResolvable AttrVpcIpAddr { get; }

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

---

AttrVSwitchId^Required

public IResolvable AttrVSwitchId { get; }

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

---

AttrZoneId^Required

public IResolvable AttrZoneId { get; }

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

---

DbClusterId^Required

public object DbClusterId { get; }

• Type: object

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

RefreshOptions^Optional

public object RefreshOptions { get; }

• Type: object

---

Constants

Name	Type	Description
RosResourceTypeName	string	The resource type name for this resource class.

---

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.

---