Skip to content

ConnectionProps

Properties for defining a Connection.

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

Initializer 

import ros_cdk_rds
ros_cdk_rds.ConnectionProps(
  db_instance_id: typing.Union[str, IResolvable],
  port: typing.Union[typing.Union[int, float], IResolvable],
  babelfish_port: typing.Union[str, IResolvable] = None,
  connection_string_prefix: typing.Union[str, IResolvable] = None,
  general_group_name: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: RDS instance ID.
port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property port: The port of the database service.
babelfish_port typing.Union[str, ros_cdk_core.IResolvable] Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.
connection_string_prefix typing.Union[str, ros_cdk_core.IResolvable] Property connectionStringPrefix: The prefix of the endpoint.
general_group_name typing.Union[str, ros_cdk_core.IResolvable] Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

db_instance_idRequired 

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

Property dbInstanceId: RDS instance ID.

portRequired 

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

Property port: The port of the database service.

babelfish_portOptional 

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

Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.

Note This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.

connection_string_prefixOptional 

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

Property connectionStringPrefix: The prefix of the endpoint.

Only the prefix of the CurrentConnectionString parameter value can be modified. The prefix must be 5 to 40 characters in length and can contain letters, digits, and hyphens (-).

general_group_nameOptional 

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

Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

This parameter takes effect only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.