DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.

Initializers

import { DBCluster } from '@alicloud/ros-cdk-polardb'
new DBCluster(scope: Construct, id: string, props: DBClusterProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	DBClusterProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: DBClusterProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import { DBCluster } from '@alicloud/ros-cdk-polardb'
DBCluster.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrClusterConnectionString	@alicloud/ros-cdk-core.IResolvable	Attribute ClusterConnectionString: The cluster connection string of the db cluster.
attrClusterEndpointId	@alicloud/ros-cdk-core.IResolvable	Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
attrColdStorageInstanceId	@alicloud/ros-cdk-core.IResolvable	Attribute ColdStorageInstanceId: The ID of the cold storage instance.
attrCustomConnectionStrings	@alicloud/ros-cdk-core.IResolvable	Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
attrCustomEndpointIds	@alicloud/ros-cdk-core.IResolvable	Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
attrDbClusterDescription	@alicloud/ros-cdk-core.IResolvable	Attribute DBClusterDescription: The description of the db cluster.
attrDbClusterId	@alicloud/ros-cdk-core.IResolvable	Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
attrDbNodeIds	@alicloud/ros-cdk-core.IResolvable	Attribute DBNodeIds: The ID list of cluster nodes.
attrOrderId	@alicloud/ros-cdk-core.IResolvable	Attribute OrderId: The Order ID.
attrPrimaryConnectionString	@alicloud/ros-cdk-core.IResolvable	Attribute PrimaryConnectionString: The primary connection string of the db cluster.
attrPrimaryConnectionStrings	@alicloud/ros-cdk-core.IResolvable	Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
attrPrimaryEndpointId	@alicloud/ros-cdk-core.IResolvable	Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
attrPrimaryEndpointIds	@alicloud/ros-cdk-core.IResolvable	Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrClusterConnectionString^Required

public readonly attrClusterConnectionString: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClusterConnectionString: The cluster connection string of the db cluster.

---

attrClusterEndpointId^Required

public readonly attrClusterEndpointId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.

---

attrColdStorageInstanceId^Required

public readonly attrColdStorageInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ColdStorageInstanceId: The ID of the cold storage instance.

---

attrCustomConnectionStrings^Required

public readonly attrCustomConnectionStrings: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute CustomConnectionStrings: The custom connection strings of the db cluster.

---

attrCustomEndpointIds^Required

public readonly attrCustomEndpointIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.

---

attrDbClusterDescription^Required

public readonly attrDbClusterDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterDescription: The description of the db cluster.

---

attrDbClusterId^Required

public readonly attrDbClusterId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.

---

attrDbNodeIds^Required

public readonly attrDbNodeIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBNodeIds: The ID list of cluster nodes.

---

attrOrderId^Required

public readonly attrOrderId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: The Order ID.

---

attrPrimaryConnectionString^Required

public readonly attrPrimaryConnectionString: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryConnectionString: The primary connection string of the db cluster.

---

attrPrimaryConnectionStrings^Required

public readonly attrPrimaryConnectionStrings: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.

---

attrPrimaryEndpointId^Required

public readonly attrPrimaryEndpointId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.

---

attrPrimaryEndpointIds^Required

public readonly attrPrimaryEndpointIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.

---