DrdsDB

This class encapsulates and extends the ROS resource type ALIYUN::DRDS::DrdsDB, which is used to create a Distributed Relational Database Service (DRDS) instance.

Initializers

import ros_cdk_drds
ros_cdk_drds.DrdsDB(
  scope: Construct,
  id: str,
  drds_instance_id: typing.Union[str, IResolvable],
  account_name: typing.Union[str, IResolvable] = None,
  db_instance_is_creating: typing.Union[bool, IResolvable] = None,
  db_inst_type: typing.Union[str, IResolvable] = None,
  db_name: typing.Union[str, IResolvable] = None,
  encode: typing.Union[str, IResolvable] = None,
  inst_db_name: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstDbNameProperty]]] = None,
  password: typing.Union[str, IResolvable] = None,
  rds_instance: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
drds_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property drdsInstanceId: DRDS instance ID.
account_name	typing.Union[str, ros_cdk_core.IResolvable]	Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs.
db_instance_is_creating	typing.Union[bool, ros_cdk_core.IResolvable]	Property dbInstanceIsCreating: Check whether the RDS instance is being created.
db_inst_type	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstType: The type of the attached storage.
db_name	typing.Union[str, ros_cdk_core.IResolvable]	Property dbName: Database Name.
encode	typing.Union[str, ros_cdk_core.IResolvable]	Property encode: Encoding used by the database.
inst_db_name	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstDbNameProperty]]]	Property instDbName:.
password	typing.Union[str, ros_cdk_core.IResolvable]	Property password: The logon password of the database instance.
rds_instance	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property rdsInstance: This property is required only for vertical partitioning.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: Database Sharding method.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

drds_instance_id^Required

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

Property drdsInstanceId: DRDS instance ID.

---

account_name^Optional

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

Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs.

---

db_instance_is_creating^Optional

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

Property dbInstanceIsCreating: Check whether the RDS instance is being created.

---

db_inst_type^Optional

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

Property dbInstType: The type of the attached storage.

Valid values: RDS or POLARDB

---

db_name^Optional

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

Property dbName: Database Name.

---

encode^Optional

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

Property encode: Encoding used by the database.

---

inst_db_name^Optional

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

Property instDbName:.

---

password^Optional

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

Property password: The logon password of the database instance.

---

rds_instance^Optional

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

Property rdsInstance: This property is required only for vertical partitioning.

---

type^Optional

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

Property type: Database Sharding method.

For more information, see scalability principle. Valid values: HORIZONTAL: indicates HORIZONTAL partitioning, which is commonly known as database and table sharding. VERTICAL: indicates VERTICAL partitioning.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

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

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_drds
ros_cdk_drds.DrdsDB.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---