Skip to content

DBClusterEndpointProps

Properties for defining a DBClusterEndpoint.

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

Initializer 

import { DBClusterEndpointProps } from '@alicloud/ros-cdk-polardb'
const dBClusterEndpointProps: DBClusterEndpointProps = { ... }

Properties

Name Type Description
dbClusterId string | @alicloud/ros-cdk-core.IResolvable Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a custom connection point is to be created.
autoAddNewNodes string | @alicloud/ros-cdk-core.IResolvable Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.
endpointConfig @alicloud/ros-cdk-core.IResolvable | EndpointConfigProperty Property endpointConfig:.
endpointType string | @alicloud/ros-cdk-core.IResolvable Property endpointType: The type of the cluster connection point.
nodes any[] | @alicloud/ros-cdk-core.IResolvable Property nodes: The nodes to be added to this connection point to process read requests from this connection point.
readWriteMode string | @alicloud/ros-cdk-core.IResolvable Property readWriteMode: The read\/write mode of the cluster connection point.

dbClusterIdRequired 

public readonly dbClusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

autoAddNewNodesOptional 

public readonly autoAddNewNodes: string | IResolvable;
  • Type: string | @alicloud/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.

endpointConfigOptional 

public readonly endpointConfig: IResolvable | EndpointConfigProperty;

Property endpointConfig:.

endpointTypeOptional 

public readonly endpointType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpointType: The type of the cluster connection point.

Set this parameter to Custom.

nodesOptional 

public readonly nodes: any[] | IResolvable;
  • Type: any[] | @alicloud/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.

readWriteModeOptional 

public readonly readWriteMode: string | IResolvable;
  • Type: string | @alicloud/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.