public static final class CreateDBClusterRequest.Builder extends Object
限定符和类型 | 方法和说明 |
---|---|
CreateDBClusterRequest.Builder |
allowShutDown(String allowShutDown)
Specifies whether to enable the no-activity suspension feature.
|
CreateDBClusterRequest.Builder |
architecture(String architecture)
Architecture.
|
CreateDBClusterRequest.Builder |
autoRenew(Boolean autoRenew)
Specifies whether to enable automatic renewal.
|
CreateDBClusterRequest.Builder |
backupRetentionPolicyOnClusterDeletion(String backupRetentionPolicyOnClusterDeletion)
The retention policy for the backup sets when you delete the cluster.
|
CreateDBClusterRequest |
build() |
CreateDBClusterRequest.Builder |
clientToken(String clientToken)
The client token that is used to ensure the idempotence of the request.
|
CreateDBClusterRequest.Builder |
cloneDataPoint(String cloneDataPoint)
The point in time when you want to clone data.
|
CreateDBClusterRequest.Builder |
clusterNetworkType(String clusterNetworkType)
The network type of the cluster.
|
CreateDBClusterRequest.Builder |
creationCategory(String creationCategory)
The edition of the cluster.
|
CreateDBClusterRequest.Builder |
creationOption(String creationOption)
The method that is used to create a cluster.
|
CreateDBClusterRequest.Builder |
DBClusterDescription(String DBClusterDescription)
The name of the cluster.
|
CreateDBClusterRequest.Builder |
DBMinorVersion(String DBMinorVersion)
The minor version of the database engine.
|
CreateDBClusterRequest.Builder |
DBNodeClass(String DBNodeClass)
The specifications of the node.
|
CreateDBClusterRequest.Builder |
DBNodeNum(Integer DBNodeNum)
标准版节点个数。
|
CreateDBClusterRequest.Builder |
DBType(String DBType)
The type of the database engine.
|
CreateDBClusterRequest.Builder |
DBVersion(String DBVersion)
The version of the database engine.
|
CreateDBClusterRequest.Builder |
defaultTimeZone(String defaultTimeZone)
The time zone of the cluster.
|
CreateDBClusterRequest.Builder |
GDNId(String GDNId)
The ID of the Global Database Network (GDN).
|
CreateDBClusterRequest.Builder |
hotStandbyCluster(String hotStandbyCluster)
HotStandbyCluster.
|
CreateDBClusterRequest.Builder |
loosePolarLogBin(String loosePolarLogBin)
开启Binlog功能,取值范围如下:
- **ON**:集群开启Binlog功能
- **OFF**:集群关闭Binlog功能
> 当参数**DBType**为**MySQL**时,该参数才生效。
|
CreateDBClusterRequest.Builder |
looseXEngine(String looseXEngine)
开启X-Engine存储引擎功能,取值范围如下:
- **ON**:集群开启X-Engine引擎
- **OFF**:集群关闭X-Engine引擎
> 当参数**CreationOption**不等于**CreateGdnStandby**,**DBType**为**MySQL**且**DBVersion**为**8.0**时,该参数才生效。
|
CreateDBClusterRequest.Builder |
looseXEngineUseMemoryPct(String looseXEngineUseMemoryPct)
设置开启X-Engine存储引擎比例,取值范围10~90的整数。
|
CreateDBClusterRequest.Builder |
lowerCaseTableNames(String lowerCaseTableNames)
Specifies whether the table names are case-sensitive.
|
CreateDBClusterRequest.Builder |
ownerAccount(String ownerAccount)
OwnerAccount.
|
CreateDBClusterRequest.Builder |
ownerId(Long ownerId)
OwnerId.
|
CreateDBClusterRequest.Builder |
parameterGroupId(String parameterGroupId)
The ID of the parameter template.
|
CreateDBClusterRequest.Builder |
payType(String payType)
The billing method.
|
CreateDBClusterRequest.Builder |
period(String period)
The subscription type of the subscription cluster.
|
CreateDBClusterRequest.Builder |
provisionedIops(Long provisionedIops)
ProvisionedIops.
|
CreateDBClusterRequest.Builder |
proxyClass(String proxyClass)
标准版数据库代理规格。
|
CreateDBClusterRequest.Builder |
proxyType(String proxyType)
数据库代理类型,取值范围如下:
- **Exclusive**:企业独享版
- **General**:企业通用版
|
CreateDBClusterRequest.Builder |
regionId(String regionId)
The region ID of the cluster.
|
CreateDBClusterRequest.Builder |
resourceGroupId(String resourceGroupId)
The ID of the resource group.
|
CreateDBClusterRequest.Builder |
resourceOwnerAccount(String resourceOwnerAccount)
ResourceOwnerAccount.
|
CreateDBClusterRequest.Builder |
resourceOwnerId(Long resourceOwnerId)
ResourceOwnerId.
|
CreateDBClusterRequest.Builder |
scaleMax(String scaleMax)
The maximum number of PCUs per node for scaling.
|
CreateDBClusterRequest.Builder |
scaleMin(String scaleMin)
The minimum number of PCUs per node for scaling.
|
CreateDBClusterRequest.Builder |
scaleRoNumMax(String scaleRoNumMax)
The maximum number of read-only nodes for scaling.
|
CreateDBClusterRequest.Builder |
scaleRoNumMin(String scaleRoNumMin)
The minimum number of read-only nodes for scaling.
|
CreateDBClusterRequest.Builder |
securityIPList(String securityIPList)
The IP whitelist of the cluster.
|
CreateDBClusterRequest.Builder |
serverlessType(String serverlessType)
The type of the serverless cluster.
|
CreateDBClusterRequest.Builder |
sourceResourceId(String sourceResourceId)
The ID of the source ApsaraDB RDS instance or PolarDB cluster.
|
CreateDBClusterRequest.Builder |
standbyAZ(String standbyAZ)
存储热备集群的可用区。
|
CreateDBClusterRequest.Builder |
storageAutoScale(String storageAutoScale)
StorageAutoScale.
|
CreateDBClusterRequest.Builder |
storagePayType(String storagePayType)
StoragePayType.
|
CreateDBClusterRequest.Builder |
storageSpace(Long storageSpace)
The storage space that uses the subscription billing method.
|
CreateDBClusterRequest.Builder |
storageType(String storageType)
The storage type.
|
CreateDBClusterRequest.Builder |
storageUpperBound(Long storageUpperBound)
StorageUpperBound.
|
CreateDBClusterRequest.Builder |
strictConsistency(String strictConsistency)
集群是否开启了多可用区数据强一致。
|
CreateDBClusterRequest.Builder |
tag(List<CreateDBClusterRequest.Tag> tag)
1
|
CreateDBClusterRequest.Builder |
TDEStatus(Boolean TDEStatus)
Specifies whether to enable transparent data encryption (TDE).
|
CreateDBClusterRequest.Builder |
usedTime(String usedTime)
* If the **Period** parameter is set to **Month**, the **UsedTime** parameter can be set to `1, 2, 3, 4, 5, 6, 7, 8, or 9`.
|
CreateDBClusterRequest.Builder |
VPCId(String VPCId)
The virtual private cloud (VPC) ID of the cluster.
|
CreateDBClusterRequest.Builder |
vSwitchId(String vSwitchId)
The vSwitch ID of the cluster.
|
CreateDBClusterRequest.Builder |
zoneId(String zoneId)
The zone ID of the cluster.
|
public CreateDBClusterRequest.Builder allowShutDown(String allowShutDown)
* **true** * **false** > This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder architecture(String architecture)
public CreateDBClusterRequest.Builder autoRenew(Boolean autoRenew)
* **true** * **false** Default value: **false**. > This parameter is valid only when the **PayType** parameter is set to **Prepaid**.
public CreateDBClusterRequest.Builder backupRetentionPolicyOnClusterDeletion(String backupRetentionPolicyOnClusterDeletion)
* **ALL**: permanently retains all backups. * **LATEST**: permanently retains the last backup. A backup is automatically created before you delete the cluster. * **NONE**: No backup sets are retained after the cluster is deleted. The default value is **NONE** after you create a cluster. > * This parameter is valid only when the **DBType** parameter is set to **MySQL**. * This parameter is invalid for serverless clusters.
public CreateDBClusterRequest.Builder clientToken(String clientToken)
public CreateDBClusterRequest.Builder cloneDataPoint(String cloneDataPoint)
* **LATEST**: The data of the latest point in time is cloned. * **BackupID**: You can specify the ID of a backup set. In this case, data is cloned based on the specified backup set. * **Timestamp**: You can specify a point in time in the past in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Default value: **LATEST**. > If the **CreationOption** parameter is set to **CloneFromRDS**, the value of this parameter must be **LATEST**.
public CreateDBClusterRequest.Builder clusterNetworkType(String clusterNetworkType)
public CreateDBClusterRequest.Builder creationCategory(String creationCategory)
* **Normal**: Cluster Edition * **Basic**: Single Node Edition * **ArchiveNormal**: X-Engine Edition * **NormalMultimaster**: Multi-master Cluster Edition > * Only when the **DBType** parameter is set to **MySQL** and **the DBVersion** parameter is set to **5.6**, **5.7**, or **8.0**, you can set this parameter to **Basic**. * Only when the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**, you can set this parameter to **ArchiveNormal** or **NormalMultimaster**. For more information, see [Product editions](~~183258~~).
public CreateDBClusterRequest.Builder creationOption(String creationOption)
* **Normal**: creates a PolarDB cluster. For more information about how to perform this operation in the console, see the following topics: * [Create a PolarDB for MySQL cluster](~~58769~~) * [Create a PolarDB for PostgreSQL cluster](~~118063~~) * [Create a PolarDB for Oracle cluster](~~118182~~) * **CloneFromPolarDB**: clones data from an existing PolarDB cluster to a new PolarDB cluster. For more information about how to perform this operation in the console, see the following topics: * [Clone a PolarDB for MySQL cluster](~~87966~~) * [Clone a PolarDB for PostgreSQL cluster](~~118108~~) * [Clone a PolarDB for Oracle cluster](~~118221~~) * **CloneFromRDS**: clones data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB for MySQL cluster. For more information about how to perform this operation in the console, see [Create a PolarDB for MySQL cluster by cloning an ApsaraDB RDS for MySQL instance](~~121812~~). * **MigrationFromRDS**: migrates data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB for MySQL cluster. By default, the created PolarDB cluster is in read-only mode, and the binary logging feature is enabled. For more information about how to perform this operation in the console, see [Create a PolarDB for MySQL cluster from an ApsaraDB RDS for MySQL instance](~~121582~~). * **CreateGdnStandby**: creates a secondary cluster. For more information about how to perform this operation in the console, see [Add a secondary cluster](~~160381~~). Default value: **Normal**. > * If the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **5.6** or **5.7**, this parameter can be set to **CloneFromRDS** or **MigrationFromRDS**. * If the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**, this parameter can be set to **CreateGdnStandby**.
public CreateDBClusterRequest.Builder DBClusterDescription(String DBClusterDescription)
* It cannot start with `http://` or `https://`. * It must be 2 to 256 characters in length.
public CreateDBClusterRequest.Builder DBMinorVersion(String DBMinorVersion)
* **8.0.2** * **8.0.1** > This parameter is valid only when the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**.
public CreateDBClusterRequest.Builder DBNodeClass(String DBNodeClass)
* For more information about specifications supported by PolarDB for MySQL, see [Specifications of compute nodes](~~102542~~). * For information about node specifications supported by the Oracle database engine, see [Specifications of compute nodes](~~207921~~). * For information about node specifications supported by the PostgreSQL database engine, see [Specifications of compute nodes](~~209380~~).
public CreateDBClusterRequest.Builder DBNodeNum(Integer DBNodeNum)
public CreateDBClusterRequest.Builder DBType(String DBType)
* **MySQL** * **PostgreSQL** * **Oracle**
public CreateDBClusterRequest.Builder DBVersion(String DBVersion)
* Valid values for the MySQL database engine: * **5.6** * **5.7** * **8.0** * Valid values for the PostgreSQL database engine: * **11** * **14** * Valid value for the Oracle database engine: **11**
public CreateDBClusterRequest.Builder defaultTimeZone(String defaultTimeZone)
> This parameter is valid only when the **DBType** parameter is set to **MySQL**.
public CreateDBClusterRequest.Builder GDNId(String GDNId)
> This parameter is required only when the **CreationOption** parameter is set to **CreateGdnStandby**.
public CreateDBClusterRequest.Builder hotStandbyCluster(String hotStandbyCluster)
public CreateDBClusterRequest.Builder loosePolarLogBin(String loosePolarLogBin)
- **ON**:集群开启Binlog功能 - **OFF**:集群关闭Binlog功能 > 当参数**DBType**为**MySQL**时,该参数才生效。
public CreateDBClusterRequest.Builder looseXEngine(String looseXEngine)
- **ON**:集群开启X-Engine引擎 - **OFF**:集群关闭X-Engine引擎 > 当参数**CreationOption**不等于**CreateGdnStandby**,**DBType**为**MySQL**且**DBVersion**为**8.0**时,该参数才生效。开启X-Engine引擎的节点内存规格必须大于等于16 GB。
public CreateDBClusterRequest.Builder looseXEngineUseMemoryPct(String looseXEngineUseMemoryPct)
> 当参数**LooseXEngine**为**ON**时,该参数才生效。
public CreateDBClusterRequest.Builder lowerCaseTableNames(String lowerCaseTableNames)
* **1**: The table names are case-insensitive. * **0**: The table names are case-sensitive. Default value: **1**. > This parameter is valid only when the **DBType** parameter is set to **MySQL**.
public CreateDBClusterRequest.Builder ownerAccount(String ownerAccount)
public CreateDBClusterRequest.Builder ownerId(Long ownerId)
public CreateDBClusterRequest.Builder parameterGroupId(String parameterGroupId)
> You can call the [DescribeParameterGroups](~~207178~~) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
public CreateDBClusterRequest.Builder payType(String payType)
* **Postpaid**: pay-as-you-go * **Prepaid**: subscription
public CreateDBClusterRequest.Builder period(String period)
* **Year**: annual subscription. Unit: years. * **Month**: monthly subscription. Unit: months.
public CreateDBClusterRequest.Builder provisionedIops(Long provisionedIops)
public CreateDBClusterRequest.Builder proxyClass(String proxyClass)
public CreateDBClusterRequest.Builder proxyType(String proxyType)
- **Exclusive**:企业独享版 - **General**:企业通用版
public CreateDBClusterRequest.Builder regionId(String regionId)
> You can call the [DescribeRegions](~~98041~~) operation to query available regions.
public CreateDBClusterRequest.Builder resourceGroupId(String resourceGroupId)
public CreateDBClusterRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
public CreateDBClusterRequest.Builder resourceOwnerId(Long resourceOwnerId)
public CreateDBClusterRequest.Builder scaleMax(String scaleMax)
> This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder scaleMin(String scaleMin)
> This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder scaleRoNumMax(String scaleRoNumMax)
> This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder scaleRoNumMin(String scaleRoNumMin)
> This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder securityIPList(String securityIPList)
> The whitelist can contain multiple IP addresses. Separate multiple IP addresses with commas (,).
public CreateDBClusterRequest.Builder serverlessType(String serverlessType)
> This parameter is valid only for serverless clusters.
public CreateDBClusterRequest.Builder sourceResourceId(String sourceResourceId)
* If the **CreationOption** parameter is set to **MigrationFromRDS** or **CloneFromRDS**, you must set this parameter to the ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must use ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 High-availability Edition. * If the **CreationOption** parameter is set to **CloneFromPolarDB**, you must set this parameter to the ID of the source PolarDB cluster. By default, the value of DBType of the destination cluster must be the same as that of the source cluster. For example, if a MySQL 8.0 cluster is used as the source cluster, you must set the **DBType** parameter to **MySQL** and the **DBVersion** parameter to **8.0** for the destination cluster.
public CreateDBClusterRequest.Builder standbyAZ(String standbyAZ)
> 开启了多可用区数据强一致,该参数才生效。
public CreateDBClusterRequest.Builder storageAutoScale(String storageAutoScale)
public CreateDBClusterRequest.Builder storagePayType(String storagePayType)
public CreateDBClusterRequest.Builder storageSpace(Long storageSpace)
public CreateDBClusterRequest.Builder storageType(String storageType)
* **PSL5** * **PSL4** Valid values for Standard Edition: * **ESSDPL1** * **ESSDPL2** * **ESSDPL3** > This parameter is invalid for serverless clusters.
public CreateDBClusterRequest.Builder storageUpperBound(Long storageUpperBound)
public CreateDBClusterRequest.Builder strictConsistency(String strictConsistency)
- **ON**:表示开启了多可用区数据强一致,适用于标准版3AZ场景。 - **OFF**:表示未开启多可用区数据强一致。
public CreateDBClusterRequest.Builder TDEStatus(Boolean TDEStatus)
* **true** * **false** > * This parameter is valid only when the **DBType** parameter is set to **PostgreSQL** or **Oracle**. * You can call the [ModifyDBClusterTDE](~~167982~~) operation to enable TDE for a PolarDB for MySQL cluster. * TDE cannot be disabled after it is enabled.
public CreateDBClusterRequest.Builder tag(List<CreateDBClusterRequest.Tag> tag)
public CreateDBClusterRequest.Builder usedTime(String usedTime)
* If the **Period** parameter is set to **Year**, the **UsedTime** parameter can be set to `1, 2, or 3`.
public CreateDBClusterRequest.Builder VPCId(String VPCId)
public CreateDBClusterRequest.Builder vSwitchId(String vSwitchId)
> If the VPCId parameter is specified, the VSwitchId parameter is required.
public CreateDBClusterRequest.Builder zoneId(String zoneId)
> You can call the [DescribeRegions](~~98041~~) operation to query available zones.
public CreateDBClusterRequest build()
Copyright © 2024. All rights reserved.