Connection

This class encapsulates and extends the ROS resource type ALIYUN::RDS::Connection, which is used to apply for a public endpoint.

Initializers

import ros_cdk_rds
ros_cdk_rds.Connection(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

db_instance_id^Required

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

Property dbInstanceId: RDS instance ID.

---

port^Required

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

Property port: The port of the database service.

---

babelfish_port^Optional

• 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_prefix^Optional

• 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_name^Optional

• 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_rds
ros_cdk_rds.Connection.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_babelfish_port	ros_cdk_core.IResolvable	Attribute BabelfishPort: The name of the dedicated cluster to which the instance belongs.
attr_connection_string	ros_cdk_core.IResolvable	Attribute ConnectionString: Connection string.
attr_db_instance_id	ros_cdk_core.IResolvable	Attribute DBInstanceId: RDS instance ID.
attr_port	ros_cdk_core.IResolvable	Attribute Port: The port of the database service.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_babelfish_port^Required

attr_babelfish_port: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BabelfishPort: The name of the dedicated cluster to which the instance belongs.

---

attr_connection_string^Required

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ConnectionString: Connection string.

---

attr_db_instance_id^Required

attr_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBInstanceId: RDS instance ID.

---

attr_port^Required

attr_port: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Port: The port of the database service.

---