RosDBCluster

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkpolardb"
alicloudroscdkpolardb.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/alicloudroscdkpolardb"
alicloudroscdkpolardb.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/alicloudroscdkpolardb"
alicloudroscdkpolardb.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/alicloudroscdkpolardb"
alicloudroscdkpolardb.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.
AttrClusterConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrClusterEndpointId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrColdStorageInstanceId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrCustomConnectionStrings	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrCustomEndpointIds	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterDescription	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbClusterId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrDbNodeIds	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrOrderId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPrimaryConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPrimaryConnectionStrings	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPrimaryEndpointId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPrimaryEndpointIds	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
DbNodeClass	interface{}	No description.
DbType	interface{}	No description.
DbVersion	interface{}	No description.
EnableResourcePropertyConstraint	*bool	No description.
PayType	interface{}	No description.
AllowShutDown	interface{}	No description.
Architecture	interface{}	No description.
AutoRenewPeriod	interface{}	No description.
BackupRetentionPolicyOnClusterDeletion	interface{}	No description.
CloneDataPoint	interface{}	No description.
ClusterNetworkType	interface{}	No description.
ColdStorageOption	interface{}	No description.
CreationCategory	interface{}	No description.
CreationOption	interface{}	No description.
DbClusterDescription	interface{}	No description.
DbClusterParameters	interface{}	No description.
DbMinorVersion	interface{}	No description.
DbNodeNum	interface{}	No description.
DefaultTimeZone	interface{}	No description.
DeletionProtection	interface{}	No description.
GdnId	interface{}	No description.
HotStandbyCluster	interface{}	No description.
LoosePolarLogBin	interface{}	No description.
LooseXEngine	interface{}	No description.
LooseXEngineUseMemoryPct	interface{}	No description.
LowerCaseTableNames	interface{}	No description.
MaintainTime	interface{}	No description.
ParameterGroupId	interface{}	No description.
Period	interface{}	No description.
PeriodUnit	interface{}	No description.
ProvisionedIops	interface{}	No description.
ProxyClass	interface{}	No description.
ProxyType	interface{}	No description.
RenewalStatus	interface{}	No description.
ResourceGroupId	interface{}	No description.
RestartMasterNode	interface{}	No description.
ScaleMax	interface{}	No description.
ScaleMin	interface{}	No description.
ScaleRoNumMax	interface{}	No description.
ScaleRoNumMin	interface{}	No description.
SecurityGroupIds	interface{}	No description.
SecurityIpList	interface{}	No description.
ServerlessType	interface{}	No description.
SourceResourceId	interface{}	No description.
StandbyAz	interface{}	No description.
StorageAutoScale	interface{}	No description.
StoragePayType	interface{}	No description.
StorageSpace	interface{}	No description.
StorageType	interface{}	No description.
StorageUpperBound	interface{}	No description.
StrictConsistency	interface{}	No description.
Tags	*[]TagsProperty	No description.
TdeStatus	interface{}	No description.
VpcId	interface{}	No description.
VSwitchId	interface{}	No description.
ZoneId	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.

---

AttrClusterConnectionString^Required

func AttrClusterConnectionString() IResolvable

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

---

AttrClusterEndpointId^Required

func AttrClusterEndpointId() IResolvable

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

---

AttrColdStorageInstanceId^Required

func AttrColdStorageInstanceId() IResolvable

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

---

AttrCustomConnectionStrings^Required

func AttrCustomConnectionStrings() IResolvable

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

---

AttrCustomEndpointIds^Required

func AttrCustomEndpointIds() IResolvable

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

---

AttrDbClusterDescription^Required

func AttrDbClusterDescription() IResolvable

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

---

AttrDbClusterId^Required

func AttrDbClusterId() IResolvable

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

---

AttrDbNodeIds^Required

func AttrDbNodeIds() IResolvable

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

---

AttrOrderId^Required

func AttrOrderId() IResolvable

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

---

AttrPrimaryConnectionString^Required

func AttrPrimaryConnectionString() IResolvable

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

---

AttrPrimaryConnectionStrings^Required

func AttrPrimaryConnectionStrings() IResolvable

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

---

AttrPrimaryEndpointId^Required

func AttrPrimaryEndpointId() IResolvable

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

---

AttrPrimaryEndpointIds^Required

func AttrPrimaryEndpointIds() IResolvable

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

---

DbNodeClass^Required

func DbNodeClass() interface{}

• Type: interface{}

---

DbType^Required

func DbType() interface{}

• Type: interface{}

---

DbVersion^Required

func DbVersion() interface{}

• Type: interface{}

---

EnableResourcePropertyConstraint^Required

func EnableResourcePropertyConstraint() *bool

• Type: *bool

---

PayType^Required

func PayType() interface{}

• Type: interface{}

---

AllowShutDown^Optional

func AllowShutDown() interface{}

• Type: interface{}

---

Architecture^Optional

func Architecture() interface{}

• Type: interface{}

---

AutoRenewPeriod^Optional

func AutoRenewPeriod() interface{}

• Type: interface{}

---

BackupRetentionPolicyOnClusterDeletion^Optional

func BackupRetentionPolicyOnClusterDeletion() interface{}

• Type: interface{}

---

CloneDataPoint^Optional

func CloneDataPoint() interface{}

• Type: interface{}

---

ClusterNetworkType^Optional

func ClusterNetworkType() interface{}

• Type: interface{}

---

ColdStorageOption^Optional

func ColdStorageOption() interface{}

• Type: interface{}

---

CreationCategory^Optional

func CreationCategory() interface{}

• Type: interface{}

---

CreationOption^Optional

func CreationOption() interface{}

• Type: interface{}

---

DbClusterDescription^Optional

func DbClusterDescription() interface{}

• Type: interface{}

---

DbClusterParameters^Optional

func DbClusterParameters() interface{}

• Type: interface{}

---

DbMinorVersion^Optional

func DbMinorVersion() interface{}

• Type: interface{}

---

DbNodeNum^Optional

func DbNodeNum() interface{}

• Type: interface{}

---

DefaultTimeZone^Optional

func DefaultTimeZone() interface{}

• Type: interface{}

---

DeletionProtection^Optional

func DeletionProtection() interface{}

• Type: interface{}

---

GdnId^Optional

func GdnId() interface{}

• Type: interface{}

---

HotStandbyCluster^Optional

func HotStandbyCluster() interface{}

• Type: interface{}

---

LoosePolarLogBin^Optional

func LoosePolarLogBin() interface{}

• Type: interface{}

---

LooseXEngine^Optional

func LooseXEngine() interface{}

• Type: interface{}

---

LooseXEngineUseMemoryPct^Optional

func LooseXEngineUseMemoryPct() interface{}

• Type: interface{}

---

LowerCaseTableNames^Optional

func LowerCaseTableNames() interface{}

• Type: interface{}

---

MaintainTime^Optional

func MaintainTime() interface{}

• Type: interface{}

---

ParameterGroupId^Optional

func ParameterGroupId() interface{}

• Type: interface{}

---

Period^Optional

func Period() interface{}

• Type: interface{}

---

PeriodUnit^Optional

func PeriodUnit() interface{}

• Type: interface{}

---

ProvisionedIops^Optional

func ProvisionedIops() interface{}

• Type: interface{}

---

ProxyClass^Optional

func ProxyClass() interface{}

• Type: interface{}

---

ProxyType^Optional

func ProxyType() interface{}

• Type: interface{}

---

RenewalStatus^Optional

func RenewalStatus() interface{}

• Type: interface{}

---

ResourceGroupId^Optional

func ResourceGroupId() interface{}

• Type: interface{}

---

RestartMasterNode^Optional

func RestartMasterNode() interface{}

• Type: interface{}

---

ScaleMax^Optional

func ScaleMax() interface{}

• Type: interface{}

---

ScaleMin^Optional

func ScaleMin() interface{}

• Type: interface{}

---

ScaleRoNumMax^Optional

func ScaleRoNumMax() interface{}

• Type: interface{}

---

ScaleRoNumMin^Optional

func ScaleRoNumMin() interface{}

• Type: interface{}

---

SecurityGroupIds^Optional

func SecurityGroupIds() interface{}

• Type: interface{}

---

SecurityIpList^Optional

func SecurityIpList() interface{}

• Type: interface{}

---

ServerlessType^Optional

func ServerlessType() interface{}

• Type: interface{}

---

SourceResourceId^Optional

func SourceResourceId() interface{}

• Type: interface{}

---

StandbyAz^Optional

func StandbyAz() interface{}

• Type: interface{}

---

StorageAutoScale^Optional

func StorageAutoScale() interface{}

• Type: interface{}

---

StoragePayType^Optional

func StoragePayType() interface{}

• Type: interface{}

---

StorageSpace^Optional

func StorageSpace() interface{}

• Type: interface{}

---

StorageType^Optional

func StorageType() interface{}

• Type: interface{}

---

StorageUpperBound^Optional

func StorageUpperBound() interface{}

• Type: interface{}

---

StrictConsistency^Optional

func StrictConsistency() interface{}

• Type: interface{}

---

Tags^Optional

func Tags() *[]TagsProperty

• Type: *[]TagsProperty

---

TdeStatus^Optional

func TdeStatus() interface{}

• Type: interface{}

---

VpcId^Optional

func VpcId() interface{}

• Type: interface{}

---

VSwitchId^Optional

func VSwitchId() interface{}

• Type: interface{}

---

ZoneId^Optional

func ZoneId() 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.

---