Skip to content

DBClusterProps

Properties for defining a DBCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbcluster

Initializer 

import ros_cdk_polardb
ros_cdk_polardb.DBClusterProps(
  db_node_class: typing.Union[str, IResolvable],
  db_type: typing.Union[str, IResolvable],
  db_version: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  allow_shut_down: typing.Union[bool, IResolvable] = None,
  architecture: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  backup_retention_policy_on_cluster_deletion: typing.Union[str, IResolvable] = None,
  clone_data_point: typing.Union[str, IResolvable] = None,
  cluster_network_type: typing.Union[str, IResolvable] = None,
  cold_storage_option: typing.Union[IResolvable, ColdStorageOptionProperty] = None,
  creation_category: typing.Union[str, IResolvable] = None,
  creation_option: typing.Union[str, IResolvable] = None,
  db_cluster_description: typing.Union[str, IResolvable] = None,
  db_cluster_parameters: typing.Union[IResolvable, DBClusterParametersProperty] = None,
  db_minor_version: typing.Union[str, IResolvable] = None,
  db_node_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  default_time_zone: typing.Union[str, IResolvable] = None,
  gdn_id: typing.Union[str, IResolvable] = None,
  hot_standby_cluster: typing.Union[str, IResolvable] = None,
  loose_polar_log_bin: typing.Union[str, IResolvable] = None,
  loose_x_engine: typing.Union[str, IResolvable] = None,
  loose_x_engine_use_memory_pct: typing.Union[typing.Union[int, float], IResolvable] = None,
  lower_case_table_names: typing.Union[typing.Union[int, float], IResolvable] = None,
  maintain_time: typing.Union[str, IResolvable] = None,
  parameter_group_id: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  proxy_class: typing.Union[str, IResolvable] = None,
  proxy_type: typing.Union[str, IResolvable] = None,
  renewal_status: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  restart_master_node: typing.Union[bool, IResolvable] = None,
  scale_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_min: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_ro_num_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  scale_ro_num_min: typing.Union[typing.Union[int, float], IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  serverless_type: typing.Union[str, IResolvable] = None,
  source_resource_id: typing.Union[str, IResolvable] = None,
  standby_az: typing.Union[str, IResolvable] = None,
  storage_auto_scale: typing.Union[str, IResolvable] = None,
  storage_pay_type: typing.Union[str, IResolvable] = None,
  storage_space: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_type: typing.Union[str, IResolvable] = None,
  storage_upper_bound: typing.Union[typing.Union[int, float], IResolvable] = None,
  strict_consistency: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tde_status: typing.Union[bool, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
db_node_class typing.Union[str, ros_cdk_core.IResolvable] Property dbNodeClass: The node specifications of the cluster.
db_type typing.Union[str, ros_cdk_core.IResolvable] Property dbType: Database type, value: MySQL PostgreSQL Oracle.
db_version typing.Union[str, ros_cdk_core.IResolvable] Property dbVersion: The version of the database.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method of the cluster.
allow_shut_down typing.Union[bool, ros_cdk_core.IResolvable] Property allowShutDown: Whether to turn on No activity pause.
architecture typing.Union[str, ros_cdk_core.IResolvable] Property architecture: The architecture of CPU.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: Set the cluster auto renewal time.
backup_retention_policy_on_cluster_deletion typing.Union[str, ros_cdk_core.IResolvable] Property backupRetentionPolicyOnClusterDeletion: The backup set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.
clone_data_point typing.Union[str, ros_cdk_core.IResolvable] Property cloneDataPoint: The time point of data to be cloned.
cluster_network_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterNetworkType: The network type of the cluster.
cold_storage_option typing.Union[ros_cdk_core.IResolvable, ColdStorageOptionProperty] Property coldStorageOption: The option of cold storage.
creation_category typing.Union[str, ros_cdk_core.IResolvable] Property creationCategory: Cluster series.
creation_option typing.Union[str, ros_cdk_core.IResolvable] Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.
db_cluster_description typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterDescription: The description of the cluster.
db_cluster_parameters typing.Union[ros_cdk_core.IResolvable, DBClusterParametersProperty] Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.
db_minor_version typing.Union[str, ros_cdk_core.IResolvable] Property dbMinorVersion: The minor version of the cluster.
db_node_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dbNodeNum: The number of Standard Edition nodes.
default_time_zone typing.Union[str, ros_cdk_core.IResolvable] Property defaultTimeZone: Set up a time zone (UTC), the value range is as follows: System: The default time zone is the same as the time zone where the region is located.
gdn_id typing.Union[str, ros_cdk_core.IResolvable] Property gdnId: The ID of the Global Database Network (GDN).
hot_standby_cluster typing.Union[str, ros_cdk_core.IResolvable] Property hotStandbyCluster: Specifies whether to enable the hot standby storage cluster feature.
loose_polar_log_bin typing.Union[str, ros_cdk_core.IResolvable] Property loosePolarLogBin: Enable the Binlog function, the value range is as follows: ON: The cluster enables the Binlog function OFF: The cluster disables the Binlog function This parameter takes effect only when the parameter DBType is MySQL.
loose_x_engine typing.Union[str, ros_cdk_core.IResolvable] Property looseXEngine: Enable the X-Engine storage engine function, the value range is as follows: ON: The cluster starts the X-Engine enginen OFF: The cluster shuts down the X-Engine engine This parameter takes effect only when the parameter CreationOption is not equal to CreateGdnStandby, DBType is MySQL and DBVersion is 8.0. The memory specification of the node with X-Engine enabled must be greater than or equal to 16 GB.
loose_x_engine_use_memory_pct typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.
lower_case_table_names typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property lowerCaseTableNames: Whether the table name is case sensitive, the value range is as follows: 1: Not case sensitive0: case sensitive The default value is 1.
maintain_time typing.Union[str, ros_cdk_core.IResolvable] Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.
parameter_group_id typing.Union[str, ros_cdk_core.IResolvable] Property parameterGroupId: The ID of the parameter template.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period of the clusterIf PeriodUnit is month, the valid range is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 If periodUnit is year, the valid range is 1, 2, 3.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the subscription duration.
proxy_class typing.Union[str, ros_cdk_core.IResolvable] Property proxyClass: The specifications of the Standard Edition PolarProxy.
proxy_type typing.Union[str, ros_cdk_core.IResolvable] Property proxyType: The type of PolarProxy.
renewal_status typing.Union[str, ros_cdk_core.IResolvable] Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
restart_master_node typing.Union[bool, ros_cdk_core.IResolvable] Property restartMasterNode: Whether to restart the master node.
scale_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleMax: Maximum limit of single-node scaling.
scale_min typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleMin: Minimum limit of single-node scaling.
scale_ro_num_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.
scale_ro_num_min typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.
security_group_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityGroupIds: The ID of the security group.
security_ip_list typing.Union[str, ros_cdk_core.IResolvable] Property securityIpList: The whitelist of the Apsara PolarDB cluster.
serverless_type typing.Union[str, ros_cdk_core.IResolvable] Property serverlessType: Serverless type.
source_resource_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceResourceId: The ID of the source RDS instance or source POLARDB cluster.
standby_az typing.Union[str, ros_cdk_core.IResolvable] Property standbyAz: The zone where the hot standby storage cluster is stored.
storage_auto_scale typing.Union[str, ros_cdk_core.IResolvable] Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.
storage_pay_type typing.Union[str, ros_cdk_core.IResolvable] Property storagePayType: The storage pay type.
storage_space typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSpace: The storage space that uses the subscription billing method.
storage_type typing.Union[str, ros_cdk_core.IResolvable] Property storageType: The storage type.
storage_upper_bound typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.
strict_consistency typing.Union[str, ros_cdk_core.IResolvable] Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
tde_status typing.Union[bool, ros_cdk_core.IResolvable] Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC to connect to.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch to connect to.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the cluster.

db_node_classRequired 

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

Property dbNodeClass: The node specifications of the cluster.

For more information, see Specifications and pricing.

db_typeRequired 

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

Property dbType: Database type, value: MySQL PostgreSQL Oracle.

db_versionRequired 

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

Property dbVersion: The version of the database.

Valid values: MySQL: 5.6, 5.7 or 8.0 PostgreSQL: 11, 14 Oracle: 11, 14

pay_typeRequired 

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

Property payType: The billing method of the cluster.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription

allow_shut_downOptional 

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

Property allowShutDown: Whether to turn on No activity pause.

The default is false.

architectureOptional 

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

Property architecture: The architecture of CPU.

Valid values: X86 ARM

auto_renew_periodOptional 

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

Property autoRenewPeriod: Set the cluster auto renewal time.

Valid values: 1, 2, 3, 6, 12, 24, 36. Default to 1.

backup_retention_policy_on_cluster_deletionOptional 

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

Property backupRetentionPolicyOnClusterDeletion: The backup set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.

LATEST: Permanently keep the last backup (automatic backup before deletion). NONE: The backup set is not retained when the cluster is deleted. When creating a cluster, the default value is NONE, that is, the backup set is not retained when the cluster is deleted. Note: This parameter takes effect only when the value of DBType is MySQL.

clone_data_pointOptional 

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

Property cloneDataPoint: The time point of data to be cloned.

Valid values: LATEST: clones data of the latest time point. : clones historical backup data. Specify the ID of the specific backup set. : clones data of a historical time point. Specify the specific time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Default value: LATEST. Note This parameter takes effect only when the DBType parameter is set to MySQL, the DBVersion parameter is set to 5.6, and the CreationOption parameter is set to CloneFromRDS or CloneFromPolarDB. If the CreationOption parameter is set to CloneFromRDS, the value of this parameter must be LATEST.

cluster_network_typeOptional 

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

Property clusterNetworkType: The network type of the cluster.

Currently, only VPC is supported. Default value: VPC.

cold_storage_optionOptional 

cold_storage_option: typing.Union[IResolvable, ColdStorageOptionProperty]

Property coldStorageOption: The option of cold storage.

creation_categoryOptional 

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

Property creationCategory: Cluster series.

The value could be Normal (standard version), Basic and ArchiveNormal.

creation_optionOptional 

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

Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.

Valid values: Normal: creates an ApsaraDB for POLARDB cluster. CloneFromPolarDB: clones data from an existing ApsaraDB for POLARDB cluster to a new ApsaraDB for POLARDB cluster. CloneFromRDS: clones data from an existing ApsaraDB for RDS instance to a new ApsaraDB for POLARDB cluster. MigrationFromRDS: migrates data from an existing ApsaraDB for RDS instance to a new ApsaraDB for POLARDB cluster. The created ApsaraDB for POLARDB cluster is in read-only mode and has binary logs enabled by default. CreateGdnStandby: Create a secondary cluster. Default value: Normal. Note: When DBType is MySQL and DBVersion is 5.6, this parameter can be specified as CloneFromRDS or MigrationFromRDS. When DBType is MySQL and DBVersion is 8.0, this parameter can be specified as CreateGdnStandby.

db_cluster_descriptionOptional 

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

Property dbClusterDescription: The description of the cluster.

The description must comply with the following rules: It must start with a Chinese character or an English letter. It can contain Chinese and English characters, digits, underscores (_), and hyphens (-). It cannot start with http:// or https://. It must be 2 to 256 characters in length.

db_cluster_parametersOptional 

db_cluster_parameters: typing.Union[IResolvable, DBClusterParametersProperty]

Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.

db_minor_versionOptional 

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

Property dbMinorVersion: The minor version of the cluster.

Valid values: 8.0.2 8.0.1 This parameter is valid only when the DBType parameter is set to MySQL and the DBVersion parameter is set to 8.0.

db_node_numOptional 

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

Property dbNodeNum: The number of Standard Edition nodes.

Default value: 1. Valid values: 1: only one primary node. 2: one read-only node and one primary node.

default_time_zoneOptional 

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

Property defaultTimeZone: Set up a time zone (UTC), the value range is as follows: System: The default time zone is the same as the time zone where the region is located.

This is default value. Other pickable value range is from -12:00 to +13:00, for example, 00:00. Note: This parameter takes effect only when DBType is MySQL.

gdn_idOptional 

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

Property gdnId: The ID of the Global Database Network (GDN).

Note: This parameter is required when the CreationOption is CreateGdnStandby.

hot_standby_clusterOptional 

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

Property hotStandbyCluster: Specifies whether to enable the hot standby storage cluster feature.

Default value: ON. Valid values: ON: enables the hot standby storage cluster feature. OFF: disables the hot standby storage cluster feature STANDBY: enables the hot standby storage cluster feature only for Standard Edition clusters. The default value for Standard Edition clusters is STANDBY.

loose_polar_log_binOptional 

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

Property loosePolarLogBin: Enable the Binlog function, the value range is as follows: ON: The cluster enables the Binlog function OFF: The cluster disables the Binlog function This parameter takes effect only when the parameter DBType is MySQL.

loose_x_engineOptional 

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

Property looseXEngine: Enable the X-Engine storage engine function, the value range is as follows: ON: The cluster starts the X-Engine enginen OFF: The cluster shuts down the X-Engine engine This parameter takes effect only when the parameter CreationOption is not equal to CreateGdnStandby, DBType is MySQL and DBVersion is 8.0. The memory specification of the node with X-Engine enabled must be greater than or equal to 16 GB.

loose_x_engine_use_memory_pctOptional 

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

Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.

This parameter takes effect only when the parameter LooseXEngine is ON.

lower_case_table_namesOptional 

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

Property lowerCaseTableNames: Whether the table name is case sensitive, the value range is as follows: 1: Not case sensitive0: case sensitive The default value is 1.

Note: This parameter takes effect only when the value of DBType is MySQL.

maintain_timeOptional 

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

Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.

Example: 16:00Z-17:00Z, which means 0 to 1 (UTC+08:00) for routine maintenance.

parameter_group_idOptional 

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

Property parameterGroupId: The ID of the parameter template.

You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.

periodOptional 

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

Property period: The subscription period of the clusterIf PeriodUnit is month, the valid range is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 If periodUnit is year, the valid range is 1, 2, 3.

period_unitOptional 

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

proxy_classOptional 

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

Property proxyClass: The specifications of the Standard Edition PolarProxy.

Valid values: polar.maxscale.g2.medium.c: 2 cores polar.maxscale.g2.large.c: 4 cores polar.maxscale.g2.xlarge.c: 8 cores polar.maxscale.g2.2xlarge.c: 16 cores polar.maxscale.g2.3xlarge.c: 24 cores polar.maxscale.g2.4xlarge.c: 32 cores polar.maxscale.g2.8xlarge.c: 64 cores

proxy_typeOptional 

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

Property proxyType: The type of PolarProxy.

Default value: OFF. Valid values: OFF: disables PolarProxy. EXCLUSIVE: Dedicated Enterprise Edition GENERAL: Standard Enterprise Edition

renewal_statusOptional 

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

Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.

Normal: manually renews the cluster. NotRenewal: does not renew the cluster. Default value: Normal. Note If this parameter is set to NotRenewal, the system does not send a reminder for expiration, but only sends an SMS message three days before the cluster expires to remind you that the cluster is not renewed.

resource_group_idOptional 

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

Property resourceGroupId: The ID of the resource group.

restart_master_nodeOptional 

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

Property restartMasterNode: Whether to restart the master node.

scale_maxOptional 

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

Property scaleMax: Maximum limit of single-node scaling.

scale_minOptional 

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

Property scaleMin: Minimum limit of single-node scaling.

scale_ro_num_maxOptional 

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

Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.

scale_ro_num_minOptional 

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

Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.

security_group_idsOptional 

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

Property securityGroupIds: The ID of the security group.

You can add up to three security groups to a cluster.

security_ip_listOptional 

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

Property securityIpList: The whitelist of the Apsara PolarDB cluster.

serverless_typeOptional 

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

Property serverlessType: Serverless type.

source_resource_idOptional 

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

Property sourceResourceId: The ID of the source RDS instance or source POLARDB cluster.

Note This parameter takes effect only when the DBType parameter is set to MySQL and the DBVersion parameter is set to 5.6. This parameter is required if the CreationOption parameter is not set to Normal.

standby_azOptional 

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

Property standbyAz: The zone where the hot standby storage cluster is stored.

This is valid for Standard Edition clusters of Multi-zone Edition. This parameter takes effect only when the multi-zone data consistency feature is enabled.

storage_auto_scaleOptional 

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

Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.

The value range is as follows: Enable: Enable automatic storage scale. Disable: Disable automatic storage scale.

storage_pay_typeOptional 

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

Property storagePayType: The storage pay type.

storage_spaceOptional 

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

Property storageSpace: The storage space that uses the subscription billing method.

Unit: GB. Valid values for PolarDB for MySQL Standard Edition: 20 to 32000.

storage_typeOptional 

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

Property storageType: The storage type.

Valid values for Enterprise Edition: PSL5 PSL4 Valid values for Standard Edition: ESSDPL1 ESSDPL2 ESSDPL3 This parameter is invalid for serverless clusters.

storage_upper_boundOptional 

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

Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.

The maximum value is 32000.

strict_consistencyOptional 

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

Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.

Valid values: ON: enables the multi-zone data consistency feature, which is valid for Standard Edition clusters of Multi-zone Edition. OFF: disables the multi-zone data consistency feature.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

tde_statusOptional 

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

Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).

Valid values: true: enable TDE false: disable TDE (default) Note: The parameter takes effect only when DBType is PostgreSQL or Oracle. You cannot disable TDE after it is enabled.

vpc_idOptional 

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

Property vpcId: The ID of the VPC to connect to.

v_switch_idOptional 

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

Property vSwitchId: The ID of the VSwitch to connect to.

zone_idOptional 

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

Property zoneId: The zone ID of the cluster.

You can call the DescribeRegions operation to query available zones.