Skip to content

ConnectionProps

Properties for defining a Connection.

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

Initializer 

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

Properties

Name Type Description
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: RDS instance ID.
port number | @alicloud/ros-cdk-core.IResolvable Property port: The port of the database service.
babelfishPort string | @alicloud/ros-cdk-core.IResolvable Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.
connectionStringPrefix string | @alicloud/ros-cdk-core.IResolvable Property connectionStringPrefix: The prefix of the endpoint.
generalGroupName string | @alicloud/ros-cdk-core.IResolvable Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

dbInstanceIdRequired 

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

Property dbInstanceId: RDS instance ID.

portRequired 

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

Property port: The port of the database service.

babelfishPortOptional 

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

connectionStringPrefixOptional 

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

generalGroupNameOptional 

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