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

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse/datasource"
datasource.NewRosDBCluster(scope Construct, id *string, props RosDBClusterProps, enableResourcePropertyConstraint *bool) RosDBCluster

Name	Type	Description
scope	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func AddCondition(con RosCondition)

con^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

---

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

---

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: *string

The path of the value to delete.

---

AddDependsOn

func AddDependsOn(target RosResource)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

---

AddDesc

func AddDesc(desc *string)

desc^Required

• Type: *string

---

AddMetaData

func AddMetaData(key *string, value interface{})

key^Required

• Type: *string

---

value^Required

• Type: interface{}

---

AddOverride

func AddOverride(path *string, value interface{})

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: interface{}

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

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

propertyPath^Required

• Type: *string

The path to the property.

---

AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

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: interface{}

The value.

---

AddRosDependency

func AddRosDependency(target *string)

target^Required

• Type: *string

---

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

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

policy^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

---

options^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

---

GetAtt

func GetAtt(attributeName *string) Reference

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

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse/datasource"
datasource.RosDBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

---

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse/datasource"
datasource.RosDBCluster_IsRosElement(x interface{}) *bool

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: interface{}

---

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse/datasource"
datasource.RosDBCluster_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

construct^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

---

Properties

Name	Type	Description
Node	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode	The construct tree node associated with this construct.
CreationStack	[]string	No description.
LogicalId	*string	The logical ID for this stack element.
Stack	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	*string	ROS resource type.
AttrAliUid	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrBid	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrCategory	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrCommodityCode	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrCreateTime	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterIpArrayName	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterName	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterNetworkType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbNodeClass	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbNodeCount	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbNodeStorage	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrEncryptionKey	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrEncryptionType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrEngine	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrEngineVersion	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrExpireTime	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrIsExpired	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrLockMode	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrLockReason	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrMaintainTime	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPaymentType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicIpAddr	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrResourceGroupId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrScaleOutStatus	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrSecurityIps	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrStorageType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrSupportBackup	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrSupportHttpsPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrSupportMysqlPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrSupportOss	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrVpcCloudInstanceId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrVpcId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrVpcIpAddr	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrVSwitchId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrZoneId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
DbClusterId	interface{}	No description.
EnableResourcePropertyConstraint	*bool	No description.
RefreshOptions	interface{}	No description.

---

Node^Required

func Node() ConstructNode

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

func CreationStack() *[]*string

• Type: []string

---

LogicalId^Required

func LogicalId() *string

• 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

func Stack() Stack

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

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

---

Ref^Required

func Ref() *string

• 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

func RosOptions() IRosResourceOptions

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

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

---

RosResourceType^Required

func RosResourceType() *string

• Type: *string

ROS resource type.

---

AttrAliUid^Required

func AttrAliUid() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrBid^Required

func AttrBid() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrCategory^Required

func AttrCategory() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrCommodityCode^Required

func AttrCommodityCode() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrConnectionString^Required

func AttrConnectionString() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrCreateTime^Required

func AttrCreateTime() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbClusterId^Required

func AttrDbClusterId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbClusterIpArrayName^Required

func AttrDbClusterIpArrayName() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbClusterName^Required

func AttrDbClusterName() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbClusterNetworkType^Required

func AttrDbClusterNetworkType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbClusterType^Required

func AttrDbClusterType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbNodeClass^Required

func AttrDbNodeClass() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbNodeCount^Required

func AttrDbNodeCount() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrDbNodeStorage^Required

func AttrDbNodeStorage() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrEncryptionKey^Required

func AttrEncryptionKey() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrEncryptionType^Required

func AttrEncryptionType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrEngine^Required

func AttrEngine() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrEngineVersion^Required

func AttrEngineVersion() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrExpireTime^Required

func AttrExpireTime() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrIsExpired^Required

func AttrIsExpired() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrLockMode^Required

func AttrLockMode() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrLockReason^Required

func AttrLockReason() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrMaintainTime^Required

func AttrMaintainTime() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPaymentType^Required

func AttrPaymentType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPort^Required

func AttrPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicConnectionString^Required

func AttrPublicConnectionString() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicIpAddr^Required

func AttrPublicIpAddr() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicPort^Required

func AttrPublicPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrResourceGroupId^Required

func AttrResourceGroupId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrScaleOutStatus^Required

func AttrScaleOutStatus() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrSecurityIps^Required

func AttrSecurityIps() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrStorageType^Required

func AttrStorageType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrSupportBackup^Required

func AttrSupportBackup() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrSupportHttpsPort^Required

func AttrSupportHttpsPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrSupportMysqlPort^Required

func AttrSupportMysqlPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrSupportOss^Required

func AttrSupportOss() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrVpcCloudInstanceId^Required

func AttrVpcCloudInstanceId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrVpcId^Required

func AttrVpcId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrVpcIpAddr^Required

func AttrVpcIpAddr() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrVSwitchId^Required

func AttrVSwitchId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrZoneId^Required

func AttrZoneId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

DbClusterId^Required

func DbClusterId() interface{}

• Type: interface{}

---

EnableResourcePropertyConstraint^Required

func EnableResourcePropertyConstraint() *bool

• Type: *bool

---

RefreshOptions^Optional

func RefreshOptions() interface{}

• Type: interface{}

---

Constants

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

---

RosResourceTypeName^Required

func RosResourceTypeName() *string

• Type: *string

The resource type name for this resource class.

---