Cluster

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

(Available since 1.81.0) PolarDB cluster connection string.

(Available since 1.204.1) PolarDB cluster creation time.

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster,SENormal.Value options can refer to the latest docs CreateDBCluster CreationCategory.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

The db_node_class of cluster node.

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: 2~16.

The ID of the node or node subscript. Node subscript values: 1 to 15.

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

Database type. Value options: MySQL, Oracle, PostgreSQL.

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

The description of cluster.

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

The ID of the global database network (GDN).

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

Specifies whether the table names are case-sensitive. Default value: 1. Valid values are 1, 0.

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

The ID of the parameter template

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See parameters below.

Valid values are PrePaid, PostPaid, Default to PostPaid.

The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: 1~9, 12, 24, 36.

The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).

The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).

(Available since 1.196.0) PolarDB cluster connection port.

The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster ProxyType

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.

Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.

The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverless_type is AgileServerless. Valid values: 1 PCU to 8 PCUs.It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverless_type is AgileServerless. Valid values: 1 PCU to 8 PCUs.It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverless_type is AgileServerless. Valid values: 0 to 7. It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverless_type is AgileServerless. Valid values: 0 to 7 .It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds. This parameter is valid only for serverless clusters.

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

(Available since 1.204.1) PolarDB cluster status.

The billing method of the storage. Valid values Postpaid, Prepaid.

Storage space charged by space (monthly package). Unit: GB.

The storage type of the cluster. Enterprise storage type values are PSL5, PSL4. The standard version storage type values are ESSDPL1, ESSDPL2, ESSDPL3. The standard version only supports MySQL.

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

A mapping of tags to assign to the resource.

(Available since 1.200.0) The region where the TDE key resides.

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.

The id of the VPC.

The virtual switch ID to launch DB instances in one VPC.

The Zone to launch the DB cluster. it supports multiple zone.