RosDBInstance

This class is a base encapsulation around the ROS resource type DATASOURCE::RDS::DBInstance, which is used to query an ApsaraDB RDS instance.

Initializers

from ros_cdk_rds import datasource
datasource.RosDBInstance(
  scope: Construct,
  id: str,
  db_instance_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool
)

Name	Type	Description
scope	ros_cdk_core.Construct	- scope in which this resource is defined.
id	str	- scoped id of the resource.
db_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	No description.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

---

id^Required

• Type: str

scoped id of the resource.

---

db_instance_id^Optional

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

---

refresh_options^Optional

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

---

enable_resource_property_constraint^Required

• 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.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
add_condition	No description.
add_count	No description.
add_deletion_override	Syntactic sugar for addOverride(path, undefined).
add_depends_on	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
add_desc	No description.
add_meta_data	No description.
add_override	Adds an override to the synthesized ROS resource.
add_property_deletion_override	Adds an override that deletes the value of a property from the resource definition.
add_property_override	Adds an override to a resource property.
add_ros_dependency	No description.
apply_removal_policy	Sets the deletion policy of the resource based on the removal policy specified.
get_att	Returns a token for an runtime attribute of this resource.

---

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.

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

add_condition

def add_condition(
  con: RosCondition
) -> None

con^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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

---

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

---

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

add_meta_data

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

---

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

---

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

---

value^Required

• Type: typing.Any

The value.

---

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

apply_to_update_replace_policy^Optional

• Type: bool

---

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.
is_ros_element	Returns true if a construct is a stack element (i.e. part of the synthesized template).
is_ros_resource	Check whether the given construct is a RosResource.

---

is_construct

from ros_cdk_rds import datasource
datasource.RosDBInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

from ros_cdk_rds import datasource
datasource.RosDBInstance.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

---

is_ros_resource

from ros_cdk_rds import datasource
datasource.RosDBInstance.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
creation_stack	typing.List[str]	No description.
logical_id	str	The logical ID for this stack element.
stack	ros_cdk_core.Stack	The stack in which this element is defined.
ref	str	Return a string that will be resolved to a RosTemplate { Ref } for this element.
ros_options	ros_cdk_core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
ros_resource_type	str	ROS resource type.
attr_account_max_quantity	ros_cdk_core.IResolvable	No description.
attr_advanced_features	ros_cdk_core.IResolvable	No description.
attr_auto_upgrade_minor_version	ros_cdk_core.IResolvable	No description.
attr_availability_value	ros_cdk_core.IResolvable	No description.
attr_babelfish_config	ros_cdk_core.IResolvable	No description.
attr_category	ros_cdk_core.IResolvable	No description.
attr_collation	ros_cdk_core.IResolvable	No description.
attr_connection_mode	ros_cdk_core.IResolvable	No description.
attr_connection_string	ros_cdk_core.IResolvable	No description.
attr_console_version	ros_cdk_core.IResolvable	No description.
attr_creation_time	ros_cdk_core.IResolvable	No description.
attr_current_kernel_version	ros_cdk_core.IResolvable	No description.
attr_db_cluster_nodes	ros_cdk_core.IResolvable	No description.
attr_db_instance_class	ros_cdk_core.IResolvable	No description.
attr_db_instance_class_type	ros_cdk_core.IResolvable	No description.
attr_db_instance_cpu	ros_cdk_core.IResolvable	No description.
attr_db_instance_description	ros_cdk_core.IResolvable	No description.
attr_db_instance_disk_used	ros_cdk_core.IResolvable	No description.
attr_db_instance_id	ros_cdk_core.IResolvable	No description.
attr_db_instance_memory	ros_cdk_core.IResolvable	No description.
attr_db_instance_net_type	ros_cdk_core.IResolvable	No description.
attr_db_instance_status	ros_cdk_core.IResolvable	No description.
attr_db_instance_storage	ros_cdk_core.IResolvable	No description.
attr_db_instance_storage_type	ros_cdk_core.IResolvable	No description.
attr_db_instance_type	ros_cdk_core.IResolvable	No description.
attr_db_max_quantity	ros_cdk_core.IResolvable	No description.
attr_dedicated_host_group_id	ros_cdk_core.IResolvable	No description.
attr_deletion_protection	ros_cdk_core.IResolvable	No description.
attr_engine	ros_cdk_core.IResolvable	No description.
attr_engine_version	ros_cdk_core.IResolvable	No description.
attr_expire_time	ros_cdk_core.IResolvable	No description.
attr_extra	ros_cdk_core.IResolvable	No description.
attr_general_group_name	ros_cdk_core.IResolvable	No description.
attr_guard_db_instance_id	ros_cdk_core.IResolvable	No description.
attr_increment_source_db_instance_id	ros_cdk_core.IResolvable	No description.
attr_instance_network_type	ros_cdk_core.IResolvable	No description.
attr_instruction_set_arch	ros_cdk_core.IResolvable	No description.
attr_ip_type	ros_cdk_core.IResolvable	No description.
attr_latest_kernel_version	ros_cdk_core.IResolvable	No description.
attr_lock_mode	ros_cdk_core.IResolvable	No description.
attr_lock_reason	ros_cdk_core.IResolvable	No description.
attr_maintain_time	ros_cdk_core.IResolvable	No description.
attr_master_instance_id	ros_cdk_core.IResolvable	No description.
attr_master_zone	ros_cdk_core.IResolvable	No description.
attr_max_connections	ros_cdk_core.IResolvable	No description.
attr_max_iombps	ros_cdk_core.IResolvable	No description.
attr_max_iops	ros_cdk_core.IResolvable	No description.
attr_pay_type	ros_cdk_core.IResolvable	No description.
attr_pg_bouncer_enabled	ros_cdk_core.IResolvable	No description.
attr_port	ros_cdk_core.IResolvable	No description.
attr_proxy_type	ros_cdk_core.IResolvable	No description.
attr_read_only_db_instance_ids	ros_cdk_core.IResolvable	No description.
attr_readonly_instance_sql_delayed_time	ros_cdk_core.IResolvable	No description.
attr_resource_group_id	ros_cdk_core.IResolvable	No description.
attr_security_ip_list	ros_cdk_core.IResolvable	No description.
attr_security_ip_mode	ros_cdk_core.IResolvable	No description.
attr_serverless_config	ros_cdk_core.IResolvable	No description.
attr_slave_zones	ros_cdk_core.IResolvable	No description.
attr_super_permission_mode	ros_cdk_core.IResolvable	No description.
attr_temp_db_instance_id	ros_cdk_core.IResolvable	No description.
attr_time_zone	ros_cdk_core.IResolvable	No description.
attr_tips	ros_cdk_core.IResolvable	No description.
attr_tips_level	ros_cdk_core.IResolvable	No description.
attr_vpc_cloud_instance_id	ros_cdk_core.IResolvable	No description.
attr_vpc_id	ros_cdk_core.IResolvable	No description.
attr_v_switch_id	ros_cdk_core.IResolvable	No description.
attr_zone_id	ros_cdk_core.IResolvable	No description.
enable_resource_property_constraint	bool	No description.
db_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

---

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

---

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

---

attr_account_max_quantity^Required

attr_account_max_quantity: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_advanced_features^Required

attr_advanced_features: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_auto_upgrade_minor_version^Required

attr_auto_upgrade_minor_version: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_availability_value^Required

attr_availability_value: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_babelfish_config^Required

attr_babelfish_config: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_category^Required

attr_category: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_collation^Required

attr_collation: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_connection_mode^Required

attr_connection_mode: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_connection_string^Required

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_console_version^Required

attr_console_version: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_creation_time^Required

attr_creation_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_current_kernel_version^Required

attr_current_kernel_version: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_cluster_nodes^Required

attr_db_cluster_nodes: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_class^Required

attr_db_instance_class: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_class_type^Required

attr_db_instance_class_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_cpu^Required

attr_db_instance_cpu: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_description^Required

attr_db_instance_description: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_disk_used^Required

attr_db_instance_disk_used: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_id^Required

attr_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_memory^Required

attr_db_instance_memory: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_net_type^Required

attr_db_instance_net_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_status^Required

attr_db_instance_status: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_storage^Required

attr_db_instance_storage: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_storage_type^Required

attr_db_instance_storage_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_instance_type^Required

attr_db_instance_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_max_quantity^Required

attr_db_max_quantity: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_dedicated_host_group_id^Required

attr_dedicated_host_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_deletion_protection^Required

attr_deletion_protection: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_engine^Required

attr_engine: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_engine_version^Required

attr_engine_version: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_expire_time^Required

attr_expire_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_extra^Required

attr_extra: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_general_group_name^Required

attr_general_group_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_guard_db_instance_id^Required

attr_guard_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_increment_source_db_instance_id^Required

attr_increment_source_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_network_type^Required

attr_instance_network_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instruction_set_arch^Required

attr_instruction_set_arch: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_ip_type^Required

attr_ip_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_latest_kernel_version^Required

attr_latest_kernel_version: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_lock_mode^Required

attr_lock_mode: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_lock_reason^Required

attr_lock_reason: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_maintain_time^Required

attr_maintain_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_master_instance_id^Required

attr_master_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_master_zone^Required

attr_master_zone: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_max_connections^Required

attr_max_connections: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_max_iombps^Required

attr_max_iombps: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_max_iops^Required

attr_max_iops: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_pay_type^Required

attr_pay_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_pg_bouncer_enabled^Required

attr_pg_bouncer_enabled: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_port^Required

attr_port: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_proxy_type^Required

attr_proxy_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_read_only_db_instance_ids^Required

attr_read_only_db_instance_ids: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_readonly_instance_sql_delayed_time^Required

attr_readonly_instance_sql_delayed_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_security_ip_list^Required

attr_security_ip_list: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_security_ip_mode^Required

attr_security_ip_mode: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_serverless_config^Required

attr_serverless_config: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_slave_zones^Required

attr_slave_zones: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_super_permission_mode^Required

attr_super_permission_mode: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_temp_db_instance_id^Required

attr_temp_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_time_zone^Required

attr_time_zone: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_tips^Required

attr_tips: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_tips_level^Required

attr_tips_level: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_vpc_cloud_instance_id^Required

attr_vpc_cloud_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_vpc_id^Required

attr_vpc_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_v_switch_id^Required

attr_v_switch_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_zone_id^Required

attr_zone_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

db_instance_id^Optional

db_instance_id: typing.Union[str, IResolvable]

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

---

refresh_options^Optional

refresh_options: typing.Union[str, IResolvable]

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

---

Constants

Name	Type	Description
ROS_RESOURCE_TYPE_NAME	str	The resource type name for this resource class.

---

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.

---