RosDBInstance

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

Initializers

import ros_cdk_rds
ros_cdk_rds.RosDBInstance(
  scope: Construct,
  id: str,
  db_instance_class: typing.Union[str, IResolvable],
  db_instance_storage: typing.Union[typing.Union[int, float], IResolvable],
  engine: typing.Union[str, IResolvable],
  engine_version: typing.Union[str, IResolvable],
  security_ip_list: typing.Union[str, IResolvable],
  allocate_public_connection: typing.Union[bool, IResolvable] = None,
  archive_backup_keep_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  archive_backup_keep_policy: typing.Union[str, IResolvable] = None,
  archive_backup_retention_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  back_up_category: typing.Union[str, IResolvable] = None,
  backup_policy_mode: typing.Union[str, IResolvable] = None,
  backup_retention_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  bursting_enabled: typing.Union[bool, IResolvable] = None,
  category: typing.Union[str, IResolvable] = None,
  cold_data_enabled: typing.Union[bool, IResolvable] = None,
  compress_type: typing.Union[typing.Union[int, float], IResolvable] = None,
  connection_mode: typing.Union[str, IResolvable] = None,
  connection_string_prefix: typing.Union[str, IResolvable] = None,
  connection_string_type: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  db_instance_net_type: typing.Union[str, IResolvable] = None,
  db_instance_storage_type: typing.Union[str, IResolvable] = None,
  db_is_ignore_case: typing.Union[typing.Union[int, float], IResolvable] = None,
  db_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DBMappingsProperty]]] = None,
  db_param_group_id: typing.Union[str, IResolvable] = None,
  db_time_zone: typing.Union[str, IResolvable] = None,
  dedicated_host_group_id: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  enable_backup_log: typing.Union[bool, IResolvable] = None,
  encryption_key: typing.Union[str, IResolvable] = None,
  high_space_usage_protection: typing.Union[str, IResolvable] = None,
  instance_network_type: typing.Union[str, IResolvable] = None,
  io_acceleration_enabled: typing.Union[str, IResolvable] = None,
  local_log_retention_hours: typing.Union[typing.Union[int, float], IResolvable] = None,
  local_log_retention_space: typing.Union[typing.Union[int, float], IResolvable] = None,
  log_backup_frequency: typing.Union[str, IResolvable] = None,
  log_backup_local_retention_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  log_backup_retention_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  maintain_time: typing.Union[str, IResolvable] = None,
  master_username: typing.Union[str, IResolvable] = None,
  master_user_password: typing.Union[str, IResolvable] = None,
  master_user_type: typing.Union[str, IResolvable] = None,
  multi_az: typing.Union[bool, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_type: typing.Union[str, IResolvable] = None,
  port: typing.Union[typing.Union[int, float], IResolvable] = None,
  preferred_backup_period: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  preferred_backup_time: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  released_keep_policy: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  role_arn: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  serverless_config: typing.Union[IResolvable, ServerlessConfigProperty] = None,
  slave_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  sql_collector_status: typing.Union[str, IResolvable] = None,
  ssl_setting: typing.Union[str, IResolvable] = None,
  storage_auto_scale: typing.Union[str, IResolvable] = None,
  storage_threshold: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_upper_bound: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.Mapping[typing.Any] = None,
  target_dedicated_host_id_for_log: typing.Union[str, IResolvable] = None,
  target_dedicated_host_id_for_master: typing.Union[str, IResolvable] = None,
  target_dedicated_host_id_for_slave: 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
)

Name	Type	Description
scope	ros_cdk_core.Construct	- scope in which this resource is defined.
id	str	- scoped id of the resource.
db_instance_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_storage	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
engine	typing.Union[str, ros_cdk_core.IResolvable]	No description.
engine_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_ip_list	typing.Union[str, ros_cdk_core.IResolvable]	No description.
allocate_public_connection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
archive_backup_keep_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
archive_backup_keep_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
archive_backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
auto_renew	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
back_up_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
backup_policy_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
bursting_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cold_data_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
compress_type	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
connection_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
connection_string_prefix	typing.Union[str, ros_cdk_core.IResolvable]	No description.
connection_string_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_description	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_net_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_storage_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_is_ignore_case	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
db_mappings	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBMappingsProperty]]]	No description.
db_param_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
dedicated_host_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
deletion_protection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
enable_backup_log	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
encryption_key	typing.Union[str, ros_cdk_core.IResolvable]	No description.
high_space_usage_protection	typing.Union[str, ros_cdk_core.IResolvable]	No description.
instance_network_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
io_acceleration_enabled	typing.Union[str, ros_cdk_core.IResolvable]	No description.
local_log_retention_hours	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
local_log_retention_space	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
log_backup_frequency	typing.Union[str, ros_cdk_core.IResolvable]	No description.
log_backup_local_retention_number	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
log_backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
maintain_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_username	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_user_password	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_user_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
multi_az	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
port	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
preferred_backup_period	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
preferred_backup_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
private_ip_address	typing.Union[str, ros_cdk_core.IResolvable]	No description.
released_keep_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
role_arn	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
serverless_config	typing.Union[ros_cdk_core.IResolvable, ServerlessConfigProperty]	No description.
slave_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
sql_collector_status	typing.Union[str, ros_cdk_core.IResolvable]	No description.
ssl_setting	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_auto_scale	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_threshold	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
storage_upper_bound	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
tags	typing.Mapping[typing.Any]	No description.
target_dedicated_host_id_for_log	typing.Union[str, ros_cdk_core.IResolvable]	No description.
target_dedicated_host_id_for_master	typing.Union[str, ros_cdk_core.IResolvable]	No description.
target_dedicated_host_id_for_slave	typing.Union[str, ros_cdk_core.IResolvable]	No description.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
zone_id	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_class^Required

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

---

db_instance_storage^Required

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

---

engine^Required

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

---

engine_version^Required

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

---

security_ip_list^Required

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

---

allocate_public_connection^Optional

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

---

archive_backup_keep_count^Optional

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

---

archive_backup_keep_policy^Optional

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

---

archive_backup_retention_period^Optional

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

---

auto_renew^Optional

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

---

back_up_category^Optional

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

---

backup_policy_mode^Optional

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

---

backup_retention_period^Optional

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

---

bursting_enabled^Optional

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

---

category^Optional

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

---

cold_data_enabled^Optional

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

---

compress_type^Optional

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

---

connection_mode^Optional

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

---

connection_string_prefix^Optional

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

---

connection_string_type^Optional

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

---

db_instance_description^Optional

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

---

db_instance_net_type^Optional

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

---

db_instance_storage_type^Optional

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

---

db_is_ignore_case^Optional

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

---

db_mappings^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBMappingsProperty]]]

---

db_param_group_id^Optional

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

---

db_time_zone^Optional

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

---

dedicated_host_group_id^Optional

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

---

deletion_protection^Optional

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

---

enable_backup_log^Optional

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

---

encryption_key^Optional

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

---

high_space_usage_protection^Optional

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

---

instance_network_type^Optional

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

---

io_acceleration_enabled^Optional

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

---

local_log_retention_hours^Optional

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

---

local_log_retention_space^Optional

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

---

log_backup_frequency^Optional

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

---

log_backup_local_retention_number^Optional

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

---

log_backup_retention_period^Optional

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

---

maintain_time^Optional

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

---

master_username^Optional

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

---

master_user_password^Optional

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

---

master_user_type^Optional

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

---

multi_az^Optional

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

---

pay_type^Optional

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

---

period^Optional

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

---

period_type^Optional

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

---

port^Optional

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

---

preferred_backup_period^Optional

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

---

preferred_backup_time^Optional

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

---

private_ip_address^Optional

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

---

released_keep_policy^Optional

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

---

resource_group_id^Optional

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

---

role_arn^Optional

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

---

security_group_id^Optional

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

---

serverless_config^Optional

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

---

slave_zone_ids^Optional

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

---

sql_collector_status^Optional

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

---

ssl_setting^Optional

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

---

storage_auto_scale^Optional

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

---

storage_threshold^Optional

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

---

storage_upper_bound^Optional

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

---

tags^Optional

• Type: typing.Mapping[typing.Any]

---

target_dedicated_host_id_for_log^Optional

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

---

target_dedicated_host_id_for_master^Optional

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

---

target_dedicated_host_id_for_slave^Optional

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

---

vpc_id^Optional

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

---

v_switch_id^Optional

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

---

zone_id^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

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

import ros_cdk_rds
ros_cdk_rds.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

import ros_cdk_rds
ros_cdk_rds.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_db_instance_id	ros_cdk_core.IResolvable	No description.
attr_inner_connection_string	ros_cdk_core.IResolvable	No description.
attr_inner_ip_address	ros_cdk_core.IResolvable	No description.
attr_inner_port	ros_cdk_core.IResolvable	No description.
attr_public_connection_string	ros_cdk_core.IResolvable	No description.
attr_public_ip_address	ros_cdk_core.IResolvable	No description.
attr_public_port	ros_cdk_core.IResolvable	No description.
db_instance_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_storage	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
enable_resource_property_constraint	bool	No description.
engine	typing.Union[str, ros_cdk_core.IResolvable]	No description.
engine_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_ip_list	typing.Union[str, ros_cdk_core.IResolvable]	No description.
allocate_public_connection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
archive_backup_keep_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
archive_backup_keep_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
archive_backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
auto_renew	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
back_up_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
backup_policy_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
bursting_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cold_data_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
compress_type	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
connection_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
connection_string_prefix	typing.Union[str, ros_cdk_core.IResolvable]	No description.
connection_string_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_description	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_net_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_instance_storage_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_is_ignore_case	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
db_mappings	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBMappingsProperty]]]	No description.
db_param_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
dedicated_host_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
deletion_protection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
enable_backup_log	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
encryption_key	typing.Union[str, ros_cdk_core.IResolvable]	No description.
high_space_usage_protection	typing.Union[str, ros_cdk_core.IResolvable]	No description.
instance_network_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
io_acceleration_enabled	typing.Union[str, ros_cdk_core.IResolvable]	No description.
local_log_retention_hours	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
local_log_retention_space	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
log_backup_frequency	typing.Union[str, ros_cdk_core.IResolvable]	No description.
log_backup_local_retention_number	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
log_backup_retention_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
maintain_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_username	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_user_password	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_user_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
multi_az	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
port	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
preferred_backup_period	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
preferred_backup_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
private_ip_address	typing.Union[str, ros_cdk_core.IResolvable]	No description.
released_keep_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
role_arn	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
serverless_config	typing.Union[ros_cdk_core.IResolvable, ServerlessConfigProperty]	No description.
slave_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
sql_collector_status	typing.Union[str, ros_cdk_core.IResolvable]	No description.
ssl_setting	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_auto_scale	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_threshold	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
storage_upper_bound	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
tags	typing.Mapping[typing.Any]	No description.
target_dedicated_host_id_for_log	typing.Union[str, ros_cdk_core.IResolvable]	No description.
target_dedicated_host_id_for_master	typing.Union[str, ros_cdk_core.IResolvable]	No description.
target_dedicated_host_id_for_slave	typing.Union[str, ros_cdk_core.IResolvable]	No description.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
zone_id	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_db_instance_id^Required

attr_db_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_inner_connection_string^Required

attr_inner_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_inner_ip_address^Required

attr_inner_ip_address: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_inner_port^Required

attr_inner_port: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_public_connection_string^Required

attr_public_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_public_ip_address^Required

attr_public_ip_address: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_public_port^Required

attr_public_port: IResolvable

• Type: ros_cdk_core.IResolvable

---

db_instance_class^Required

db_instance_class: typing.Union[str, IResolvable]

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

---

db_instance_storage^Required

db_instance_storage: typing.Union[typing.Union[int, float], IResolvable]

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

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

engine^Required

engine: typing.Union[str, IResolvable]

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

---

engine_version^Required

engine_version: typing.Union[str, IResolvable]

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

---

security_ip_list^Required

security_ip_list: typing.Union[str, IResolvable]

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

---

allocate_public_connection^Optional

allocate_public_connection: typing.Union[bool, IResolvable]

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

---

archive_backup_keep_count^Optional

archive_backup_keep_count: typing.Union[typing.Union[int, float], IResolvable]

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

---

archive_backup_keep_policy^Optional

archive_backup_keep_policy: typing.Union[str, IResolvable]

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

---

archive_backup_retention_period^Optional

archive_backup_retention_period: typing.Union[typing.Union[int, float], IResolvable]

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

---

auto_renew^Optional

auto_renew: typing.Union[bool, IResolvable]

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

---

back_up_category^Optional

back_up_category: typing.Union[str, IResolvable]

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

---

backup_policy_mode^Optional

backup_policy_mode: typing.Union[str, IResolvable]

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

---

backup_retention_period^Optional

backup_retention_period: typing.Union[typing.Union[int, float], IResolvable]

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

---

bursting_enabled^Optional

bursting_enabled: typing.Union[bool, IResolvable]

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

---

category^Optional

category: typing.Union[str, IResolvable]

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

---

cold_data_enabled^Optional

cold_data_enabled: typing.Union[bool, IResolvable]

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

---

compress_type^Optional

compress_type: typing.Union[typing.Union[int, float], IResolvable]

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

---

connection_mode^Optional

connection_mode: typing.Union[str, IResolvable]

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

---

connection_string_prefix^Optional

connection_string_prefix: typing.Union[str, IResolvable]

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

---

connection_string_type^Optional

connection_string_type: typing.Union[str, IResolvable]

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

---

db_instance_description^Optional

db_instance_description: typing.Union[str, IResolvable]

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

---

db_instance_net_type^Optional

db_instance_net_type: typing.Union[str, IResolvable]

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

---

db_instance_storage_type^Optional

db_instance_storage_type: typing.Union[str, IResolvable]

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

---

db_is_ignore_case^Optional

db_is_ignore_case: typing.Union[typing.Union[int, float], IResolvable]

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

---

db_mappings^Optional

db_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DBMappingsProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBMappingsProperty]]]

---

db_param_group_id^Optional

db_param_group_id: typing.Union[str, IResolvable]

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

---

db_time_zone^Optional

db_time_zone: typing.Union[str, IResolvable]

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

---

dedicated_host_group_id^Optional

dedicated_host_group_id: typing.Union[str, IResolvable]

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

---

deletion_protection^Optional

deletion_protection: typing.Union[bool, IResolvable]

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

---

enable_backup_log^Optional

enable_backup_log: typing.Union[bool, IResolvable]

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

---

encryption_key^Optional

encryption_key: typing.Union[str, IResolvable]

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

---

high_space_usage_protection^Optional

high_space_usage_protection: typing.Union[str, IResolvable]

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

---

instance_network_type^Optional

instance_network_type: typing.Union[str, IResolvable]

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

---

io_acceleration_enabled^Optional

io_acceleration_enabled: typing.Union[str, IResolvable]

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

---

local_log_retention_hours^Optional

local_log_retention_hours: typing.Union[typing.Union[int, float], IResolvable]

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

---

local_log_retention_space^Optional

local_log_retention_space: typing.Union[typing.Union[int, float], IResolvable]

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

---

log_backup_frequency^Optional

log_backup_frequency: typing.Union[str, IResolvable]

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

---

log_backup_local_retention_number^Optional

log_backup_local_retention_number: typing.Union[typing.Union[int, float], IResolvable]

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

---

log_backup_retention_period^Optional

log_backup_retention_period: typing.Union[typing.Union[int, float], IResolvable]

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

---

maintain_time^Optional

maintain_time: typing.Union[str, IResolvable]

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

---

master_username^Optional

master_username: typing.Union[str, IResolvable]

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

---

master_user_password^Optional

master_user_password: typing.Union[str, IResolvable]

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

---

master_user_type^Optional

master_user_type: typing.Union[str, IResolvable]

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

---

multi_az^Optional

multi_az: typing.Union[bool, IResolvable]

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

---

pay_type^Optional

pay_type: typing.Union[str, IResolvable]

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

---

period^Optional

period: typing.Union[typing.Union[int, float], IResolvable]

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

---

period_type^Optional

period_type: typing.Union[str, IResolvable]

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

---

port^Optional

port: typing.Union[typing.Union[int, float], IResolvable]

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

---

preferred_backup_period^Optional

preferred_backup_period: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

preferred_backup_time^Optional

preferred_backup_time: typing.Union[str, IResolvable]

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

---

private_ip_address^Optional

private_ip_address: typing.Union[str, IResolvable]

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

---

released_keep_policy^Optional

released_keep_policy: typing.Union[str, IResolvable]

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

---

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

---

role_arn^Optional

role_arn: typing.Union[str, IResolvable]

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

---

security_group_id^Optional

security_group_id: typing.Union[str, IResolvable]

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

---

serverless_config^Optional

serverless_config: typing.Union[IResolvable, ServerlessConfigProperty]

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

---

slave_zone_ids^Optional

slave_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

sql_collector_status^Optional

sql_collector_status: typing.Union[str, IResolvable]

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

---

ssl_setting^Optional

ssl_setting: typing.Union[str, IResolvable]

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

---

storage_auto_scale^Optional

storage_auto_scale: typing.Union[str, IResolvable]

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

---

storage_threshold^Optional

storage_threshold: typing.Union[typing.Union[int, float], IResolvable]

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

---

storage_upper_bound^Optional

storage_upper_bound: typing.Union[typing.Union[int, float], IResolvable]

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

---

tags^Optional

tags: typing.Mapping[typing.Any]

• Type: typing.Mapping[typing.Any]

---

target_dedicated_host_id_for_log^Optional

target_dedicated_host_id_for_log: typing.Union[str, IResolvable]

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

---

target_dedicated_host_id_for_master^Optional

target_dedicated_host_id_for_master: typing.Union[str, IResolvable]

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

---

target_dedicated_host_id_for_slave^Optional

target_dedicated_host_id_for_slave: typing.Union[str, IResolvable]

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

---

vpc_id^Optional

vpc_id: typing.Union[str, IResolvable]

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

---

v_switch_id^Optional

v_switch_id: typing.Union[str, IResolvable]

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

---

zone_id^Optional

zone_id: 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.

---