DBClusterEndpoint

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

Initializers

import ros_cdk_polardb
ros_cdk_polardb.DBClusterEndpoint(
  scope: Construct,
  id: str,
  db_cluster_id: typing.Union[str, IResolvable],
  auto_add_new_nodes: typing.Union[str, IResolvable] = None,
  endpoint_config: typing.Union[IResolvable, EndpointConfigProperty] = None,
  endpoint_type: typing.Union[str, IResolvable] = None,
  nodes: typing.Union[typing.List[typing.Any], IResolvable] = None,
  read_write_mode: 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.
db_cluster_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a custom connection point is to be created.
auto_add_new_nodes	typing.Union[str, ros_cdk_core.IResolvable]	Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.
endpoint_config	typing.Union[ros_cdk_core.IResolvable, EndpointConfigProperty]	Property endpointConfig:.
endpoint_type	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointType: The type of the cluster connection point.
nodes	typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]	Property nodes: The nodes to be added to this connection point to process read requests from this connection point.
read_write_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property readWriteMode: The read\/write mode of the cluster connection point.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

db_cluster_id^Required

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

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a custom connection point is to be created.

---

auto_add_new_nodes^Optional

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

Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.

Valid values: Enable, Disable. Default value: Disable.

---

endpoint_config^Optional

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

Property endpointConfig:.

---

endpoint_type^Optional

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

Property endpointType: The type of the cluster connection point.

Set this parameter to Custom.

---

nodes^Optional

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

Property nodes: The nodes to be added to this connection point to process read requests from this connection point.

Add at least two nodes. If you do not specify this parameter, all nodes of the cluster are added to this connection point by default.

---

read_write_mode^Optional

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

Property readWriteMode: The read\/write mode of the cluster connection point.

Valid values: ReadWrite: receives and forwards read and write requests (automatic read-write splitting). ReadOnly: receives and forwards only read requests. Default value: ReadOnly.

---

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.DBClusterEndpoint.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_addresses	ros_cdk_core.IResolvable	Attribute Addresses: The address items of the db cluster endpoint.
attr_connection_string	ros_cdk_core.IResolvable	Attribute ConnectionString: The first connection string of the db cluster endpoint.
attr_db_endpoint_id	ros_cdk_core.IResolvable	Attribute DBEndpointId: DB cluster endpoint ID.

---

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_addresses^Required

attr_addresses: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Addresses: The address items of the db cluster endpoint.

---

attr_connection_string^Required

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ConnectionString: The first connection string of the db cluster endpoint.

---

attr_db_endpoint_id^Required

attr_db_endpoint_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBEndpointId: DB cluster endpoint ID.

E.g. pe-xxxxxxxx.

---