Zones

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::Zones, which is used to query the zones of an ApsaraDB RDS instance.

Initializers

from ros_cdk_rds import datasource
datasource.Zones(
  scope: Construct,
  id: str,
  engine: typing.Union[str, IResolvable],
  category: typing.Union[str, IResolvable] = None,
  commodity_code: typing.Union[str, IResolvable] = None,
  dispense_mode: typing.Union[str, IResolvable] = None,
  engine_version: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  zone_id: 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.
engine	typing.Union[str, ros_cdk_core.IResolvable]	Property engine: The database engine that is run by the instance.
category	typing.Union[str, ros_cdk_core.IResolvable]	Property category: The RDS edition of the instance.
commodity_code	typing.Union[str, ros_cdk_core.IResolvable]	Property commodityCode: The commodity code of the instance.
dispense_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property dispenseMode: Specifies whether to return the zones in which the single-zone deployment method is supported.
engine_version	typing.Union[str, ros_cdk_core.IResolvable]	Property engineVersion: The version of the database engine that is run by the instance.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: The ID of the zone in which the instance is located.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

engine^Required

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

Property engine: The database engine that is run by the instance.

---

category^Optional

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

Property category: The RDS edition of the instance.

Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition

---

commodity_code^Optional

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

Property commodityCode: The commodity code of the instance.

---

dispense_mode^Optional

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

Property dispenseMode: Specifies whether to return the zones in which the single-zone deployment method is supported.

Valid values: 1: returns the zones. 0: does not return the zones. Default value: 0.

---

engine_version^Optional

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

Property engineVersion: The version of the database engine that is run by the 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.

---

zone_id^Optional

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

Property zoneId: The ID of the zone in which the instance is located.

If the instance spans more than one zone, the value of this parameter contains an MAZ part,such as cn-hangzhou-MAZ6(b,f) and cn-hangzhou-MAZ5(b,e,f)

---

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_rds import datasource
datasource.Zones.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_zone_ids	ros_cdk_core.IResolvable	Attribute ZoneIds: The list of zone IDs.
attr_zones	ros_cdk_core.IResolvable	Attribute Zones: The list of The Zones.

---

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_zone_ids^Required

attr_zone_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneIds: The list of zone IDs.

---

attr_zones^Required

attr_zones: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Zones: The list of The Zones.

---

Structs