DBNodes

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

Initializers

import ros_cdk_polardb
ros_cdk_polardb.DBNodes(
  scope: Construct,
  id: str,
  amount: typing.Union[typing.Union[int, float], IResolvable],
  db_cluster_id: typing.Union[str, IResolvable],
  db_node_type: typing.Union[str, IResolvable] = None,
  endpoint_bind_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  imci_switch: typing.Union[str, IResolvable] = None,
  planned_end_time: typing.Union[str, IResolvable] = None,
  planned_start_time: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
amount	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property amount: Number of nodes to be added to cluster.
db_cluster_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster to be added nodes to.
db_node_type	typing.Union[str, ros_cdk_core.IResolvable]	Property dbNodeType: Node type.
endpoint_bind_list	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property endpointBindList: Address IDs that specifies the cluster connection address to which the new node should join.
imci_switch	typing.Union[str, ros_cdk_core.IResolvable]	Property imciSwitch: Specifies whether to enable the In-Memory Column Index (IMCI) feature.
planned_end_time	typing.Union[str, ros_cdk_core.IResolvable]	Property plannedEndTime: The latest time at which a new node task can be added to start executing a timed (that is, within the target time period).
planned_start_time	typing.Union[str, ros_cdk_core.IResolvable]	Property plannedStartTime: The earliest time at which a new node task can be added to start executing a timed (that is, within the target time period).
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

amount^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property amount: Number of nodes to be added to cluster.

---

db_cluster_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster to be added nodes to.

---

db_node_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbNodeType: Node type.

Ranges: RO|STANDBY|DLNode|RW

---

endpoint_bind_list^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property endpointBindList: Address IDs that specifies the cluster connection address to which the new node should join.

---

imci_switch^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imciSwitch: Specifies whether to enable the In-Memory Column Index (IMCI) feature.

---

planned_end_time^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property plannedEndTime: The latest time at which a new node task can be added to start executing a timed (that is, within the target time period).

The format is YYYY-MM-DDThh:mm:ssZ (UTC).

---

planned_start_time^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property plannedStartTime: The earliest time at which a new node task can be added to start executing a timed (that is, within the target time period).

The format is YYYY-MM-DDThh:mm:ssZ (UTC).

---

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: Resource group id.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_polardb
ros_cdk_polardb.DBNodes.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_db_node_ids	ros_cdk_core.IResolvable	Attribute DBNodeIds: The ID list of added cluster nodes.
attr_order_ids	ros_cdk_core.IResolvable	Attribute OrderIds: The order ID list of added cluster nodes.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_db_node_ids^Required

attr_db_node_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBNodeIds: The ID list of added cluster nodes.

---

attr_order_ids^Required

attr_order_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OrderIds: The order ID list of added cluster nodes.

---