@alicloud/polardb20170801 5.6.0 → 5.6.1

package/dist/models/CreateDbclusterRequest.d.ts

@@ -0,0 +1,665 @@
+import * as $dara from '@darabonba/typescript';
+import { CreateDBClusterRequestTag } from "./CreateDbclusterRequestTag";
+export declare class CreateDBClusterRequest extends $dara.Model {
+    /**
+     * @remarks
+     * Whether to enable idle pause. Values:
+     *
+     * - **true**: Enabled
+     *
+     * - **false**: Disabled (default)
+     *
+     * > Only supported by Serverless clusters.
+     *
+     * @example
+     * true
+     */
+    allowShutDown?: string;
+    /**
+     * @remarks
+     * CPU architecture. Available values include:
+     * - X86
+     * - ARM
+     *
+     * @example
+     * X86
+     */
+    architecture?: string;
+    /**
+     * @remarks
+     * Whether to enable auto-renewal, with available values as follows:
+     *
+     * - **true**: Auto-renew.
+     * - **false**: Do not auto-renew.
+     *
+     * The default is **false**.
+     *
+     * > This parameter takes effect only when **PayType** is set to **Prepaid**.
+     *
+     * @example
+     * true
+     */
+    autoRenew?: boolean;
+    /**
+     * @remarks
+     * Backup retention policy upon cluster deletion, with valid values as follows:
+     * * **ALL**: Permanently retain all backups.
+     * * **LATEST**: Permanently retain the latest backup (automatically backed up before deletion).
+     * * **NONE**: Do not retain backup sets upon cluster deletion.
+     *
+     * By default, the value is set to **NONE**, indicating no backup sets are retained upon cluster deletion.
+     * > This parameter applies only when **DBType** is **MySQL**.
+     * > Serverless clusters do not support this parameter.
+     *
+     * @example
+     * NONE
+     */
+    backupRetentionPolicyOnClusterDeletion?: string;
+    /**
+     * @example
+     * false
+     */
+    burstingEnabled?: string;
+    /**
+     * @remarks
+     * Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.
+     *
+     * @example
+     * 6000170000591aed949d0f5********************
+     */
+    clientToken?: string;
+    /**
+     * @remarks
+     * The point in time to clone data, with the following options:
+     *
+     * - **LATEST**: Data from the latest time point.
+     * - **BackupID**: Historical backup set ID, please enter the specific backup set ID.
+     * - **Timestamp**: Historical time point, please enter the specific time in the format `YYYY-MM-DDThh:mm:ssZ` (UTC time).
+     *
+     * The default value is **LATEST**.
+     *
+     * > If **CreationOption** is **CloneFromRDS**, this parameter can only be set to **LATEST**.
+     *
+     * @example
+     * LATEST
+     */
+    cloneDataPoint?: string;
+    /**
+     * @remarks
+     * Cluster network type, currently only VPC is supported, with a fixed value of **VPC**.
+     *
+     * @example
+     * VPC
+     */
+    clusterNetworkType?: string;
+    /**
+     * @remarks
+     * Product series, with valid values as follows:
+     * * **Normal**: Cluster Edition (default)
+     * * **Basic**: Single-node
+     * * **ArchiveNormal**: High Compression Engine (X-Engine)
+     * * **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 product series, see [Product Series](https://help.aliyun.com/document_detail/183258.html).
+     *
+     * @example
+     * Normal
+     */
+    creationCategory?: string;
+    /**
+     * @remarks
+     * Creation method, with the following values supported:
+     *
+     * * **Normal**: Creates a brand new PolarDB cluster. For console operations, refer to the following documents:
+     *     * [Create a PolarDB MySQL Edition Database Cluster](https://help.aliyun.com/document_detail/58769.html)
+     *     * [Create a PolarDB PostgreSQL Edition Database Cluster](https://help.aliyun.com/document_detail/118063.html)
+     *     * [Create a PolarDB PostgreSQL Edition (Oracle Compatible) Database Cluster](https://help.aliyun.com/document_detail/118182.html)
+     *
+     * * **CloneFromPolarDB**: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:
+     *     * [Clone a PolarDB MySQL Edition Cluster](https://help.aliyun.com/document_detail/87966.html)
+     *     * [Clone a PolarDB PostgreSQL Edition Cluster](https://help.aliyun.com/document_detail/118108.html)
+     *     * [Clone a PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](https://help.aliyun.com/document_detail/118221.html)
+     *
+     * * **RecoverFromRecyclebin**: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:
+     *     * [Restore a Released PolarDB MySQL Edition Cluster](https://help.aliyun.com/document_detail/164880.html)
+     *     * [Restore a Released PolarDB PostgreSQL Edition Cluster](https://help.aliyun.com/document_detail/432844.html)
+     *     * [Restore a Released PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](https://help.aliyun.com/document_detail/424632.html)
+     *
+     * * **CloneFromRDS**: Clones data from an existing RDS instance to a new PolarDB cluster. Console operation guide is available at [One-click Clone from RDS MySQL to PolarDB MySQL Edition](https://help.aliyun.com/document_detail/121812.html).
+     *
+     * * **MigrationFromRDS**: Migrates data from an existing RDS instance to a new PolarDB cluster. The created PolarDB cluster operates in read-only mode with Binlog enabled by default. Console operation guide is at [One-click Upgrade from RDS MySQL to PolarDB MySQL Edition](https://help.aliyun.com/document_detail/121582.html).
+     *
+     * * **CreateGdnStandby**: Creates a standby cluster. Console operation guide can be found at [Add Standby Cluster](https://help.aliyun.com/document_detail/160381.html).
+     *
+     * * **UpgradeFromPolarDB**: Upgrades and migrates from PolarDB. Console operation guide is detailed in [Major Version Upgrade](https://help.aliyun.com/document_detail/459712.html).
+     *
+     * The default value is **Normal**.
+     *
+     * > When **DBType** is **MySQL** and **DBVersion** is **8.0**, this parameter can also take the value **CreateGdnStandby**.
+     *
+     * @example
+     * Normal
+     */
+    creationOption?: string;
+    /**
+     * @remarks
+     * Cluster name, which must meet the following requirements:
+     * * Cannot start with `http://` or `https://`.
+     * * Length should be between 2 and 256 characters.
+     *
+     * @example
+     * test
+     */
+    DBClusterDescription?: string;
+    /**
+     * @remarks
+     * Database engine minor version number. Valid values include:
+     *
+     * - **8.0.2**
+     * - **8.0.1**
+     *
+     * > This parameter takes effect only when **DBType** is **MySQL** and **DBVersion** is **8.0**.
+     *
+     * @example
+     * 8.0.1
+     */
+    DBMinorVersion?: string;
+    /**
+     * @remarks
+     * Node specifications. For details, refer to the following documents:
+     *
+     * - PolarDB MySQL Edition: [Compute Node Specifications](https://help.aliyun.com/document_detail/102542.html).
+     * - PolarDB PostgreSQL Edition (Oracle Compatible): [Compute Node Specifications](https://help.aliyun.com/document_detail/207921.html).
+     * - PolarDB PostgreSQL Edition: [Compute Node Specifications](https://help.aliyun.com/document_detail/209380.html).
+     *
+     * > - For a Serverless cluster in PolarDB MySQL, enter **polar.mysql.sl.small**.
+     * <props="china">> - For a Serverless cluster in both PolarDB PostgreSQL (Oracle Compatible) and PolarDB PostgreSQL, enter **polar.pg.sl.small.c**.
+     *
+     * @example
+     * polar.mysql.x4.medium
+     */
+    DBNodeClass?: string;
+    /**
+     * @remarks
+     * The number of nodes. This parameter is supported for Standard Edition clusters. Valid values:
+     *
+     * *   **1** (default): only one primary node.
+     * *   **2**: one read-only node and one primary node.
+     *
+     * >
+     *
+     * *   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 clusters.
+     *
+     * @example
+     * 1
+     */
+    DBNodeNum?: number;
+    /**
+     * @remarks
+     * Database engine type, with available values as follows:
+     *
+     * - **MySQL**
+     * - **PostgreSQL**
+     * - **Oracle**
+     *
+     * This parameter is required.
+     *
+     * @example
+     * MySQL
+     */
+    DBType?: string;
+    /**
+     * @remarks
+     * Database engine version number.
+     * * For MySQL, the version numbers are as follows:
+     *     * **5.6**
+     *     * **5.7**
+     *     * **8.0**
+     * * For PostgreSQL, the version numbers are as follows:
+     *     * **11**
+     *     * **14**
+     *     * **15**
+     *     <props="china">
+     *
+     *       > When creating a Serverless cluster in PolarDB PostgreSQL, only version **14** is supported.
+     *
+     *
+     * * For Oracle, the version numbers are as follows:
+     *     * **11**
+     *     * **14**
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 5.6
+     */
+    DBVersion?: string;
+    /**
+     * @remarks
+     * Cluster timezone (UTC), with selectable values ranging from **-12:00** to **+13:00** at whole-hour intervals, e.g., **00:00**. The default value is **SYSTEM**, which matches the Region\\"s timezone.
+     * > This parameter applies only when **DBType** is **MySQL**.
+     *
+     * @example
+     * SYSTEM
+     */
+    defaultTimeZone?: string;
+    /**
+     * @remarks
+     * Global Database Network (GDN) ID.
+     *
+     * > This parameter is required when **CreationOption** is **CreateGdnStandby**.
+     *
+     * @example
+     * gdn-***********
+     */
+    GDNId?: string;
+    /**
+     * @remarks
+     * Specifies whether to enable the hot standby storage cluster feature. Valid values:
+     *
+     * *   **ON** (default): enables the hot standby storage cluster feature.
+     * *   **OFF**: disables the hot standby storage cluster feature.
+     * *   **STANDBY**: enables the hot standby storage cluster feature for Standard Edition clusters.
+     *
+     * >  The default value for Standard Edition clusters is **STANDBY**.
+     *
+     * @example
+     * ON
+     */
+    hotStandbyCluster?: string;
+    /**
+     * @remarks
+     * Enable Binlog feature, valid values are as follows:
+     * - **ON**: Cluster enables the Binlog feature. - **OFF**: Cluster disables the Binlog feature. > This parameter takes effect only when the **DBType** parameter is set to **MySQL**.
+     *
+     * @example
+     * ON
+     */
+    loosePolarLogBin?: string;
+    /**
+     * @remarks
+     * Enable the X-Engine storage engine feature, with valid values as follows:
+     *
+     * - **ON**: The cluster enables the X-Engine engine.
+     * - **OFF**: The cluster disables the X-Engine engine.
+     * > This parameter is effective only when **CreationOption** is not **CreateGdnStandby**, **DBType** is **MySQL**, and **DBVersion** is **8.0**. The memory specification of nodes that enable the X-Engine engine must be at least 8 GB.
+     *
+     * @example
+     * ON
+     */
+    looseXEngine?: string;
+    /**
+     * @remarks
+     * Set the ratio for enabling the X-Engine storage engine, with a range of integers from 10 to 90.
+     * > This parameter takes effect only when **LooseXEngine** is **ON**.
+     *
+     * @example
+     * 50
+     */
+    looseXEngineUseMemoryPct?: string;
+    /**
+     * @remarks
+     * Whether table names are case-sensitive, with valid values as follows:
+     * * **1**: Case-insensitive
+     * * **0**: Case-sensitive
+     *
+     * The default value is **1**.
+     * > This parameter applies only when **DBType** is **MySQL**.
+     *
+     * @example
+     * 1
+     */
+    lowerCaseTableNames?: string;
+    ownerAccount?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * Parameter template ID.
+     *
+     * > You can view the list of parameter templates in the target region, including the parameter template ID, by calling the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) interface.
+     *
+     * @example
+     * pcpg-**************
+     */
+    parameterGroupId?: string;
+    /**
+     * @remarks
+     * Payment type, with available values as follows:
+     *
+     * - **Postpaid**: Pay-as-you-go.
+     * - **Prepaid**: Subscription (monthly or yearly).
+     *
+     * This parameter is required.
+     *
+     * @example
+     * Postpaid
+     */
+    payType?: string;
+    /**
+     * @remarks
+     * If the payment type is **Prepaid**, this parameter is required. It specifies whether the prepaid cluster is on a monthly or yearly basis.
+     *
+     * - **Year**: Yearly subscription.
+     * - **Month**: Monthly subscription.
+     *
+     * @example
+     * Month
+     */
+    period?: string;
+    /**
+     * @remarks
+     * <p id="p_wyg_t4a_glm">The provisioned read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity-Baseline Performance}.</p>
+     * <p id="p_6de_jxy_k2g">Baseline Performance = min{1,800+50*capacity, 50000}.</p>
+     * <note id="note_7kj_j0o_rgs">This parameter is supported only when StorageType is ESSDAUTOPL.</note>
+     *
+     * @example
+     * 1000
+     */
+    provisionedIops?: number;
+    /**
+     * @remarks
+     * Standard edition database proxy specifications. Values are as follows:
+     *
+     * - **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
+     * Database proxy type, with values including:
+     * - **EXCLUSIVE**: Enterprise Exclusive Edition
+     * - **GENERAL**: Enterprise General Purpose Edition
+     * > The proxy type must match the type of the cluster\\"s node specifications, i.e.,
+     * >- If the node specification is general, the proxy type should be Enterprise General Purpose Edition;
+     * >- If the node specification is dedicated, the proxy type should be Enterprise Exclusive Edition.
+     *
+     * @example
+     * Exclusive
+     */
+    proxyType?: string;
+    /**
+     * @remarks
+     * Region ID.
+     *
+     * > You can view available regions through the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) interface.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @remarks
+     * Resource group ID.
+     *
+     * @example
+     * rg-************
+     */
+    resourceGroupId?: string;
+    resourceOwnerAccount?: string;
+    resourceOwnerId?: number;
+    /**
+     * @remarks
+     * Maximum scaling limit for a single node. The value range is: 1 PCU~32 PCU.
+     *
+     * > Only supported by Serverless clusters.
+     *
+     * @example
+     * 3
+     */
+    scaleMax?: string;
+    /**
+     * @remarks
+     * Minimum scaling limit for a single node. The value range is: 1 PCU~31 PCU.
+     *
+     * > Only supported by Serverless clusters.
+     *
+     * @example
+     * 1
+     */
+    scaleMin?: string;
+    /**
+     * @remarks
+     * Maximum scaling limit for the number of read-only nodes. The value range is: 0~15.
+     *
+     * > Only supported by Serverless clusters.
+     *
+     * @example
+     * 4
+     */
+    scaleRoNumMax?: string;
+    /**
+     * @remarks
+     * Minimum scaling limit for the number of read-only nodes. The value range is: 0~15.
+     *
+     * > Only supported by Serverless clusters.
+     *
+     * @example
+     * 2
+     */
+    scaleRoNumMin?: string;
+    /**
+     * @remarks
+     * PolarDB cluster whitelist IP address.
+     * > Supports configuring multiple whitelist IP addresses, with English commas separating multiple IP addresses.
+     *
+     * @example
+     * 10.***.***.***
+     */
+    securityIPList?: string;
+    /**
+     * @remarks
+     * Serverless type. The current value is fixed to **AgileServerless** (sensitive mode).
+     * > This parameter is only supported by Serverless clusters.
+     *
+     * @example
+     * AgileServerless
+     */
+    serverlessType?: string;
+    /**
+     * @remarks
+     * Source RDS instance ID or source PolarDB cluster ID. This parameter is mandatory only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.
+     * * If **CreationOption** is **MigrationFromRDS** or **CloneFromRDS**, you need to input the source RDS instance ID. The source RDS instance version must be RDS MySQL 5.6, 5.7, or 8.0 High Availability edition.
+     *
+     * * If **CreationOption** is **CloneFromPolarDB**, you need to input the source PolarDB cluster ID. The DBType of the cloned cluster will default to match the source cluster. For example, if the source cluster is MySQL 8.0, the cloned cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.
+     *
+     * * If **CreationOption** is **RecoverFromRecyclebin**, you need to input the released source PolarDB cluster ID. The DBType of the cluster being recovered from the recycle bin must match the source cluster. For example, if the source cluster was MySQL 8.0, the recovered cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.
+     *
+     * @example
+     * rm-*************
+     */
+    sourceResourceId?: string;
+    /**
+     * @remarks
+     * The availability zone where the hot standby cluster is stored. Applicable to the standard edition 3AZ scenario.
+     *
+     * > This parameter takes effect only when multi-zone data strong consistency is enabled.
+     *
+     * @example
+     * cn-hangzhou-g
+     */
+    standbyAZ?: string;
+    /**
+     * @remarks
+     * Whether to enable automatic storage expansion for standard edition clusters, with valid values as follows:
+     *
+     * - Enable: Enables automatic storage expansion.
+     * - Disable: Disables automatic storage expansion.
+     *
+     * @example
+     * Enable
+     */
+    storageAutoScale?: string;
+    /**
+     * @remarks
+     * Specifies whether to enable disk encryption. Valid values:
+     *
+     * *   **true**
+     * *   **false** (default)
+     *
+     * >  This parameter takes effect only when **DBType** is set to **MySQL**.
+     *
+     * >  This parameter takes effect only when **StorageType** is set to one of the Standard Edition storage types.
+     */
+    storageEncryption?: boolean;
+    /**
+     * @remarks
+     * The ID of the custom key that is used for disk encryption in the region in which the instance resides. If this parameter is specified, disk encryption is automatically enabled and cannot be disabled afterwards. If you want to use the default service key for disk encryption, leave this parameter empty.
+     *
+     * You can obtain the ID of the key in the KMS console or create a key.
+     *
+     * >  This parameter takes effect only when **DBType** is set to **MySQL**.
+     *
+     * >  This parameter takes effect only when **StorageType** is set to one of the Standard Edition storage types.
+     */
+    storageEncryptionKey?: string;
+    /**
+     * @remarks
+     * The storage billing type, with valid values as follows:
+     *
+     * - Postpaid: Pay-as-you-go (hourly).
+     * - Prepaid: Pay-per-use based on space (subscription).
+     *
+     * @example
+     * Prepaid
+     */
+    storagePayType?: string;
+    /**
+     * @remarks
+     * The storage that is billed based on the subscription billing method. Unit: GB.
+     *
+     * >
+     *
+     * *   Valid values for the subscription storage capacity of a PolarDB for MySQL Standard Edition cluster: 20 to 32000.
+     *
+     * *   Valid values for the subscription storage capacity of a Standard Edition cluster that uses the ESSD AUTOPL storage type: 40 to 64000, in increments of 10.
+     *
+     * @example
+     * 50
+     */
+    storageSpace?: number;
+    /**
+     * @remarks
+     * Enterprise edition storage types include:
+     * - **PSL5**
+     * - **PSL4**
+     *
+     * Standard edition storage types include:
+     * - **ESSDPL0**
+     * - **ESSDPL1**
+     * - **ESSDPL2**
+     * - **ESSDPL3**
+     * - **ESSDAUTOPL**
+     *
+     * @example
+     * PSL4
+     */
+    storageType?: string;
+    /**
+     * @remarks
+     * Set the upper limit for automatic storage expansion of standard edition clusters, in GB.
+     *
+     * > The maximum value is 32000.
+     *
+     * @example
+     * 800
+     */
+    storageUpperBound?: number;
+    /**
+     * @remarks
+     * Whether the cluster has enabled strong data consistency across multiple zones. Values are as follows:
+     *
+     * - **ON**: Indicates strong data consistency across multiple zones is enabled, applicable to the standard edition 3AZ scenario.
+     *
+     * - **OFF**: Indicates strong data consistency across multiple zones is not enabled.
+     *
+     * @example
+     * ON
+     */
+    strictConsistency?: string;
+    /**
+     * @remarks
+     * Enables TDE encryption. Valid values are as follows:
+     *
+     * - **true**: Enabled.
+     * - **false**: Disabled (default).
+     *
+     * > * This parameter takes effect only when **DBType** is **PostgreSQL** or **Oracle**.
+     * > * You can call the [ModifyDBClusterTDE](https://help.aliyun.com/document_detail/167982.html) interface to enable TDE encryption for a PolarDB MySQL cluster.
+     * > * Once the TDE feature is enabled, it cannot be disabled.
+     *
+     * @example
+     * true
+     */
+    TDEStatus?: boolean;
+    /**
+     * @remarks
+     * List of tags.
+     */
+    tag?: CreateDBClusterRequestTag[];
+    targetMinorVersion?: string;
+    /**
+     * @remarks
+     * If the payment type is **Prepaid**, this parameter is required.
+     * - When **Period** is **Month**, **UsedTime** should be an integer within `[1-9]`.
+     * - When **Period** is **Year**, **UsedTime** should be an integer within `[1-3]`.
+     *
+     * @example
+     * 1
+     */
+    usedTime?: string;
+    /**
+     * @remarks
+     * VPC ID.
+     *
+     * @example
+     * vpc-**********
+     */
+    VPCId?: string;
+    /**
+     * @remarks
+     * Virtual switch ID.
+     *
+     * > If VPCId has been selected, VSwitchId is mandatory.
+     *
+     * @example
+     * vsw-**********
+     */
+    vSwitchId?: string;
+    /**
+     * @remarks
+     * Availability Zone ID.
+     *
+     * > You can view the available zones through the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) interface.
+     *
+     * @example
+     * cn-hangzhou-j
+     */
+    zoneId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}