alicloud.polardb.Cluster

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster with MySQL , db_node_class can be set to polar.mysql.sl.small. From version 1.229.1, If you need to create a Serverless cluster with PostgreSQL 14 using the SENormal edition, db_node_class can be set to polar.pg.sl.small.c(x86 Architecture). Region can refer to the latest docs(https://help.aliyun.com/zh/polardb/polardb-for-postgresql/the-public-preview-of-polardb-for-postgresql-serverless-ends?spm=a2c4g.11186623.0.0.2e9f6cf0B4rIfC).

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

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

Enable storage compression function. The value of this parameter is ON. Only MySQL supports.

NOTE: When the value of db_type is not MySQL, the value of creation_option is neither empty nor Normal, and the value of storage_type is not PSL4, this field will be ignored.

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

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster. From version 1.203.0, creation_category can be set to SENormal.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby,RecoverFromRecyclebin. NOTE: From version 1.233.0, creation_option can be set to RecoverFromRecyclebin. Value options can refer to the latest docs CreateDBCluster CreationOption.

• NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby. If creation_option is RecoverFromRecyclebin, you need to pass in the released source PolarDB cluster ID for this parameter. The DBType of the cluster recovered from the recycle bin and the source cluster must be consistent. For example, if the source cluster is MySQL 8.0, the cluster recovered from the recycle bin also needs to have its DBType set to MySQL and DBVersion set to 8.0.

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

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

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

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

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

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

Whether to enable the hot standby cluster. Valid values are ON, OFF, EQUAL.

NOTE: From version 1.249.0, hot_standby_cluster can be set to EQUAL, and this value is only valid for MySQL.

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

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

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

NOTE: This parameter is valid only MySQL Engine supports.

Specifies whether to enable X-Engine. Valid values are ON, OFF.

NOTE: This parameter takes effect only if you do not set creation_option to CreateGdnStandby and you set db_type to MySQL and db_version to 8.0. To enable X-Engine on a node, make sure that the memory of the node is greater than or equal to 8 GB in size.

Set the ratio to enable the X-Engine storage engine. Valid values: 10 to 90.

NOTE: When the parameter loose_xengine is ON, loose_xengine_use_memory_pct takes effect.

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

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

The ID of the parameter template

NOTE: 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.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.

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

NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

NOTE: This parameter is available only if the StorageType parameter is set to ESSDAUTOPL.

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

NOTE: This parameter is valid only for standard edition clusters.

The type of PolarProxy. Valid values are EXCLUSIVE GENERAL.

NOTE: This parameter is valid for both standard and enterprise 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.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

The availability zone where the hot standby cluster is stored, takes effect when hot_standby_cluster is ON or EQUAL.

NOTE: standby_az is required when hot_standby_cluster is EQUAL.

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

NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type is PrePaid.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

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

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

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

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster with MySQL , db_node_class can be set to polar.mysql.sl.small. From version 1.229.1, If you need to create a Serverless cluster with PostgreSQL 14 using the SENormal edition, db_node_class can be set to polar.pg.sl.small.c(x86 Architecture). Region can refer to the latest docs(https://help.aliyun.com/zh/polardb/polardb-for-postgresql/the-public-preview-of-polardb-for-postgresql-serverless-ends?spm=a2c4g.11186623.0.0.2e9f6cf0B4rIfC).

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

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

Enable storage compression function. The value of this parameter is ON. Only MySQL supports.

NOTE: When the value of db_type is not MySQL, the value of creation_option is neither empty nor Normal, and the value of storage_type is not PSL4, this field will be ignored.

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

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster. From version 1.203.0, creation_category can be set to SENormal.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby,RecoverFromRecyclebin. NOTE: From version 1.233.0, creation_option can be set to RecoverFromRecyclebin. Value options can refer to the latest docs CreateDBCluster CreationOption.

• NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby. If creation_option is RecoverFromRecyclebin, you need to pass in the released source PolarDB cluster ID for this parameter. The DBType of the cluster recovered from the recycle bin and the source cluster must be consistent. For example, if the source cluster is MySQL 8.0, the cluster recovered from the recycle bin also needs to have its DBType set to MySQL and DBVersion set to 8.0.

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

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

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

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

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

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

Whether to enable the hot standby cluster. Valid values are ON, OFF, EQUAL.

NOTE: From version 1.249.0, hot_standby_cluster can be set to EQUAL, and this value is only valid for MySQL.

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

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

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

NOTE: This parameter is valid only MySQL Engine supports.

Specifies whether to enable X-Engine. Valid values are ON, OFF.

NOTE: This parameter takes effect only if you do not set creation_option to CreateGdnStandby and you set db_type to MySQL and db_version to 8.0. To enable X-Engine on a node, make sure that the memory of the node is greater than or equal to 8 GB in size.

Set the ratio to enable the X-Engine storage engine. Valid values: 10 to 90.

NOTE: When the parameter loose_xengine is ON, loose_xengine_use_memory_pct takes effect.

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

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

The ID of the parameter template

NOTE: 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.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.

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

NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

NOTE: This parameter is available only if the StorageType parameter is set to ESSDAUTOPL.

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

NOTE: This parameter is valid only for standard edition clusters.

The type of PolarProxy. Valid values are EXCLUSIVE GENERAL.

NOTE: This parameter is valid for both standard and enterprise 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.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

The availability zone where the hot standby cluster is stored, takes effect when hot_standby_cluster is ON or EQUAL.

NOTE: standby_az is required when hot_standby_cluster is EQUAL.

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

NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type is PrePaid.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

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

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

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

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster with MySQL , db_node_class can be set to polar.mysql.sl.small. From version 1.229.1, If you need to create a Serverless cluster with PostgreSQL 14 using the SENormal edition, db_node_class can be set to polar.pg.sl.small.c(x86 Architecture). Region can refer to the latest docs(https://help.aliyun.com/zh/polardb/polardb-for-postgresql/the-public-preview-of-polardb-for-postgresql-serverless-ends?spm=a2c4g.11186623.0.0.2e9f6cf0B4rIfC).

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

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

Enable storage compression function. The value of this parameter is ON. Only MySQL supports.

NOTE: When the value of db_type is not MySQL, the value of creation_option is neither empty nor Normal, and the value of storage_type is not PSL4, this field will be ignored.

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

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster. From version 1.203.0, creation_category can be set to SENormal.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby,RecoverFromRecyclebin. NOTE: From version 1.233.0, creation_option can be set to RecoverFromRecyclebin. Value options can refer to the latest docs CreateDBCluster CreationOption.

• NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby. If creation_option is RecoverFromRecyclebin, you need to pass in the released source PolarDB cluster ID for this parameter. The DBType of the cluster recovered from the recycle bin and the source cluster must be consistent. For example, if the source cluster is MySQL 8.0, the cluster recovered from the recycle bin also needs to have its DBType set to MySQL and DBVersion set to 8.0.

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

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

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

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

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

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

Whether to enable the hot standby cluster. Valid values are ON, OFF, EQUAL.

NOTE: From version 1.249.0, hot_standby_cluster can be set to EQUAL, and this value is only valid for MySQL.

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

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

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

NOTE: This parameter is valid only MySQL Engine supports.

Specifies whether to enable X-Engine. Valid values are ON, OFF.

NOTE: This parameter takes effect only if you do not set creation_option to CreateGdnStandby and you set db_type to MySQL and db_version to 8.0. To enable X-Engine on a node, make sure that the memory of the node is greater than or equal to 8 GB in size.

Set the ratio to enable the X-Engine storage engine. Valid values: 10 to 90.

NOTE: When the parameter loose_xengine is ON, loose_xengine_use_memory_pct takes effect.

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

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

The ID of the parameter template

NOTE: 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.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.

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

NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

NOTE: This parameter is available only if the StorageType parameter is set to ESSDAUTOPL.

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

NOTE: This parameter is valid only for standard edition clusters.

The type of PolarProxy. Valid values are EXCLUSIVE GENERAL.

NOTE: This parameter is valid for both standard and enterprise 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.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

The availability zone where the hot standby cluster is stored, takes effect when hot_standby_cluster is ON or EQUAL.

NOTE: standby_az is required when hot_standby_cluster is EQUAL.

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

NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type is PrePaid.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

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

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

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

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster with MySQL , db_node_class can be set to polar.mysql.sl.small. From version 1.229.1, If you need to create a Serverless cluster with PostgreSQL 14 using the SENormal edition, db_node_class can be set to polar.pg.sl.small.c(x86 Architecture). Region can refer to the latest docs(https://help.aliyun.com/zh/polardb/polardb-for-postgresql/the-public-preview-of-polardb-for-postgresql-serverless-ends?spm=a2c4g.11186623.0.0.2e9f6cf0B4rIfC).

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

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

Enable storage compression function. The value of this parameter is ON. Only MySQL supports.

NOTE: When the value of db_type is not MySQL, the value of creation_option is neither empty nor Normal, and the value of storage_type is not PSL4, this field will be ignored.

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

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster. From version 1.203.0, creation_category can be set to SENormal.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby,RecoverFromRecyclebin. NOTE: From version 1.233.0, creation_option can be set to RecoverFromRecyclebin. Value options can refer to the latest docs CreateDBCluster CreationOption.

• NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby. If creation_option is RecoverFromRecyclebin, you need to pass in the released source PolarDB cluster ID for this parameter. The DBType of the cluster recovered from the recycle bin and the source cluster must be consistent. For example, if the source cluster is MySQL 8.0, the cluster recovered from the recycle bin also needs to have its DBType set to MySQL and DBVersion set to 8.0.

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

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

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

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

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

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

Whether to enable the hot standby cluster. Valid values are ON, OFF, EQUAL.

NOTE: From version 1.249.0, hot_standby_cluster can be set to EQUAL, and this value is only valid for MySQL.

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

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

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

NOTE: This parameter is valid only MySQL Engine supports.

Specifies whether to enable X-Engine. Valid values are ON, OFF.

NOTE: This parameter takes effect only if you do not set creation_option to CreateGdnStandby and you set db_type to MySQL and db_version to 8.0. To enable X-Engine on a node, make sure that the memory of the node is greater than or equal to 8 GB in size.

Set the ratio to enable the X-Engine storage engine. Valid values: 10 to 90.

NOTE: When the parameter loose_xengine is ON, loose_xengine_use_memory_pct takes effect.

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

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

The ID of the parameter template

NOTE: 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.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.

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

NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

NOTE: This parameter is available only if the StorageType parameter is set to ESSDAUTOPL.

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

NOTE: This parameter is valid only for standard edition clusters.

The type of PolarProxy. Valid values are EXCLUSIVE GENERAL.

NOTE: This parameter is valid for both standard and enterprise 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.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

The availability zone where the hot standby cluster is stored, takes effect when hot_standby_cluster is ON or EQUAL.

NOTE: standby_az is required when hot_standby_cluster is EQUAL.

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

NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type is PrePaid.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

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

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

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

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster with MySQL , db_node_class can be set to polar.mysql.sl.small. From version 1.229.1, If you need to create a Serverless cluster with PostgreSQL 14 using the SENormal edition, db_node_class can be set to polar.pg.sl.small.c(x86 Architecture). Region can refer to the latest docs(https://help.aliyun.com/zh/polardb/polardb-for-postgresql/the-public-preview-of-polardb-for-postgresql-serverless-ends?spm=a2c4g.11186623.0.0.2e9f6cf0B4rIfC).

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

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

Enable storage compression function. The value of this parameter is ON. Only MySQL supports.

NOTE: When the value of db_type is not MySQL, the value of creation_option is neither empty nor Normal, and the value of storage_type is not PSL4, this field will be ignored.

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

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster. From version 1.203.0, creation_category can be set to SENormal.

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby,RecoverFromRecyclebin. NOTE: From version 1.233.0, creation_option can be set to RecoverFromRecyclebin. Value options can refer to the latest docs CreateDBCluster CreationOption.

• NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby. If creation_option is RecoverFromRecyclebin, you need to pass in the released source PolarDB cluster ID for this parameter. The DBType of the cluster recovered from the recycle bin and the source cluster must be consistent. For example, if the source cluster is MySQL 8.0, the cluster recovered from the recycle bin also needs to have its DBType set to MySQL and DBVersion set to 8.0.

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

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

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

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

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

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.