Skip to content

ConnectionProps

Properties for defining a Connection.

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

Initializer 

import com.aliyun.ros.cdk.rds.ConnectionProps;
ConnectionProps.builder()
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
//  .babelfishPort(java.lang.String)
//  .babelfishPort(IResolvable)
//  .connectionStringPrefix(java.lang.String)
//  .connectionStringPrefix(IResolvable)
//  .generalGroupName(java.lang.String)
//  .generalGroupName(IResolvable)
    .build();

Properties

Name Type Description
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: RDS instance ID.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property port: The port of the database service.
babelfishPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionStringPrefix: The prefix of the endpoint.
generalGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

dbInstanceIdRequired 

public java.lang.Object getDbInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceId: RDS instance ID.

portRequired 

public java.lang.Object getPort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property port: The port of the database service.

babelfishPortOptional 

public java.lang.Object getBabelfishPort();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getConnectionStringPrefix();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getGeneralGroupName();
  • Type: java.lang.String OR com.aliyun.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.