Skip to content

DBInstanceProps

Properties for defining a DBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardbx-dbinstance

Initializer 

import ros_cdk_polardbx
ros_cdk_polardbx.DBInstanceProps(
  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
)

Properties

Name Type 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.

db_node_classRequired 

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

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

db_node_countRequired 

db_node_count: typing.Union[typing.Union[int, float], IResolvable]
  • 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_versionRequired 

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

Property engineVersion: The version of the database engine.

primary_zoneRequired 

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

Property primaryZone: The primary zone.

topology_typeRequired 

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

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

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

v_switch_idRequired 

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

Property vSwitchId: The ID of the vSwitch.

auto_renewOptional 

auto_renew: typing.Union[bool, IResolvable]
  • 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_descriptionOptional 

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

Property dbInstanceDescription: The description of the instance.

pay_typeOptional 

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

periodOptional 

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

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

Property resourceGroupId: The ID of resource group.

secondary_zoneOptional 

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

Property secondaryZone: The secondary zone.

security_ip_configOptional 

security_ip_config: typing.Union[IResolvable, SecurityIpConfigProperty]

Property securityIpConfig: Instance whitelist configuration.

tertiary_zoneOptional 

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

Property tertiaryZone: The tertiary zone.

used_timeOptional 

used_time: typing.Union[typing.Union[int, float], IResolvable]
  • 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.