Skip to content

DBProxyProps

Properties for defining a DBProxy.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rds-dbproxy

Initializer 

import { DBProxyProps } from '@alicloud/ros-cdk-rds'
const dBProxyProps: DBProxyProps = { ... }

Properties

Name Type Description
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: Instance ID of the DB.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC ID to which the instance belongs.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The virtual switch ID to which the instance belongs.
dbProxyInstanceNum number | @alicloud/ros-cdk-core.IResolvable Property dbProxyInstanceNum: The number of activated proxy instances, the value is: 1~16.Default value: 1. Description More proxy instances can handle more requests, you can understand the load of proxy instances based on the monitoring data, and then set a reasonable number of proxy instances.
dbProxyInstanceType string | @alicloud/ros-cdk-core.IResolvable Property dbProxyInstanceType: Database proxy instance type, value: common: general-purpose agent exclusive: exclusive proxy (default).
dbProxyNodes @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBProxyNodesProperty[] Property dbProxyNodes: List of proxy nodes.
persistentConnectionStatus string | @alicloud/ros-cdk-core.IResolvable Property persistentConnectionStatus: Whether to enable connection hold.Value: Enabled: Turn on connection hold Disabled: Close connection hold illustrate Only RDS MySQL supports this parameter. When modifying the connection remains, the ConfigDBProxyService value is Modify.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource Group ID.

dbInstanceIdRequired 

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

Property dbInstanceId: Instance ID of the DB.

DescribeDBInstances can be called to get it.

vpcIdRequired 

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

Property vpcId: The VPC ID to which the instance belongs.

vSwitchIdRequired 

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

Property vSwitchId: The virtual switch ID to which the instance belongs.

dbProxyInstanceNumOptional 

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

Property dbProxyInstanceNum: The number of activated proxy instances, the value is: 1~16.Default value: 1. Description More proxy instances can handle more requests, you can understand the load of proxy instances based on the monitoring data, and then set a reasonable number of proxy instances.

dbProxyInstanceTypeOptional 

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

Property dbProxyInstanceType: Database proxy instance type, value: common: general-purpose agent exclusive: exclusive proxy (default).

dbProxyNodesOptional 

public readonly dbProxyNodes: IResolvable | IResolvable | DBProxyNodesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBProxyNodesProperty[]

Property dbProxyNodes: List of proxy nodes.

persistentConnectionStatusOptional 

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

Property persistentConnectionStatus: Whether to enable connection hold.Value: Enabled: Turn on connection hold Disabled: Close connection hold illustrate Only RDS MySQL supports this parameter. When modifying the connection remains, the ConfigDBProxyService value is Modify.

resourceGroupIdOptional 

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

Property resourceGroupId: Resource Group ID.