@alicloud/polardb20170801 8.4.3 → 9.0.0

package/dist/models/CreateDbclusterRequest.d.ts

@@ -2,7 +2,9 @@ import * as $dara from '@darabonba/typescript';
 export declare class CreateDBClusterRequestTag extends $dara.Model {
     /**
      * @remarks
-     * The tag key. To add multiple tags to the cluster at a time, click **Add** to add tag keys.
+     * The tag key. To add multiple tags to the target cluster at a time, click **Add** to add tag keys.
+     *
+     * > You can add up to 20 tag pairs at a time. `Tag.N.Key` corresponds to `Tag.N.Value`.
      *
      * @example
      * type
@@ -10,7 +12,9 @@ export declare class CreateDBClusterRequestTag extends $dara.Model {
     key?: string;
     /**
      * @remarks
-     * The tag value. To add multiple tags to the cluster at a time, click **Add** to add tag values.
+     * The tag value. To add multiple tags to the target cluster at a time, click **Add** to add tag values.
+     *
+     * > You can add up to 20 tag pairs at a time. `Tag.N.Value` corresponds to `Tag.N.Key`.
      *
      * @example
      * test
@@ -48,6 +52,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The Agentic database engine type. Valid values:
      *
+     * * dedicated
+     *
      * @example
      * dedicated
      */
@@ -56,6 +62,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable No-activity Suspension. Valid values:
      *
+     * - **true**: enables No-activity Suspension.
+     *
+     * - **false**: disables No-activity Suspension (default).
+     * > Only serverless clusters support this parameter.
+     *
      * @example
      * true
      */
@@ -63,6 +74,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The CPU architecture. Valid values:
+     * - X86
+     * - ARM
      *
      * @example
      * X86
@@ -72,6 +85,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable auto-renewal. Valid values:
      *
+     * - **true**: enables auto-renewal.
+     * - **false**: disables auto-renewal.
+     *
+     * Default value: **false**.
+     *
+     * > This parameter takes effect only when **PayType** is set to **Prepaid**.
+     *
      * @example
      * true
      */
@@ -79,6 +99,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * Specifies whether to automatically use coupons. Valid values:
+     * * true (default): Uses coupons.
+     * * false: Does not use coupons.
      *
      * @example
      * true
@@ -86,7 +108,14 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     autoUseCoupon?: boolean;
     /**
      * @remarks
-     * The data retention policy for backups when the cluster is deleted. Valid values:
+     * The data retention policy applied when the cluster is deleted. Valid values:
+     * * **ALL**: long-term retention (LTR) of all backups.
+     * * **LATEST**: long-term retention (LTR) of the last backup (an automatic backup is performed before deletion).
+     * * **NONE**: does not retain backups upon cluster deletion.
+     *
+     * When a cluster is created, the default value is **NONE**, which means backups are not retained upon cluster deletion.
+     * >* This parameter takes effect only when **DBType** is set to **MySQL**.
+     * >* Serverless clusters do not support this parameter.
      *
      * @example
      * NONE
@@ -94,7 +123,12 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     backupRetentionPolicyOnClusterDeletion?: string;
     /**
      * @remarks
-     * Specifies whether to enable I/O performance burst for the ESSD AutoPL cloud disk. Valid values:
+     * Specifies whether to enable I/O performance burst for ESSD AutoPL cloud disks. Valid values:
+     *
+     * - **true**: enables I/O performance burst.
+     * - **false**: does not enable I/O performance burst (default).
+     *
+     * > This parameter is supported only when StorageType is set to ESSDAUTOPL.
      *
      * @example
      * false
@@ -102,7 +136,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     burstingEnabled?: string;
     /**
      * @remarks
-     * The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and is unique among different requests. The value is case-sensitive and cannot exceed 64 ASCII characters in length.
+     * The client token that is used to ensure the idempotence of the request. The token is generated by the client and must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.
      *
      * @example
      * 6000170000591aed949d0f5********************
@@ -112,6 +146,14 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The point in time at which data is cloned. Valid values:
      *
+     * -  **LATEST**: the latest point in time.
+     * - **BackupID**: a historical backup set ID. Set this parameter to the specific backup set ID.
+     * - **Timestamp**: a historical point in time. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
+     *
+     *  Default value: **LATEST**.
+     *
+     * > If **CreationOption** is set to **CloneFromRDS**, this parameter can only be set to **LATEST**.
+     *
      * @example
      * LATEST
      */
@@ -126,7 +168,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     cloudProvider?: string;
     /**
      * @remarks
-     * The network type of the cluster. Currently, only Virtual Private Cloud (VPC) is supported. Set the value to **VPC**.
+     * The network type of the cluster. Only virtual private clouds (VPCs) are supported. Set the value to **VPC**.
      *
      * @example
      * VPC
@@ -135,6 +177,17 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The edition of the cluster. Valid values:
+     * * **Normal**: Cluster Edition (default).
+     * * **Basic**: Single Node Edition.
+     * * **ArchiveNormal**: PolarDB X-Engine Edition.
+     * * **NormalMultimaster**: Multi-master Cluster Edition.
+     * * **SENormal**: Standard Edition.
+     *
+     * > * **MySQL** **5.6**, **5.7**, **8.0**, **PostgreSQL** **14**, and **Oracle syntax-compatible 2.0** support **Basic**.
+     * > * **MySQL** **8.0** supports **ArchiveNormal** and **NormalMultimaster**.
+     * > * **MySQL** **5.6**, **5.7**, **8.0**, and **PostgreSQL** **14** support **SENormal**.
+     *
+     * For more information about editions, see [Product editions](https://help.aliyun.com/document_detail/183258.html).
      *
      * @example
      * Normal
@@ -144,13 +197,45 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The method used to create the cluster. Valid values:
      *
+     * * **Normal**: creates a new PolarDB cluster. For more information about console operations, see the following topics:
+     *
+     *     * [Create a PolarDB for MySQL database cluster](https://help.aliyun.com/document_detail/58769.html)
+     *     * [Create a PolarDB for PostgreSQL database cluster](https://help.aliyun.com/document_detail/118063.html)
+     *     * [Create a PolarDB for PostgreSQL (Compatible with Oracle) database cluster](https://help.aliyun.com/document_detail/118182.html)
+     *
+     * * **CloneFromPolarDB**: clones data from an existing PolarDB cluster to a new PolarDB cluster. For more information about console operations, see the following topics:
+     *
+     *     * [Clone a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/87966.html)
+     *     * [Clone a PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/118108.html)
+     *     * [Clone a PolarDB for PostgreSQL (Compatible with Oracle) cluster](https://help.aliyun.com/document_detail/118221.html)
+     *
+     * * **RecoverFromRecyclebin**: restores data from a released PolarDB cluster to a new PolarDB cluster. For more information about console operations, see the following topics:
+     *
+     *     * [Restore a released PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/164880.html)
+     *     * [Restore a released PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/432844.html)
+     *     * [Restore a released PolarDB for PostgreSQL (Compatible with Oracle) cluster](https://help.aliyun.com/document_detail/424632.html)
+     *
+     * * **CloneFromRDS**: clones data from an existing ApsaraDB RDS instance to a new PolarDB cluster. For more information about console operations, see [Clone an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/121812.html).
+     *
+     * * **MigrationFromRDS**: migrates data from an existing ApsaraDB RDS instance to a new PolarDB cluster. The created PolarDB cluster is in read-only pattern and has Binlog enabled by default. For more information about console operations, see [Upgrade an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/121582.html).
+     *
+     * * **CreateGdnStandby**: creates a secondary cluster. For more information about console operations, see [Add a secondary cluster](https://help.aliyun.com/document_detail/160381.html).
+     *
+     * * **UpgradeFromPolarDB**: performs instance migration and upgrade from PolarDB. For more information about console operations, see [Major engine version upgrade](https://help.aliyun.com/document_detail/459712.html).
+     *
+     * Default value: **Normal**.
+     *
+     * > When **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**, you can set this parameter to **CreateGdnStandby**.
+     *
      * @example
      * Normal
      */
     creationOption?: string;
     /**
      * @remarks
-     * The cluster name. The cluster name must meet the following requirements:
+     * The name of the cluster. The name must meet the following requirements:
+     * * It cannot start with `http://` or `https://`.
+     * * It must be 2 to 256 characters in length.
      *
      * @example
      * test
@@ -160,13 +245,29 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The minor version of the database engine. Valid values:
      *
+     * - **8.0.2**
+     *
+     * - **8.0.1**
+     *
+     * > This parameter takes effect only when **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**.
+     *
      * @example
      * 8.0.1
      */
     DBMinorVersion?: string;
     /**
      * @remarks
-     * The node specifications. For details, see the following topics:
+     * The node specification. For more information, see the following topics:
+     *
+     * - PolarDB for MySQL: [Compute node specifications](https://help.aliyun.com/document_detail/102542.html).
+     * - PolarDB for PostgreSQL (Compatible with Oracle): [Compute node specifications](https://help.aliyun.com/document_detail/207921.html).
+     * - PolarDB for PostgreSQL: [Compute node specifications](https://help.aliyun.com/document_detail/209380.html).
+     *
+     * >  - To create a serverless cluster for PolarDB for MySQL Cluster Edition, set this parameter to **polar.mysql.sl.small**.
+     * > - To create a serverless cluster for PolarDB for MySQL Standard Edition, set this parameter to **polar.mysql.sl.small.c**.
+     * > - To create a serverless cluster for PolarDB for PostgreSQL Cluster Edition, set this parameter to **polar.pg.sl.small**.
+     * > - To create a serverless cluster for PolarDB for PostgreSQL Standard Edition, set this parameter to **polar.pg.sl.small.c**.
+     * > - To create a serverless cluster for PolarDB for PostgreSQL (Compatible with Oracle), set this parameter to **polar.o.sl.small**.
      *
      * @example
      * polar.mysql.x4.medium
@@ -175,6 +276,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The number of nodes for Standard Edition and Enterprise Edition. Valid values:
+     * - Standard Edition: 1 to 8 (supports 1 read/write node and 7 read-only nodes).
+     * - Enterprise Edition: 1 to 16 (supports 1 read/write node and 15 read-only nodes).
+     * > - Enterprise Edition has 2 nodes by default, and Standard Edition has 1 node by default.
+     * > - Only PolarDB for MySQL supports this parameter.
+     * > - Changing the number of nodes for Multi-master Cluster Edition clusters is not supported.
      *
      * @example
      * 1
@@ -182,7 +288,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     DBNodeNum?: number;
     /**
      * @remarks
-     * The database engine type. Valid values:
+     * The type of the database engine. Valid values:
+     *
+     * - **MySQL**
+     * - **PostgreSQL**
+     * - **Oracle**
      *
      * This parameter is required.
      *
@@ -192,7 +302,23 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     DBType?: string;
     /**
      * @remarks
-     * The database engine version.
+     * The database DPI engine version number.
+     * * Valid values for MySQL version number:
+     *     * **5.6**
+     *     * **5.7**
+     *     * **8.0**
+     * * Valid values for PostgreSQL version number:
+     *     * **11**
+     *     * **14**
+     *     * **15**
+     *     <props="china">
+     *
+     *       > To create a serverless cluster for PolarDB for PostgreSQL, only version 14 is supported.
+     *
+     *
+     * * Valid values for Oracle version number:
+     *     * **11**
+     *     * **14**
      *
      * This parameter is required.
      *
@@ -202,7 +328,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     DBVersion?: string;
     /**
      * @remarks
-     * The time zone of the cluster (UTC). The value can be set to any time frame within the range of **-12:00 to +13:00**, such as **00:00**. Default value: **SYSTEM**. The default time zone is the same as the time zone of the region.
+     * The default time zone of the cluster (UTC). The value can be any time frame within the range of **-12:00 to +13:00**, such as **00:00**. Default value: **SYSTEM**, which indicates that the default time zone is the same as the time zone of the region.
+     * > This parameter takes effect only when **DBType** is set to **MySQL**.
      *
      * @example
      * SYSTEM
@@ -210,7 +337,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     defaultTimeZone?: string;
     /**
      * @remarks
-     * The ENS node ID required when creating an ENS database.
+     * The ID of the Edge Node Service (ENS) node. This parameter is required when you create an ENS database.
      *
      * @example
      * vn-hanoi-3
@@ -218,7 +345,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     ensRegionId?: string;
     /**
      * @remarks
-     * The global database network (GDN) ID.
+     * The ID of the Global Database Network (GDN).
+     *
+     * > This parameter is required when **CreationOption** is set to **CreateGdnStandby**.
      *
      * @example
      * gdn-***********
@@ -226,7 +355,14 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     GDNId?: string;
     /**
      * @remarks
-     * Specifies whether the hot standby cluster is enabled. Valid values:
+     * Specifies whether to enable the hot standby cluster. Valid values:
+     *
+     * - **ON** (default): enables the hot standby storage cluster.
+     * - **OFF**: disables the hot standby cluster.
+     * - **STANDBY**: enables the hot standby cluster.
+     * - **EQUAL**: enables both the hot standby storage cluster and the hot standby compute cluster.
+     * - **3AZ**: enables multi-zone strong data consistency.
+     * > **STANDBY** takes effect only for PolarDB for PostgreSQL.
      *
      * @example
      * ON
@@ -236,6 +372,10 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable the Binlog feature. Valid values:
      *
+     * - **ON**: enables the Binlog feature for the cluster.
+     * - **OFF**: disables the Binlog feature for the cluster.
+     * > This parameter takes effect only when **DBType** is set to **MySQL**.
+     *
      * @example
      * ON
      */
@@ -244,6 +384,10 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable the X-Engine storage engine. Valid values:
      *
+     * - **ON**: enables the X-Engine storage engine for the cluster.
+     * - **OFF**: disables the X-Engine storage engine for the cluster.
+     * > This parameter takes effect only when **CreationOption** is not set to **CreateGdnStandby**, **DBType** is set to **MySQL**, and **DBVersion** is set to **8.0**. The memory specification of the node with X-Engine enabled must be 8 GB or more.
+     *
      * @example
      * ON
      */
@@ -251,6 +395,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The percentage of memory allocated to the X-Engine storage engine. Valid values: integers from 10 to 90.
+     * > This parameter takes effect only when **LooseXEngine** is set to **ON**.
      *
      * @example
      * 50
@@ -259,6 +404,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * Specifies whether table names are case-sensitive. Valid values:
+     * * **1**: Table names are case-insensitive.
+     * * **0**: Table names are case-sensitive.
+     *
+     * Default value: **1**.
+     * > This parameter takes effect only when **DBType** is set to **MySQL**.
      *
      * @example
      * 1
@@ -268,7 +418,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The parameter template ID.
+     * The ID of the parameter template.
+     *
+     * > You can call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to query the list of parameter templates in the target region, including parameter template IDs.
      *
      * @example
      * pcpg-**************
@@ -278,6 +430,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The billing method. Valid values:
      *
+     * - **Postpaid**: pay-as-you-go.
+     * - **Prepaid**: subscription.
+     *
      * This parameter is required.
      *
      * @example
@@ -286,7 +441,10 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     payType?: string;
     /**
      * @remarks
-     * This parameter is required when PayType is set to **Prepaid**. Specifies whether the subscription cluster uses a yearly or monthly billing cycle.
+     * This is a required parameter to pass when **PayType** is set to **Prepaid**. Specifies the subscription type of the subscription cluster.
+     *
+     * - **Year**: annual subscription.
+     * - **Month**: monthly subscription.
      *
      * @example
      * Month
@@ -294,7 +452,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     period?: string;
     /**
      * @remarks
-     * The coupon code. If not specified, the default coupon is used.
+     * The coupon code. If you do not specify this parameter, the default coupon is used.
      *
      * @example
      * 727xxxxxx934
@@ -302,7 +460,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     promotionCode?: string;
     /**
      * @remarks
-     * <p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.</p>
+     * <p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>The provisioned read/write IOPS for ESSD AutoPL cloud disks. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.</p>
+     * <p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>Baseline performance = min{1,800 + 50 × capacity, 50000}.</p>
+     * <note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>This parameter is supported only when StorageType is set to ESSDAUTOPL.</note>
      *
      * @example
      * 1000
@@ -312,13 +472,26 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The specification of the database proxy for Standard Edition. 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.
+     *
      * @example
      * polar.maxscale.g2.medium.c
      */
     proxyClass?: string;
     /**
      * @remarks
-     * The database proxy type. Valid values:
+     * The type of the database proxy. Valid values:
+     * - **EXCLUSIVE**: Dedicated Enterprise Edition.
+     * - **GENERAL**: Standard Enterprise Edition.
+     * > The proxy type must match the type that corresponds to the node specifications of the cluster:
+     * > - If the node specifications are General-purpose, set the proxy type to Standard Enterprise Edition.
+     * > - If the node specifications are Dedicated, set the proxy type to Dedicated Enterprise Edition.
      *
      * @example
      * Exclusive
@@ -328,6 +501,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The region ID.
      *
+     * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available regions.
+     *
      * This parameter is required.
      *
      * @example
@@ -336,7 +511,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     regionId?: string;
     /**
      * @remarks
-     * The resource group ID.
+     * The ID of the resource group.
      *
      * @example
      * rg-************
@@ -346,7 +521,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     resourceOwnerId?: number;
     /**
      * @remarks
-     * The maximum scaling limit per node. Valid values: 1 PCU to 32 PCUs.
+     * The maximum scaling limit for a single node. Valid values: 1 PCU to 32 PCU.
+     * > Only serverless clusters support this parameter.
      *
      * @example
      * 3
@@ -354,7 +530,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     scaleMax?: string;
     /**
      * @remarks
-     * The minimum scaling limit per node. Valid values: 1 PCU to 31 PCUs.
+     * The minimum scaling limit for a single node. Valid values: 1 PCU to 31 PCU.
+     *
+     * > Only serverless clusters support this parameter.
      *
      * @example
      * 1
@@ -363,6 +541,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
+     * > Only serverless clusters support this parameter.
      *
      * @example
      * 4
@@ -371,6 +550,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
+     * > Only serverless clusters support this parameter.
      *
      * @example
      * 2
@@ -379,6 +559,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * The IP whitelist of the PolarDB cluster.
+     * > You can configure multiple IP addresses in the whitelist. Separate multiple IP addresses with commas (,).
      *
      * @example
      * 10.***.***.***
@@ -386,7 +567,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     securityIPList?: string;
     /**
      * @remarks
-     * The serverless type. The value is fixed as **AgileServerless**.
+     * The serverless type. Set the value to **AgileServerless** (agile).
+     * > Only serverless clusters support this parameter.
      *
      * @example
      * AgileServerless
@@ -394,7 +576,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     serverlessType?: string;
     /**
      * @remarks
-     * The instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.
+     * Instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.
+     * * If **CreationOption** is set to **MigrationFromRDS** or **CloneFromRDS**, set this parameter to instance ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must run ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 High-availability Edition.
+     *
+     * * If **CreationOption** is set to **CloneFromPolarDB**, set this parameter to instance ID of the source PolarDB cluster. The cloned cluster and the source cluster use the same DBType by default. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the cloned cluster.
+     * * If **CreationOption** is set to **RecoverFromRecyclebin**, set this parameter to instance ID of the released source PolarDB cluster. The restored cluster and the source cluster must use the same DBType. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the restored cluster.
      *
      * @example
      * rm-*************
@@ -402,7 +588,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     sourceResourceId?: string;
     /**
      * @remarks
-     * The UID of the account that owns the source backup set in cross-account backup restoration scenarios.
+     * The UID of the account that owns the source backup set in a cross-account backup restoration scenario.
      *
      * @example
      * 1022xxxxxxxx
@@ -412,13 +598,18 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The zone of the hot standby cluster.
      *
+     * > This parameter takes effect only when the hot standby cluster or multi-zone strong data consistency is enabled.
+     *
      * @example
      * cn-hangzhou-g
      */
     standbyAZ?: string;
     /**
      * @remarks
-     * Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:
+     * Specifies whether to enable automatic storage scaling for Standard Edition clusters. Valid values:
+     *
+     * - Enable: enables automatic storage scaling.
+     * - Disable: disables automatic storage scaling.
      *
      * @example
      * Enable
@@ -427,11 +618,23 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     /**
      * @remarks
      * Specifies whether to enable cloud disk encryption. Valid values:
+     *
+     * - **true**: Enabled.
+     * - **false**: Disabled (default).
+     * > This parameter takes effect only when **DBType** is set to **MySQL**.
+     *
+     * > This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.
      */
     storageEncryption?: boolean;
     /**
      * @remarks
-     * The key ID of the custom Key Management Service (KMS) key for cloud disk encryption in the same region as the instance. Specifying this parameter automatically enables cloud disk encryption, which cannot be disabled after being enabled. Leave this parameter empty to use the default service key for cloud disk encryption.
+     * The ID of a custom encryption key for cloud disk encryption in the same region as the instance. If you specify this parameter, cloud disk encryption is automatically enabled and cannot be disabled. To use the default service key for cloud disk encryption, leave this parameter empty.
+     *
+     * You can view the key ID in the Key Management Service (KMS) console or create a new key.
+     *
+     * > This parameter takes effect only when **DBType** is set to **MySQL**.
+     *
+     * > This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.
      *
      * @example
      * 1022xxxxxxxx
@@ -439,7 +642,10 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     storageEncryptionKey?: string;
     /**
      * @remarks
-     * The billing type for storage. Valid values:
+     * The billing method for storage. Valid values:
+     *
+     * - Postpaid: pay-by-capacity (pay-as-you-go).
+     * - Prepaid: pay-by-space (subscription).
      *
      * @example
      * Prepaid
@@ -447,7 +653,10 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     storagePayType?: string;
     /**
      * @remarks
-     * The storage space for the space-based billing (subscription) plan. Unit: GB.
+     * The storage space for subscription (pay-by-space) billing. Unit: GB.
+     * > - Valid values for PolarDB for MySQL Enterprise Edition: 10 to 50000.
+     * > - Valid values for PolarDB for MySQL Standard Edition: 20 to 64000.
+     * > - When the storage type of Standard Edition is ESSDAUTOPL, valid values are 40 to 64000 with a minimum step of 10, meaning only values such as 40, 50, 60, and so on are accepted.
      *
      * @example
      * 50
@@ -455,7 +664,16 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     storageSpace?: number;
     /**
      * @remarks
-     * The storage type for Enterprise Edition. Valid values:
+     * Valid values for Enterprise Edition storage type:
+     * - **PSL5**
+     * - **PSL4**
+     *
+     * Valid values for Standard Edition storage type:
+     * - **ESSDPL0**
+     * - **ESSDPL1**
+     * - **ESSDPL2**
+     * - **ESSDPL3**
+     * - **ESSDAUTOPL**
      *
      * @example
      * PSL4
@@ -463,7 +681,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     storageType?: string;
     /**
      * @remarks
-     * The upper limit of automatic storage scaling for the Standard Edition cluster. Unit: GB.
+     * The upper limit for automatic storage scaling of Standard Edition clusters. Unit: GB.
+     *
+     * > The maximum value is 32000.
      *
      * @example
      * 800
@@ -471,7 +691,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     storageUpperBound?: number;
     /**
      * @remarks
-     * Specifies whether to enable multi-zone strong data consistency for the cluster. Valid values:
+     * Specifies whether multi-zone strong data consistency is enabled for the cluster. Valid values:
+     *
+     * - **ON**: Multi-zone strong data consistency is enabled. This value applies to the Standard Edition three-zone deployment scenario.
+     *
+     * - **OFF**: Multi-zone strong data consistency is not enabled.
      *
      * @example
      * ON
@@ -481,6 +705,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable Transparent Data Encryption (TDE). Valid values:
      *
+     * - **true**: enables TDE.
+     * - **false**: disables TDE (default).
+     *
+     * > * This parameter takes effect only when **DBType** is set to **PostgreSQL** or **Oracle**.
+     * > * You can call the [ModifyDBClusterTDE](https://help.aliyun.com/document_detail/167982.html) operation to enable TDE for a PolarDB for MySQL cluster.
+     * > * After TDE is enabled, it cannot be disabled.
+     *
      * @example
      * true
      */
@@ -500,7 +731,9 @@ export declare class CreateDBClusterRequest extends $dara.Model {
     targetMinorVersion?: string;
     /**
      * @remarks
-     * This parameter is required when PayType is set to **Prepaid**.
+     * This parameter is required when **PayType** is set to **Prepaid**.
+     * - If **Period** is set to **Month**, **UsedTime** is an integer that ranges from `[1-9]`.
+     * - If **Period** is set to **Year**, **UsedTime** is an integer that ranges from `[1-3]`.
      *
      * @example
      * 1
@@ -518,6 +751,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The vSwitch ID.
      *
+     * > If you specify VPCId, you must also specify VSwitchId.
+     *
      * @example
      * vsw-**********
      */
@@ -526,6 +761,8 @@ export declare class CreateDBClusterRequest extends $dara.Model {
      * @remarks
      * The zone ID.
      *
+     * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available zones.
+     *
      * @example
      * cn-hangzhou-j
      */