RosDBCluster

This class is a base encapsulation around the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.

Initializers

import ros_cdk_polardb
ros_cdk_polardb.RosDBCluster(
  scope: Construct,
  id: str,
  db_node_class: typing.Union[str, IResolvable],
  db_type: typing.Union[str, IResolvable],
  db_version: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  allow_shut_down: typing.Union[bool, IResolvable] = None,
  architecture: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  backup_retention_policy_on_cluster_deletion: typing.Union[str, IResolvable] = None,
  clone_data_point: typing.Union[str, IResolvable] = None,
  cluster_network_type: typing.Union[str, IResolvable] = None,
  cold_storage_option: typing.Union[IResolvable, ColdStorageOptionProperty] = None,
  creation_category: typing.Union[str, IResolvable] = None,
  creation_option: typing.Union[str, IResolvable] = None,
  db_cluster_description: typing.Union[str, IResolvable] = None,
  db_cluster_parameters: typing.Union[IResolvable, DBClusterParametersProperty] = None,
  db_minor_version: typing.Union[str, IResolvable] = None,
  db_node_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  default_time_zone: typing.Union[str, IResolvable] = None,
  gdn_id: typing.Union[str, IResolvable] = None,
  hot_standby_cluster: typing.Union[str, IResolvable] = None,
  loose_polar_log_bin: typing.Union[str, IResolvable] = None,
  loose_x_engine: typing.Union[str, IResolvable] = None,
  loose_x_engine_use_memory_pct: typing.Union[typing.Union[int, float], IResolvable] = None,
  lower_case_table_names: typing.Union[typing.Union[int, float], IResolvable] = None,
  maintain_time: typing.Union[str, IResolvable] = None,
  parameter_group_id: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  proxy_class: typing.Union[str, IResolvable] = None,
  proxy_type: typing.Union[str, IResolvable] = None,
  renewal_status: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  restart_master_node: typing.Union[bool, IResolvable] = None,
  scale_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_min: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_ro_num_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_ro_num_min: typing.Union[typing.Union[int, float], IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  serverless_type: typing.Union[str, IResolvable] = None,
  source_resource_id: typing.Union[str, IResolvable] = None,
  standby_az: typing.Union[str, IResolvable] = None,
  storage_auto_scale: typing.Union[str, IResolvable] = None,
  storage_pay_type: typing.Union[str, IResolvable] = None,
  storage_space: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_type: typing.Union[str, IResolvable] = None,
  storage_upper_bound: typing.Union[typing.Union[int, float], IResolvable] = None,
  strict_consistency: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tde_status: typing.Union[bool, 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_node_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
allow_shut_down	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
architecture	typing.Union[str, ros_cdk_core.IResolvable]	No description.
auto_renew_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
backup_retention_policy_on_cluster_deletion	typing.Union[str, ros_cdk_core.IResolvable]	No description.
clone_data_point	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cluster_network_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cold_storage_option	typing.Union[ros_cdk_core.IResolvable, ColdStorageOptionProperty]	No description.
creation_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
creation_option	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_cluster_description	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_cluster_parameters	typing.Union[ros_cdk_core.IResolvable, DBClusterParametersProperty]	No description.
db_minor_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_node_num	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
default_time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
gdn_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
hot_standby_cluster	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_polar_log_bin	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_x_engine	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_x_engine_use_memory_pct	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
lower_case_table_names	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
maintain_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
parameter_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_unit	typing.Union[str, ros_cdk_core.IResolvable]	No description.
proxy_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
proxy_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
renewal_status	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
restart_master_node	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
scale_max	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_min	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_ro_num_max	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_ro_num_min	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
security_group_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
security_ip_list	typing.Union[str, ros_cdk_core.IResolvable]	No description.
serverless_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
source_resource_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
standby_az	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_auto_scale	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_space	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
storage_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_upper_bound	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
strict_consistency	typing.Union[str, ros_cdk_core.IResolvable]	No description.
tags	typing.List[TagsProperty]	No description.
tde_status	typing.Union[bool, 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_node_class^Required

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

---

db_type^Required

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

---

db_version^Required

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

---

pay_type^Required

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

---

allow_shut_down^Optional

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

---

architecture^Optional

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

---

auto_renew_period^Optional

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

---

backup_retention_policy_on_cluster_deletion^Optional

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

---

clone_data_point^Optional

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

---

cluster_network_type^Optional

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

---

cold_storage_option^Optional

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

---

creation_category^Optional

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

---

creation_option^Optional

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

---

db_cluster_description^Optional

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

---

db_cluster_parameters^Optional

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

---

db_minor_version^Optional

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

---

db_node_num^Optional

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

---

default_time_zone^Optional

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

---

gdn_id^Optional

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

---

hot_standby_cluster^Optional

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

---

loose_polar_log_bin^Optional

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

---

loose_x_engine^Optional

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

---

loose_x_engine_use_memory_pct^Optional

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

---

lower_case_table_names^Optional

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

---

maintain_time^Optional

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

---

parameter_group_id^Optional

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

---

period^Optional

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

---

period_unit^Optional

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

---

proxy_class^Optional

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

---

proxy_type^Optional

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

---

renewal_status^Optional

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

---

resource_group_id^Optional

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

---

restart_master_node^Optional

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

---

scale_max^Optional

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

---

scale_min^Optional

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

---

scale_ro_num_max^Optional

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

---

scale_ro_num_min^Optional

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

---

security_group_ids^Optional

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

---

security_ip_list^Optional

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

---

serverless_type^Optional

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

---

source_resource_id^Optional

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

---

standby_az^Optional

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

---

storage_auto_scale^Optional

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

---

storage_pay_type^Optional

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

---

storage_space^Optional

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

---

storage_type^Optional

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

---

storage_upper_bound^Optional

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

---

strict_consistency^Optional

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

---

tags^Optional

• Type: typing.List[TagsProperty]

---

tde_status^Optional

• Type: typing.Union[bool, 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_polardb
ros_cdk_polardb.RosDBCluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

import ros_cdk_polardb
ros_cdk_polardb.RosDBCluster.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_polardb
ros_cdk_polardb.RosDBCluster.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_cluster_connection_string	ros_cdk_core.IResolvable	No description.
attr_cluster_endpoint_id	ros_cdk_core.IResolvable	No description.
attr_cold_storage_instance_id	ros_cdk_core.IResolvable	No description.
attr_custom_connection_strings	ros_cdk_core.IResolvable	No description.
attr_custom_endpoint_ids	ros_cdk_core.IResolvable	No description.
attr_db_cluster_description	ros_cdk_core.IResolvable	No description.
attr_db_cluster_id	ros_cdk_core.IResolvable	No description.
attr_db_node_ids	ros_cdk_core.IResolvable	No description.
attr_order_id	ros_cdk_core.IResolvable	No description.
attr_primary_connection_string	ros_cdk_core.IResolvable	No description.
attr_primary_connection_strings	ros_cdk_core.IResolvable	No description.
attr_primary_endpoint_id	ros_cdk_core.IResolvable	No description.
attr_primary_endpoint_ids	ros_cdk_core.IResolvable	No description.
db_node_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
enable_resource_property_constraint	bool	No description.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
allow_shut_down	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
architecture	typing.Union[str, ros_cdk_core.IResolvable]	No description.
auto_renew_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
backup_retention_policy_on_cluster_deletion	typing.Union[str, ros_cdk_core.IResolvable]	No description.
clone_data_point	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cluster_network_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cold_storage_option	typing.Union[ros_cdk_core.IResolvable, ColdStorageOptionProperty]	No description.
creation_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
creation_option	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_cluster_description	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_cluster_parameters	typing.Union[ros_cdk_core.IResolvable, DBClusterParametersProperty]	No description.
db_minor_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
db_node_num	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
default_time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
gdn_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
hot_standby_cluster	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_polar_log_bin	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_x_engine	typing.Union[str, ros_cdk_core.IResolvable]	No description.
loose_x_engine_use_memory_pct	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
lower_case_table_names	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
maintain_time	typing.Union[str, ros_cdk_core.IResolvable]	No description.
parameter_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_unit	typing.Union[str, ros_cdk_core.IResolvable]	No description.
proxy_class	typing.Union[str, ros_cdk_core.IResolvable]	No description.
proxy_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
renewal_status	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
restart_master_node	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
scale_max	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_min	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_ro_num_max	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
scale_ro_num_min	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
security_group_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
security_ip_list	typing.Union[str, ros_cdk_core.IResolvable]	No description.
serverless_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
source_resource_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
standby_az	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_auto_scale	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_pay_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_space	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
storage_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
storage_upper_bound	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
strict_consistency	typing.Union[str, ros_cdk_core.IResolvable]	No description.
tags	typing.List[TagsProperty]	No description.
tde_status	typing.Union[bool, 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_cluster_connection_string^Required

attr_cluster_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cluster_endpoint_id^Required

attr_cluster_endpoint_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cold_storage_instance_id^Required

attr_cold_storage_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_custom_connection_strings^Required

attr_custom_connection_strings: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_custom_endpoint_ids^Required

attr_custom_endpoint_ids: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_cluster_description^Required

attr_db_cluster_description: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_cluster_id^Required

attr_db_cluster_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_db_node_ids^Required

attr_db_node_ids: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_order_id^Required

attr_order_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_primary_connection_string^Required

attr_primary_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_primary_connection_strings^Required

attr_primary_connection_strings: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_primary_endpoint_id^Required

attr_primary_endpoint_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_primary_endpoint_ids^Required

attr_primary_endpoint_ids: IResolvable

• Type: ros_cdk_core.IResolvable

---

db_node_class^Required

db_node_class: typing.Union[str, IResolvable]

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

---

db_type^Required

db_type: typing.Union[str, IResolvable]

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

---

db_version^Required

db_version: typing.Union[str, IResolvable]

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

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

pay_type^Required

pay_type: typing.Union[str, IResolvable]

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

---

allow_shut_down^Optional

allow_shut_down: typing.Union[bool, IResolvable]

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

---

architecture^Optional

architecture: typing.Union[str, IResolvable]

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

---

auto_renew_period^Optional

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

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

---

backup_retention_policy_on_cluster_deletion^Optional

backup_retention_policy_on_cluster_deletion: typing.Union[str, IResolvable]

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

---

clone_data_point^Optional

clone_data_point: typing.Union[str, IResolvable]

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

---

cluster_network_type^Optional

cluster_network_type: typing.Union[str, IResolvable]

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

---

cold_storage_option^Optional

cold_storage_option: typing.Union[IResolvable, ColdStorageOptionProperty]

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

---

creation_category^Optional

creation_category: typing.Union[str, IResolvable]

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

---

creation_option^Optional

creation_option: typing.Union[str, IResolvable]

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

---

db_cluster_description^Optional

db_cluster_description: typing.Union[str, IResolvable]

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

---

db_cluster_parameters^Optional

db_cluster_parameters: typing.Union[IResolvable, DBClusterParametersProperty]

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

---

db_minor_version^Optional

db_minor_version: typing.Union[str, IResolvable]

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

---

db_node_num^Optional

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

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

---

default_time_zone^Optional

default_time_zone: typing.Union[str, IResolvable]

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

---

gdn_id^Optional

gdn_id: typing.Union[str, IResolvable]

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

---

hot_standby_cluster^Optional

hot_standby_cluster: typing.Union[str, IResolvable]

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

---

loose_polar_log_bin^Optional

loose_polar_log_bin: typing.Union[str, IResolvable]

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

---

loose_x_engine^Optional

loose_x_engine: typing.Union[str, IResolvable]

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

---

loose_x_engine_use_memory_pct^Optional

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

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

---

lower_case_table_names^Optional

lower_case_table_names: 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]

---

parameter_group_id^Optional

parameter_group_id: 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_unit^Optional

period_unit: typing.Union[str, IResolvable]

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

---

proxy_class^Optional

proxy_class: typing.Union[str, IResolvable]

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

---

proxy_type^Optional

proxy_type: typing.Union[str, IResolvable]

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

---

renewal_status^Optional

renewal_status: 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]

---

restart_master_node^Optional

restart_master_node: typing.Union[bool, IResolvable]

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

---

scale_max^Optional

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

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

---

scale_min^Optional

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

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

---

scale_ro_num_max^Optional

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

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

---

scale_ro_num_min^Optional

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

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

---

security_group_ids^Optional

security_group_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]]]

---

security_ip_list^Optional

security_ip_list: typing.Union[str, IResolvable]

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

---

serverless_type^Optional

serverless_type: typing.Union[str, IResolvable]

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

---

source_resource_id^Optional

source_resource_id: typing.Union[str, IResolvable]

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

---

standby_az^Optional

standby_az: 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_pay_type^Optional

storage_pay_type: typing.Union[str, IResolvable]

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

---

storage_space^Optional

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

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

---

storage_type^Optional

storage_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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]

---

strict_consistency^Optional

strict_consistency: typing.Union[str, IResolvable]

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

---

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

---

tde_status^Optional

tde_status: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, 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.

---