RosDBCluster

This class is a base encapsulation around the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Polardb;
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.Polardb;
RosDBCluster.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Polardb;
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.Polardb;
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.
AttrClusterConnectionString	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrClusterEndpointId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrColdStorageInstanceId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCustomConnectionStrings	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCustomEndpointIds	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterDescription	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbClusterId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbNodeIds	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrOrderId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPrimaryConnectionString	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPrimaryConnectionStrings	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPrimaryEndpointId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPrimaryEndpointIds	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
DbNodeClass	object	No description.
DbType	object	No description.
DbVersion	object	No description.
EnableResourcePropertyConstraint	bool	No description.
PayType	object	No description.
AllowShutDown	object	No description.
Architecture	object	No description.
AutoRenewPeriod	object	No description.
BackupRetentionPolicyOnClusterDeletion	object	No description.
CloneDataPoint	object	No description.
ClusterNetworkType	object	No description.
ColdStorageOption	object	No description.
CreationCategory	object	No description.
CreationOption	object	No description.
DbClusterDescription	object	No description.
DbClusterParameters	object	No description.
DbMinorVersion	object	No description.
DbNodeNum	object	No description.
DefaultTimeZone	object	No description.
DeletionProtection	object	No description.
GdnId	object	No description.
HotStandbyCluster	object	No description.
LoosePolarLogBin	object	No description.
LooseXEngine	object	No description.
LooseXEngineUseMemoryPct	object	No description.
LowerCaseTableNames	object	No description.
MaintainTime	object	No description.
ParameterGroupId	object	No description.
Period	object	No description.
PeriodUnit	object	No description.
ProvisionedIops	object	No description.
ProxyClass	object	No description.
ProxyType	object	No description.
RenewalStatus	object	No description.
ResourceGroupId	object	No description.
RestartMasterNode	object	No description.
ScaleMax	object	No description.
ScaleMin	object	No description.
ScaleRoNumMax	object	No description.
ScaleRoNumMin	object	No description.
SecurityGroupIds	object	No description.
SecurityIpList	object	No description.
ServerlessType	object	No description.
SourceResourceId	object	No description.
StandbyAz	object	No description.
StorageAutoScale	object	No description.
StoragePayType	object	No description.
StorageSpace	object	No description.
StorageType	object	No description.
StorageUpperBound	object	No description.
StrictConsistency	object	No description.
Tags	TagsProperty[]	No description.
TdeStatus	object	No description.
VpcId	object	No description.
VSwitchId	object	No description.
ZoneId	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.

---

AttrClusterConnectionString^Required

public IResolvable AttrClusterConnectionString { get; }

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

---

AttrClusterEndpointId^Required

public IResolvable AttrClusterEndpointId { get; }

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

---

AttrColdStorageInstanceId^Required

public IResolvable AttrColdStorageInstanceId { get; }

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

---

AttrCustomConnectionStrings^Required

public IResolvable AttrCustomConnectionStrings { get; }

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

---

AttrCustomEndpointIds^Required

public IResolvable AttrCustomEndpointIds { get; }

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

---

AttrDbClusterDescription^Required

public IResolvable AttrDbClusterDescription { get; }

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

---

AttrDbClusterId^Required

public IResolvable AttrDbClusterId { get; }

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

---

AttrDbNodeIds^Required

public IResolvable AttrDbNodeIds { get; }

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

---

AttrOrderId^Required

public IResolvable AttrOrderId { get; }

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

---

AttrPrimaryConnectionString^Required

public IResolvable AttrPrimaryConnectionString { get; }

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

---

AttrPrimaryConnectionStrings^Required

public IResolvable AttrPrimaryConnectionStrings { get; }

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

---

AttrPrimaryEndpointId^Required

public IResolvable AttrPrimaryEndpointId { get; }

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

---

AttrPrimaryEndpointIds^Required

public IResolvable AttrPrimaryEndpointIds { get; }

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

---

DbNodeClass^Required

public object DbNodeClass { get; }

• Type: object

---

DbType^Required

public object DbType { get; }

• Type: object

---

DbVersion^Required

public object DbVersion { get; }

• Type: object

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

PayType^Required

public object PayType { get; }

• Type: object

---

AllowShutDown^Optional

public object AllowShutDown { get; }

• Type: object

---

Architecture^Optional

public object Architecture { get; }

• Type: object

---

AutoRenewPeriod^Optional

public object AutoRenewPeriod { get; }

• Type: object

---

BackupRetentionPolicyOnClusterDeletion^Optional

public object BackupRetentionPolicyOnClusterDeletion { get; }

• Type: object

---

CloneDataPoint^Optional

public object CloneDataPoint { get; }

• Type: object

---

ClusterNetworkType^Optional

public object ClusterNetworkType { get; }

• Type: object

---

ColdStorageOption^Optional

public object ColdStorageOption { get; }

• Type: object

---

CreationCategory^Optional

public object CreationCategory { get; }

• Type: object

---

CreationOption^Optional

public object CreationOption { get; }

• Type: object

---

DbClusterDescription^Optional

public object DbClusterDescription { get; }

• Type: object

---

DbClusterParameters^Optional

public object DbClusterParameters { get; }

• Type: object

---

DbMinorVersion^Optional

public object DbMinorVersion { get; }

• Type: object

---

DbNodeNum^Optional

public object DbNodeNum { get; }

• Type: object

---

DefaultTimeZone^Optional

public object DefaultTimeZone { get; }

• Type: object

---

DeletionProtection^Optional

public object DeletionProtection { get; }

• Type: object

---

GdnId^Optional

public object GdnId { get; }

• Type: object

---

HotStandbyCluster^Optional

public object HotStandbyCluster { get; }

• Type: object

---

LoosePolarLogBin^Optional

public object LoosePolarLogBin { get; }

• Type: object

---

LooseXEngine^Optional

public object LooseXEngine { get; }

• Type: object

---

LooseXEngineUseMemoryPct^Optional

public object LooseXEngineUseMemoryPct { get; }

• Type: object

---

LowerCaseTableNames^Optional

public object LowerCaseTableNames { get; }

• Type: object

---

MaintainTime^Optional

public object MaintainTime { get; }

• Type: object

---

ParameterGroupId^Optional

public object ParameterGroupId { get; }

• Type: object

---

Period^Optional

public object Period { get; }

• Type: object

---

PeriodUnit^Optional

public object PeriodUnit { get; }

• Type: object

---

ProvisionedIops^Optional

public object ProvisionedIops { get; }

• Type: object

---

ProxyClass^Optional

public object ProxyClass { get; }

• Type: object

---

ProxyType^Optional

public object ProxyType { get; }

• Type: object

---

RenewalStatus^Optional

public object RenewalStatus { get; }

• Type: object

---

ResourceGroupId^Optional

public object ResourceGroupId { get; }

• Type: object

---

RestartMasterNode^Optional

public object RestartMasterNode { get; }

• Type: object

---

ScaleMax^Optional

public object ScaleMax { get; }

• Type: object

---

ScaleMin^Optional

public object ScaleMin { get; }

• Type: object

---

ScaleRoNumMax^Optional

public object ScaleRoNumMax { get; }

• Type: object

---

ScaleRoNumMin^Optional

public object ScaleRoNumMin { get; }

• Type: object

---

SecurityGroupIds^Optional

public object SecurityGroupIds { get; }

• Type: object

---

SecurityIpList^Optional

public object SecurityIpList { get; }

• Type: object

---

ServerlessType^Optional

public object ServerlessType { get; }

• Type: object

---

SourceResourceId^Optional

public object SourceResourceId { get; }

• Type: object

---

StandbyAz^Optional

public object StandbyAz { get; }

• Type: object

---

StorageAutoScale^Optional

public object StorageAutoScale { get; }

• Type: object

---

StoragePayType^Optional

public object StoragePayType { get; }

• Type: object

---

StorageSpace^Optional

public object StorageSpace { get; }

• Type: object

---

StorageType^Optional

public object StorageType { get; }

• Type: object

---

StorageUpperBound^Optional

public object StorageUpperBound { get; }

• Type: object

---

StrictConsistency^Optional

public object StrictConsistency { get; }

• Type: object

---

Tags^Optional

public TagsProperty[] Tags { get; }

• Type: TagsProperty[]

---

TdeStatus^Optional

public object TdeStatus { get; }

• Type: object

---

VpcId^Optional

public object VpcId { get; }

• Type: object

---

VSwitchId^Optional

public object VSwitchId { get; }

• Type: object

---

ZoneId^Optional

public object ZoneId { 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.

---