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,
  deletion_protection: typing.Union[bool, 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,
  provisioned_iops: typing.Union[typing.Union[int, float], 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,
  ssl_enabled: 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 specification.
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 engine.
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: Specifies whether to enable pause on inactivity.
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 retention policy to apply when the cluster is deleted.
clone_data_point typing.Union[str, ros_cdk_core.IResolvable] Property cloneDataPoint: The point in time for the clone.
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: The edition of the cluster.
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 nodes for a Standard Edition or Enterprise Edition cluster.
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.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
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 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: Specifies whether to enable the X-Engine storage engine.
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.
provisioned_iops typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.
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 the database proxy.
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: The maximum number of PCUs for a single-node serverless cluster to scale up to.
scale_min typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleMin: The minimum number of PolarDB compute units (PCUs) for a single-node serverless cluster to scale down to.
scale_ro_num_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleRoNumMax: The maximum number of read-only nodes that the serverless cluster scales up to.
scale_ro_num_min typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property scaleRoNumMin: The minimum number of read-only nodes that the serverless cluster scales down to.
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 IP whitelist of the 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 ApsaraDB RDS instance or source PolarDB cluster.
ssl_enabled typing.Union[str, ros_cdk_core.IResolvable] Property sslEnabled: Modifies the SSL status.
standby_az typing.Union[str, ros_cdk_core.IResolvable] Property standbyAz: The zone for the hot standby cluster.
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 billing method for storage.
storage_space typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSpace: The storage space for a pay-by-space (subscription) cluster.
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.
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 specification.

For more information, see the following topics:

  • PolarDB for MySQL: Compute node specifications
  • PolarDB for PostgreSQL (compatible with Oracle): Compute node specifications
  • PolarDB for PostgreSQL: Compute node specifications
  • To create a PolarDB for MySQL Cluster Edition serverless cluster, set this parameter to polar.mysql.sl.small.
  • To create a PolarDB for MySQL Standard Edition serverless cluster, set this parameter to polar.mysql.sl.small.c.
  • To create a PolarDB for PostgreSQL Cluster Edition serverless cluster, set this parameter to polar.pg.sl.small.
  • To create a PolarDB for PostgreSQL Standard Edition serverless cluster, set this parameter to polar.pg.sl.small.c.
  • To create a PolarDB for PostgreSQL (compatible with Oracle) serverless cluster, set this parameter to polar.o.sl.small.

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 engine.

  • Valid values for MySQL:
  • 5.6
  • 5.7
  • 8.0
  • Valid values for PostgreSQL:
  • 11
  • 14
  • 15

If you create a serverless cluster for PolarDB for PostgreSQL, you must set this parameter to 14. * Valid values for 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: Specifies whether to enable pause on inactivity.

Valid values:

  • true: enables pause on inactivity.
  • false (default): disables pause on inactivity.

This parameter is supported only for serverless clusters.


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 retention policy to apply when the cluster is deleted.

Valid values:

  • ALL: retains all backup sets.
  • LATEST: retains only the last backup set. An automatic backup is performed before the cluster is deleted.
  • NONE: does not retain backup sets. Default value: NONE.
  • This parameter is valid only if DBType is set to MySQL.
  • Serverless clusters do not support this parameter.

clone_data_pointOptional

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

Property cloneDataPoint: The point in time for the clone.

Valid values:

  • LATEST: The latest point in time.
  • BackupID: The ID of a historical backup set.
  • Timestamp: A specific point in time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. Default value: LATEST.

If you set CreationOption to CloneFromRDS, you can set this parameter only to 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: The edition of the cluster.

Valid values:

  • Normal: Cluster Edition (default)
  • Basic: Single-node Edition
  • ArchiveNormal: X-Engine Edition
  • NormalMultimaster: Multi-master Cluster Edition
  • SENormal: Standard Edition
  • The Basic edition is supported for PolarDB for MySQL 5.6, 5.7, and 8.0; PolarDB for PostgreSQL 14; and PolarDB for PostgreSQL (compatible with Oracle) 2.0.
  • The ArchiveNormal and NormalMultimaster editions are supported for PolarDB for MySQL 8.0.
  • The SENormal edition is supported for PolarDB for MySQL 5.6, 5.7, and 8.0 and PolarDB for PostgreSQL 14.

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. RecoverFromRecyclebin: Recovers data from the freed PolarDB cluster to the new PolarDB cluster. UpgradeFromPolarDB: Upgrade migration from PolarDB. 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 nodes for a Standard Edition or Enterprise Edition cluster.

Valid values:

  • Standard Edition: 1 to 8. A cluster of this edition includes one read/write node and up to seven read-only nodes.
  • Enterprise Edition: 1 to 16. A cluster of this edition includes one read/write node and up to 15 read-only nodes.
  • By default, an Enterprise Edition cluster has two nodes and a Standard Edition cluster has one node.
  • This parameter is supported only for PolarDB for MySQL.
  • You cannot change the number of nodes in a Multi-master Cluster Edition cluster.

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.


deletion_protectionOptional

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

Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.

Default is false.


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 cluster feature.

Valid values:

  • ON (default): enables a hot standby storage cluster.
  • OFF: disables the hot standby cluster feature.
  • STANDBY: enables a hot standby cluster.
  • EQUAL: enables hot standby for both storage and computing resources.
  • 3AZ: enables multi-AZ strong consistency.

The value STANDBY is valid only for PolarDB for PostgreSQL.


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: Specifies whether to enable the X-Engine storage engine.

Valid values:

  • ON: enables the X-Engine storage engine.
  • OFF: disables the X-Engine storage engine.

This parameter is valid only if the CreationOption parameter is not set to CreateGdnStandby, DBType is set to MySQL, and DBVersion is set to 8.0. To enable the X-Engine storage engine, the node must have at least 8 GB of memory.


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.


provisioned_iopsOptional

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

Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.

Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}.


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 the database proxy.

Valid values:

  • EXCLUSIVE: Enterprise Dedicated
  • GENERAL: Enterprise General-purpose

The proxy type must be consistent with the type that corresponds to the node specification of the cluster:

  • If the node specification is general-purpose, the proxy type must be Enterprise General-purpose.
  • If the node specification is dedicated, the proxy type must be Enterprise Dedicated.

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: The maximum number of PCUs for a single-node serverless cluster to scale up to.

Valid values: 1 to 32.

This parameter is supported only for serverless clusters.


scale_minOptional

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

Property scaleMin: The minimum number of PolarDB compute units (PCUs) for a single-node serverless cluster to scale down to.

Valid values: 1 to 31.

This parameter is supported only for serverless clusters.


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 number of read-only nodes that the serverless cluster scales up to.

Valid values: 0 to 15.

This parameter is supported only for serverless clusters.


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 number of read-only nodes that the serverless cluster scales down to.

Valid values: 0 to 15.

This parameter is supported only for serverless clusters.


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 IP whitelist of the PolarDB cluster.

You can specify multiple IP addresses in the IP whitelist. Separate the IP addresses with commas (,).


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 ApsaraDB RDS instance or source PolarDB cluster.

This parameter is required only if CreationOption is set to MigrationFromRDS, CloneFromRDS, CloneFromPolarDB, or RecoverFromRecyclebin.

  • If CreationOption is set to MigrationFromRDS or CloneFromRDS, specify the ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must be ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 High-availability Edition.
  • If CreationOption is set to CloneFromPolarDB, specify the ID of the source PolarDB cluster. The new cluster must use the same database engine as the source cluster. For example, if the source cluster runs MySQL 8.0, you must set DBType to MySQL and DBVersion to 8.0 for the new cluster.
  • If CreationOption is set to RecoverFromRecyclebin, specify the ID of the released source PolarDB cluster. The restored cluster must use the same database engine as the source cluster.

ssl_enabledOptional

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

Property sslEnabled: Modifies the SSL status.

Valid values: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.


standby_azOptional

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

Property standbyAz: The zone for the hot standby cluster.

This parameter is valid only when the hot standby cluster feature or multi-AZ strong consistency 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 billing method for storage.

Valid values:

  • Postpaid: pay-by-capacity (a pay-as-you-go method).
  • Prepaid: pay-by-space (a subscription method).

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 for a pay-by-space (subscription) cluster.

Unit: GB.

  • Valid values for a PolarDB for MySQL Enterprise Edition cluster: 10 to 50000.
  • Valid values for a PolarDB for MySQL Standard Edition cluster: 20 to 64000.
  • If the storage type of a Standard Edition cluster is ESSD AutoPL, the storage space must be a multiple of 10 between 40 and 64000.

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: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL 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.

If you specify the VPCId parameter, you must also specify this parameter.


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.