DBInstances

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::DBInstances, which is used to query ApsaraDB RDS instances.

Initializers

from ros_cdk_rds import datasource
datasource.DBInstances(
  scope: Construct,
  id: str,
  connection_mode: typing.Union[str, IResolvable] = None,
  connection_string: typing.Union[str, IResolvable] = None,
  db_instance_class: typing.Union[str, IResolvable] = None,
  db_instance_id: typing.Union[str, IResolvable] = None,
  db_instance_status: typing.Union[str, IResolvable] = None,
  db_instance_type: typing.Union[str, IResolvable] = None,
  dedicated_host_group_id: typing.Union[str, IResolvable] = None,
  dedicated_host_id: typing.Union[str, IResolvable] = None,
  engine: typing.Union[str, IResolvable] = None,
  engine_version: typing.Union[str, IResolvable] = None,
  expired: typing.Union[str, IResolvable] = None,
  instance_level: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_network_type: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  proxy_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  search_key: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: 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.
connection_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property connectionMode: The connection mode of the instance.
connection_string	typing.Union[str, ros_cdk_core.IResolvable]	Property connectionString: The endpoint of the instance.
db_instance_class	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstanceClass: The instance type of the instances.
db_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstanceId: The ID of the instance.
db_instance_status	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstanceStatus: The status of the instances.
db_instance_type	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstanceType: The role of the instances.
dedicated_host_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dedicatedHostGroupId: The ID of the dedicated cluster to which the instances belong.
dedicated_host_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dedicatedHostId: The ID of the host to which the instances belong in the specified dedicated cluster.
engine	typing.Union[str, ros_cdk_core.IResolvable]	Property engine: The database engine that is run by the instances.
engine_version	typing.Union[str, ros_cdk_core.IResolvable]	Property engineVersion: The version of the database engine that is run by the instances.
expired	typing.Union[str, ros_cdk_core.IResolvable]	Property expired: Specifies whether the instances have expired.
instance_level	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property instanceLevel: Specifies whether to return the RDS editions of the instances by using the Category parameter.
instance_network_type	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceNetworkType: The network type of the instances.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	Property payType: The billing method of the instances.
proxy_id	typing.Union[str, ros_cdk_core.IResolvable]	Property proxyId: The ID of the proxy mode.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group to which the instances belong.
search_key	typing.Union[str, ros_cdk_core.IResolvable]	Property searchKey: The keywords that are contained in the IDs or descriptions of the instances.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vpcId: The ID of the virtual private cloud (VPC) to which the instances belong.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vSwitchId: The ID of the vSwitch that is associated with the specified VPC.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: The ID of the zone to which the instances belong.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

connection_mode^Optional

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

Property connectionMode: The connection mode of the instance.

---

connection_string^Optional

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

Property connectionString: The endpoint of the instance.

---

db_instance_class^Optional

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

Property dbInstanceClass: The instance type of the instances.

---

db_instance_id^Optional

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

Property dbInstanceId: The ID of the instance.

---

db_instance_status^Optional

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

Property dbInstanceStatus: The status of the instances.

---

db_instance_type^Optional

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

Property dbInstanceType: The role of the instances.

---

dedicated_host_group_id^Optional

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

Property dedicatedHostGroupId: The ID of the dedicated cluster to which the instances belong.

---

dedicated_host_id^Optional

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

Property dedicatedHostId: The ID of the host to which the instances belong in the specified dedicated cluster.

---

engine^Optional

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

Property engine: The database engine that is run by the instances.

---

engine_version^Optional

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

Property engineVersion: The version of the database engine that is run by the instances.

---

expired^Optional

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

Property expired: Specifies whether the instances have expired.

---

instance_level^Optional

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

Property instanceLevel: Specifies whether to return the RDS editions of the instances by using the Category parameter.

---

instance_network_type^Optional

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

Property instanceNetworkType: The network type of the instances.

---

pay_type^Optional

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

Property payType: The billing method of the instances.

---

proxy_id^Optional

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

Property proxyId: The ID of the proxy mode.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which the instances belong.

---

search_key^Optional

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

Property searchKey: The keywords that are contained in the IDs or descriptions of the instances.

---

vpc_id^Optional

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

Property vpcId: The ID of the virtual private cloud (VPC) to which the instances belong.

---

v_switch_id^Optional

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

Property vSwitchId: The ID of the vSwitch that is associated with the specified VPC.

---

zone_id^Optional

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

Property zoneId: The ID of the zone to which the instances belong.

---

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

from ros_cdk_rds import datasource
datasource.DBInstances.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_db_instance_ids	ros_cdk_core.IResolvable	Attribute DBInstanceIds: The list of The RDS Database instance Ids.
attr_db_instances	ros_cdk_core.IResolvable	Attribute DBInstances: The list of The RDS Database instances.

---

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_db_instance_ids^Required

attr_db_instance_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBInstanceIds: The list of The RDS Database instance Ids.

---

attr_db_instances^Required

attr_db_instances: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBInstances: The list of The RDS Database instances.

---