DrdsInstance

This class encapsulates and extends the ROS resource type DATASOURCE::DRDS::DrdsInstance, which is used to query the information about a PolarDB-X 1.0 instance.

Initializers

from ros_cdk_drds import datasource
datasource.DrdsInstance(
  scope: Construct,
  id: str,
  drds_instance_id: typing.Union[str, IResolvable],
  refresh_options: 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: The ID of the Drds instance.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
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: The ID of the Drds instance.

---

refresh_options^Optional

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

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

Valid values:

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

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

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

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

from ros_cdk_drds import datasource
datasource.DrdsInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_commodity_code	ros_cdk_core.IResolvable	Attribute CommodityCode: The commodity code of the service.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The timestamp that indicates when the instance is created.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the instance.
attr_drds_instance_id	ros_cdk_core.IResolvable	Attribute DrdsInstanceId: The ID of the Drds instance.
attr_expire_date	ros_cdk_core.IResolvable	Attribute ExpireDate: The timestamp that indicates when the instance expires.
attr_instance_series	ros_cdk_core.IResolvable	Attribute InstanceSeries: The edition of the instance.
attr_instance_spec	ros_cdk_core.IResolvable	Attribute InstanceSpec: The specification of the instance.
attr_inst_role	ros_cdk_core.IResolvable	Attribute InstRole: The role of the instance.
attr_label	ros_cdk_core.IResolvable	Attribute Label: The tag of the instance.
attr_machine_type	ros_cdk_core.IResolvable	Attribute MachineType: The machine type of the instance.
attr_master_instance_id	ros_cdk_core.IResolvable	Attribute MasterInstanceId: The ID of the primary instance.
attr_mysql_version	ros_cdk_core.IResolvable	Attribute MysqlVersion: Engine version.
attr_network_type	ros_cdk_core.IResolvable	Attribute NetworkType: The network type of the instance.
attr_order_instance_id	ros_cdk_core.IResolvable	Attribute OrderInstanceId: The ID of the purchased instance.
attr_read_only_db_instance_ids	ros_cdk_core.IResolvable	Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attr_storage_type	ros_cdk_core.IResolvable	Attribute StorageType: The storage type of the Drds database.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of the instance.
attr_version	ros_cdk_core.IResolvable	Attribute Version: The version of the instance.
attr_version_action	ros_cdk_core.IResolvable	Attribute VersionAction: Indicates whether the version of the instance can be upgraded.
attr_vips	ros_cdk_core.IResolvable	Attribute Vips: The list of returned virtual IP addresses (VIPs).
attr_vpc_cloud_instance_id	ros_cdk_core.IResolvable	Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.
attr_zone_id	ros_cdk_core.IResolvable	Attribute ZoneId: The ID of the zone in which the resource is located.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_commodity_code^Required

attr_commodity_code: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CommodityCode: The commodity code of the service.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The timestamp that indicates when the instance is created.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the instance.

---

attr_drds_instance_id^Required

attr_drds_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DrdsInstanceId: The ID of the Drds instance.

---

attr_expire_date^Required

attr_expire_date: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ExpireDate: The timestamp that indicates when the instance expires.

---

attr_instance_series^Required

attr_instance_series: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceSeries: The edition of the instance.

Valid values: starter: Starter Edition enterprise: Enterprise Edition standard: Standard Edition

---

attr_instance_spec^Required

attr_instance_spec: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceSpec: The specification of the instance.

---

attr_inst_role^Required

attr_inst_role: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstRole: The role of the instance.

Valid values: MASTER: The instance is a primary instance. SLAVE: The instance is a read-only instance to analyze complex queries. SLAVE_FLOW: The instance is a read-only instance for high-concurrency scenarios.

---

attr_label^Required

attr_label: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Label: The tag of the instance.

Valid values: NORMAL: The instance is a standard instance. HA: The instance is a high-availability (HA) instance. VPC: The instance is a VPC-based instance.

---

attr_machine_type^Required

attr_machine_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MachineType: The machine type of the instance.

Valid value: ecs.

---

attr_master_instance_id^Required

attr_master_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MasterInstanceId: The ID of the primary instance.

---

attr_mysql_version^Required

attr_mysql_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MysqlVersion: Engine version.

---

attr_network_type^Required

attr_network_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: CLASSIC VPC

---

attr_order_instance_id^Required

attr_order_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OrderInstanceId: The ID of the purchased instance.

---

attr_read_only_db_instance_ids^Required

attr_read_only_db_instance_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

---

attr_storage_type^Required

attr_storage_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute StorageType: The storage type of the Drds database.

Valid values: RDS PolarDB

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of the instance.

Valid values: PUBLIC: The returned instance is a shared instance. PRIVATE: The returned instance is a dedicated instance.

---

attr_version^Required

attr_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Version: The version of the instance.

---

attr_version_action^Required

attr_version_action: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VersionAction: Indicates whether the version of the instance can be upgraded.

---

attr_vips^Required

attr_vips: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Vips: The list of returned virtual IP addresses (VIPs).

---

attr_vpc_cloud_instance_id^Required

attr_vpc_cloud_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.

---

attr_zone_id^Required

attr_zone_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneId: The ID of the zone in which the resource is located.

---