DBInstance

This class encapsulates and extends the ROS resource type ALIYUN::PolarDBX::DBInstance, which is used to create a PolarDB for Xscale (PolarDB-X) instance.

Initializers

import ros_cdk_polardbx
ros_cdk_polardbx.DBInstance(
  scope: Construct,
  id: str,
  db_node_class: typing.Union[str, IResolvable],
  db_node_count: typing.Union[typing.Union[int, float], IResolvable],
  engine_version: typing.Union[str, IResolvable],
  primary_zone: typing.Union[str, IResolvable],
  topology_type: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  auto_renew: typing.Union[bool, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  secondary_zone: typing.Union[str, IResolvable] = None,
  security_ip_config: typing.Union[IResolvable, SecurityIpConfigProperty] = None,
  tertiary_zone: typing.Union[str, IResolvable] = None,
  used_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
db_node_class	typing.Union[str, ros_cdk_core.IResolvable]	Property dbNodeClass: The specification of the nodes in the instance you want to create.
db_node_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property dbNodeCount: The number of nodes in the instance you want to create.
engine_version	typing.Union[str, ros_cdk_core.IResolvable]	Property engineVersion: The version of the database engine.
primary_zone	typing.Union[str, ros_cdk_core.IResolvable]	Property primaryZone: The primary zone.
topology_type	typing.Union[str, ros_cdk_core.IResolvable]	Property topologyType: The topology type of the instance.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vpcId: The ID of the VPC to which the instance belongs.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vSwitchId: The ID of the vSwitch.
auto_renew	typing.Union[bool, ros_cdk_core.IResolvable]	Property autoRenew: Specifies whether to enable auto-renewal for the instance.
db_instance_description	typing.Union[str, ros_cdk_core.IResolvable]	Property dbInstanceDescription: The description of the instance.
pay_type	typing.Union[str, ros_cdk_core.IResolvable]	Property payType: The billing method of the instance.
period	typing.Union[str, ros_cdk_core.IResolvable]	Property period: The unit of the billing cycle for the instance.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of resource group.
secondary_zone	typing.Union[str, ros_cdk_core.IResolvable]	Property secondaryZone: The secondary zone.
security_ip_config	typing.Union[ros_cdk_core.IResolvable, SecurityIpConfigProperty]	Property securityIpConfig: Instance whitelist configuration.
tertiary_zone	typing.Union[str, ros_cdk_core.IResolvable]	Property tertiaryZone: The tertiary zone.
used_time	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property usedTime: The subscription period of the instance.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

db_node_class^Required

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

Property dbNodeClass: The specification of the nodes in the instance you want to create.

---

db_node_count^Required

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

Property dbNodeCount: The number of nodes in the instance you want to create.

---

engine_version^Required

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

Property engineVersion: The version of the database engine.

---

primary_zone^Required

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

Property primaryZone: The primary zone.

---

topology_type^Required

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

Property topologyType: The topology type of the instance.

Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.

---

vpc_id^Required

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

Property vpcId: The ID of the VPC to which the instance belongs.

---

v_switch_id^Required

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

Property vSwitchId: The ID of the vSwitch.

---

auto_renew^Optional

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

Property autoRenew: Specifies whether to enable auto-renewal for the instance.

Default value: true. true: Enable auto-renewal. false: Disable auto-renewal.

---

db_instance_description^Optional

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

Property dbInstanceDescription: The description of the instance.

---

pay_type^Optional

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

Property payType: The billing method of the instance.

Default: POSTPAY.Valid values: PREPAY: subscription POSTPAY: pay-as-you-go

---

period^Optional

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

Property period: The unit of the billing cycle for the instance.

The valid values vary based on the billing method. If you use the subscription billing method, set the value to Year or Month. If you use the pay-as-you-go billing method, the value is automatically set to Hour.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of resource group.

---

secondary_zone^Optional

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

Property secondaryZone: The secondary zone.

---

security_ip_config^Optional

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

Property securityIpConfig: Instance whitelist configuration.

---

tertiary_zone^Optional

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

Property tertiaryZone: The tertiary zone.

---

used_time^Optional

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

Property usedTime: The subscription period of the instance.

Unit: month or year. Note When period is set to year, the supported values of this parameter are 1, 2 and 3.

---

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_polardbx
ros_cdk_polardbx.DBInstance.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_connection_string	ros_cdk_core.IResolvable	Attribute ConnectionString: Intranet connection string.
attr_db_instance_name	ros_cdk_core.IResolvable	Attribute DBInstanceName: The name of the instance that you create.
attr_order_id	ros_cdk_core.IResolvable	Attribute OrderId: The ID of the order.
attr_port	ros_cdk_core.IResolvable	Attribute Port: Intranet connection port.

---

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

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ConnectionString: Intranet connection string.

---

attr_db_instance_name^Required

attr_db_instance_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DBInstanceName: The name of the instance that you create.

---

attr_order_id^Required

attr_order_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OrderId: The ID of the order.

---

attr_port^Required

attr_port: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Port: Intranet connection port.

---