Skip to content

DBClusterEndpointProps

Properties for defining a DBClusterEndpoint.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusterendpoint

Initializer

import ros_cdk_polardb
ros_cdk_polardb.DBClusterEndpointProps(
  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
)

Properties

Name Type 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.

db_cluster_idRequired

db_cluster_id: typing.Union[str, IResolvable]
  • 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_nodesOptional

auto_add_new_nodes: typing.Union[str, IResolvable]
  • 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_configOptional

endpoint_config: typing.Union[IResolvable, EndpointConfigProperty]

Property endpointConfig:.


endpoint_typeOptional

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

Property endpointType: The type of the cluster connection point.

Set this parameter to Custom.


nodesOptional

nodes: typing.Union[typing.List[typing.Any], IResolvable]
  • 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_modeOptional

read_write_mode: typing.Union[str, IResolvable]
  • 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.