Skip to content

DBClusterProps

Properties for defining a DBCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbcluster

Initializer

import com.aliyun.ros.cdk.polardb.DBClusterProps;
DBClusterProps.builder()
    .dbNodeClass(java.lang.String)
    .dbNodeClass(IResolvable)
    .dbType(java.lang.String)
    .dbType(IResolvable)
    .dbVersion(java.lang.String)
    .dbVersion(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
//  .allowShutDown(java.lang.Boolean)
//  .allowShutDown(IResolvable)
//  .architecture(java.lang.String)
//  .architecture(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .backupRetentionPolicyOnClusterDeletion(java.lang.String)
//  .backupRetentionPolicyOnClusterDeletion(IResolvable)
//  .cloneDataPoint(java.lang.String)
//  .cloneDataPoint(IResolvable)
//  .clusterNetworkType(java.lang.String)
//  .clusterNetworkType(IResolvable)
//  .coldStorageOption(IResolvable)
//  .coldStorageOption(ColdStorageOptionProperty)
//  .creationCategory(java.lang.String)
//  .creationCategory(IResolvable)
//  .creationOption(java.lang.String)
//  .creationOption(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .dbClusterParameters(IResolvable)
//  .dbClusterParameters(DBClusterParametersProperty)
//  .dbMinorVersion(java.lang.String)
//  .dbMinorVersion(IResolvable)
//  .dbNodeNum(java.lang.Number)
//  .dbNodeNum(IResolvable)
//  .defaultTimeZone(java.lang.String)
//  .defaultTimeZone(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .gdnId(java.lang.String)
//  .gdnId(IResolvable)
//  .hotStandbyCluster(java.lang.String)
//  .hotStandbyCluster(IResolvable)
//  .loosePolarLogBin(java.lang.String)
//  .loosePolarLogBin(IResolvable)
//  .looseXEngine(java.lang.String)
//  .looseXEngine(IResolvable)
//  .looseXEngineUseMemoryPct(java.lang.Number)
//  .looseXEngineUseMemoryPct(IResolvable)
//  .lowerCaseTableNames(java.lang.Number)
//  .lowerCaseTableNames(IResolvable)
//  .maintainTime(java.lang.String)
//  .maintainTime(IResolvable)
//  .parameterGroupId(java.lang.String)
//  .parameterGroupId(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .provisionedIops(java.lang.Number)
//  .provisionedIops(IResolvable)
//  .proxyClass(java.lang.String)
//  .proxyClass(IResolvable)
//  .proxyType(java.lang.String)
//  .proxyType(IResolvable)
//  .renewalStatus(java.lang.String)
//  .renewalStatus(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restartMasterNode(java.lang.Boolean)
//  .restartMasterNode(IResolvable)
//  .scaleMax(java.lang.Number)
//  .scaleMax(IResolvable)
//  .scaleMin(java.lang.Number)
//  .scaleMin(IResolvable)
//  .scaleRoNumMax(java.lang.Number)
//  .scaleRoNumMax(IResolvable)
//  .scaleRoNumMin(java.lang.Number)
//  .scaleRoNumMin(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .securityIpList(java.lang.String)
//  .securityIpList(IResolvable)
//  .serverlessType(java.lang.String)
//  .serverlessType(IResolvable)
//  .sourceResourceId(java.lang.String)
//  .sourceResourceId(IResolvable)
//  .sslEnabled(java.lang.String)
//  .sslEnabled(IResolvable)
//  .standbyAz(java.lang.String)
//  .standbyAz(IResolvable)
//  .storageAutoScale(java.lang.String)
//  .storageAutoScale(IResolvable)
//  .storagePayType(java.lang.String)
//  .storagePayType(IResolvable)
//  .storageSpace(java.lang.Number)
//  .storageSpace(IResolvable)
//  .storageType(java.lang.String)
//  .storageType(IResolvable)
//  .storageUpperBound(java.lang.Number)
//  .storageUpperBound(IResolvable)
//  .strictConsistency(java.lang.String)
//  .strictConsistency(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tdeStatus(java.lang.Boolean)
//  .tdeStatus(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
dbNodeClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeClass: The node specification.
dbType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbType: Database type, value: MySQL PostgreSQL Oracle.
dbVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbVersion: The version of the database engine.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the cluster.
allowShutDown java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property allowShutDown: Specifies whether to enable pause on inactivity.
architecture java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property architecture: The architecture of CPU.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: Set the cluster auto renewal time.
backupRetentionPolicyOnClusterDeletion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupRetentionPolicyOnClusterDeletion: The backup retention policy to apply when the cluster is deleted.
cloneDataPoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cloneDataPoint: The point in time for the clone.
clusterNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterNetworkType: The network type of the cluster.
coldStorageOption com.aliyun.ros.cdk.core.IResolvable OR ColdStorageOptionProperty Property coldStorageOption: The option of cold storage.
creationCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property creationCategory: The edition of the cluster.
creationOption java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterDescription: The description of the cluster.
dbClusterParameters com.aliyun.ros.cdk.core.IResolvable OR DBClusterParametersProperty Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.
dbMinorVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbMinorVersion: The minor version of the cluster.
dbNodeNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeNum: The number of nodes for a Standard Edition or Enterprise Edition cluster.
defaultTimeZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property defaultTimeZone: Set up a time zone (UTC), the value range is as follows: System: The default time zone is the same as the time zone where the region is located.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
gdnId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property gdnId: The ID of the Global Database Network (GDN).
hotStandbyCluster java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hotStandbyCluster: Specifies whether to enable the hot standby cluster feature.
loosePolarLogBin java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loosePolarLogBin: Enable the Binlog function, the value range is as follows: ON: The cluster enables the Binlog function OFF: The cluster disables the Binlog function This parameter takes effect only when the parameter DBType is MySQL.
looseXEngine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property looseXEngine: Specifies whether to enable the X-Engine storage engine.
looseXEngineUseMemoryPct java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.
lowerCaseTableNames java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property lowerCaseTableNames: Whether the table name is case sensitive, the value range is as follows: 1: Not case sensitive0: case sensitive The default value is 1.
maintainTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.
parameterGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property parameterGroupId: The ID of the parameter template.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the clusterIf PeriodUnit is month, the valid range is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 If periodUnit is year, the valid range is 1, 2, 3.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The unit of the subscription duration.
provisionedIops java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.
proxyClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property proxyClass: The specifications of the Standard Edition PolarProxy.
proxyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property proxyType: The type of the database proxy.
renewalStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
restartMasterNode java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property restartMasterNode: Whether to restart the master node.
scaleMax java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleMax: The maximum number of PCUs for a single-node serverless cluster to scale up to.
scaleMin java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleMin: The minimum number of PolarDB compute units (PCUs) for a single-node serverless cluster to scale down to.
scaleRoNumMax java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleRoNumMax: The maximum number of read-only nodes that the serverless cluster scales up to.
scaleRoNumMin java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleRoNumMin: The minimum number of read-only nodes that the serverless cluster scales down to.
securityGroupIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityGroupIds: The ID of the security group.
securityIpList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityIpList: The IP whitelist of the PolarDB cluster.
serverlessType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serverlessType: Serverless type.
sourceResourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceResourceId: The ID of the source ApsaraDB RDS instance or source PolarDB cluster.
sslEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sslEnabled: Modifies the SSL status.
standbyAz java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property standbyAz: The zone for the hot standby cluster.
storageAutoScale java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.
storagePayType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storagePayType: The billing method for storage.
storageSpace java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSpace: The storage space for a pay-by-space (subscription) cluster.
storageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageType: The storage type.
storageUpperBound java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.
strictConsistency java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
tdeStatus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC to connect to.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the VSwitch.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the cluster.

dbNodeClassRequired

public java.lang.Object getDbNodeClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeClass: The node specification.

For more information, see the following topics:

  • PolarDB for MySQL: Compute node specifications
  • PolarDB for PostgreSQL (compatible with Oracle): Compute node specifications
  • PolarDB for PostgreSQL: Compute node specifications
  • To create a PolarDB for MySQL Cluster Edition serverless cluster, set this parameter to polar.mysql.sl.small.
  • To create a PolarDB for MySQL Standard Edition serverless cluster, set this parameter to polar.mysql.sl.small.c.
  • To create a PolarDB for PostgreSQL Cluster Edition serverless cluster, set this parameter to polar.pg.sl.small.
  • To create a PolarDB for PostgreSQL Standard Edition serverless cluster, set this parameter to polar.pg.sl.small.c.
  • To create a PolarDB for PostgreSQL (compatible with Oracle) serverless cluster, set this parameter to polar.o.sl.small.

dbTypeRequired

public java.lang.Object getDbType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbType: Database type, value: MySQL PostgreSQL Oracle.


dbVersionRequired

public java.lang.Object getDbVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbVersion: The version of the database engine.

  • Valid values for MySQL:
  • 5.6
  • 5.7
  • 8.0
  • Valid values for PostgreSQL:
  • 11
  • 14
  • 15

If you create a serverless cluster for PolarDB for PostgreSQL, you must set this parameter to 14. * Valid values for Oracle: * 11 * 14


payTypeRequired

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: The billing method of the cluster.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription


allowShutDownOptional

public java.lang.Object getAllowShutDown();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allowShutDown: Specifies whether to enable pause on inactivity.

Valid values:

  • true: enables pause on inactivity.
  • false (default): disables pause on inactivity.

This parameter is supported only for serverless clusters.


architectureOptional

public java.lang.Object getArchitecture();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property architecture: The architecture of CPU.

Valid values: X86 ARM


autoRenewPeriodOptional

public java.lang.Object getAutoRenewPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: Set the cluster auto renewal time.

Valid values: 1, 2, 3, 6, 12, 24, 36. Default to 1.


backupRetentionPolicyOnClusterDeletionOptional

public java.lang.Object getBackupRetentionPolicyOnClusterDeletion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupRetentionPolicyOnClusterDeletion: The backup retention policy to apply when the cluster is deleted.

Valid values:

  • ALL: retains all backup sets.
  • LATEST: retains only the last backup set. An automatic backup is performed before the cluster is deleted.
  • NONE: does not retain backup sets. Default value: NONE.
  • This parameter is valid only if DBType is set to MySQL.
  • Serverless clusters do not support this parameter.

cloneDataPointOptional

public java.lang.Object getCloneDataPoint();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cloneDataPoint: The point in time for the clone.

Valid values:

  • LATEST: The latest point in time.
  • BackupID: The ID of a historical backup set.
  • Timestamp: A specific point in time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. Default value: LATEST.

If you set CreationOption to CloneFromRDS, you can set this parameter only to LATEST.


clusterNetworkTypeOptional

public java.lang.Object getClusterNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property clusterNetworkType: The network type of the cluster.

Currently, only VPC is supported. Default value: VPC.


coldStorageOptionOptional

public java.lang.Object getColdStorageOption();

Property coldStorageOption: The option of cold storage.


creationCategoryOptional

public java.lang.Object getCreationCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property creationCategory: The edition of the cluster.

Valid values:

  • Normal: Cluster Edition (default)
  • Basic: Single-node Edition
  • ArchiveNormal: X-Engine Edition
  • NormalMultimaster: Multi-master Cluster Edition
  • SENormal: Standard Edition
  • The Basic edition is supported for PolarDB for MySQL 5.6, 5.7, and 8.0; PolarDB for PostgreSQL 14; and PolarDB for PostgreSQL (compatible with Oracle) 2.0.
  • The ArchiveNormal and NormalMultimaster editions are supported for PolarDB for MySQL 8.0.
  • The SENormal edition is supported for PolarDB for MySQL 5.6, 5.7, and 8.0 and PolarDB for PostgreSQL 14.

creationOptionOptional

public java.lang.Object getCreationOption();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.

Valid values: Normal: creates an ApsaraDB for POLARDB cluster. CloneFromPolarDB: clones data from an existing ApsaraDB for POLARDB cluster to a new ApsaraDB for POLARDB cluster. CloneFromRDS: clones data from an existing ApsaraDB for RDS instance to a new ApsaraDB for POLARDB cluster. MigrationFromRDS: migrates data from an existing ApsaraDB for RDS instance to a new ApsaraDB for POLARDB cluster. The created ApsaraDB for POLARDB cluster is in read-only mode and has binary logs enabled by default. CreateGdnStandby: Create a secondary cluster. RecoverFromRecyclebin: Recovers data from the freed PolarDB cluster to the new PolarDB cluster. UpgradeFromPolarDB: Upgrade migration from PolarDB. Default value: Normal. Note: When DBType is MySQL and DBVersion is 5.6, this parameter can be specified as CloneFromRDS or MigrationFromRDS. When DBType is MySQL and DBVersion is 8.0, this parameter can be specified as CreateGdnStandby.


dbClusterDescriptionOptional

public java.lang.Object getDbClusterDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterDescription: The description of the cluster.

The description must comply with the following rules: It must start with a Chinese character or an English letter. It can contain Chinese and English characters, digits, underscores (_), and hyphens (-). It cannot start with http:// or https://. It must be 2 to 256 characters in length.


dbClusterParametersOptional

public java.lang.Object getDbClusterParameters();

Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.


dbMinorVersionOptional

public java.lang.Object getDbMinorVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbMinorVersion: The minor version of the cluster.

Valid values: 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.


dbNodeNumOptional

public java.lang.Object getDbNodeNum();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeNum: The number of nodes for a Standard Edition or Enterprise Edition cluster.

Valid values:

  • Standard Edition: 1 to 8. A cluster of this edition includes one read/write node and up to seven read-only nodes.
  • Enterprise Edition: 1 to 16. A cluster of this edition includes one read/write node and up to 15 read-only nodes.
  • 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.
  • You cannot change the number of nodes in a Multi-master Cluster Edition cluster.

defaultTimeZoneOptional

public java.lang.Object getDefaultTimeZone();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property defaultTimeZone: Set up a time zone (UTC), the value range is as follows: System: The default time zone is the same as the time zone where the region is located.

This is default value. Other pickable value range is from -12:00 to +13:00, for example, 00:00. Note: This parameter takes effect only when DBType is MySQL.


deletionProtectionOptional

public java.lang.Object getDeletionProtection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.

Default is false.


gdnIdOptional

public java.lang.Object getGdnId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gdnId: The ID of the Global Database Network (GDN).

Note: This parameter is required when the CreationOption is CreateGdnStandby.


hotStandbyClusterOptional

public java.lang.Object getHotStandbyCluster();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property hotStandbyCluster: Specifies whether to enable the hot standby cluster feature.

Valid values:

  • ON (default): enables a hot standby storage cluster.
  • OFF: disables the hot standby cluster feature.
  • STANDBY: enables a hot standby cluster.
  • EQUAL: enables hot standby for both storage and computing resources.
  • 3AZ: enables multi-AZ strong consistency.

The value STANDBY is valid only for PolarDB for PostgreSQL.


loosePolarLogBinOptional

public java.lang.Object getLoosePolarLogBin();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loosePolarLogBin: Enable the Binlog function, the value range is as follows: ON: The cluster enables the Binlog function OFF: The cluster disables the Binlog function This parameter takes effect only when the parameter DBType is MySQL.


looseXEngineOptional

public java.lang.Object getLooseXEngine();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property looseXEngine: Specifies whether to enable the X-Engine storage engine.

Valid values:

  • ON: enables the X-Engine storage engine.
  • OFF: disables the X-Engine storage engine.

This parameter is valid only if the CreationOption parameter is not set to CreateGdnStandby, DBType is set to MySQL, and DBVersion is set to 8.0. To enable the X-Engine storage engine, the node must have at least 8 GB of memory.


looseXEngineUseMemoryPctOptional

public java.lang.Object getLooseXEngineUseMemoryPct();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.

This parameter takes effect only when the parameter LooseXEngine is ON.


lowerCaseTableNamesOptional

public java.lang.Object getLowerCaseTableNames();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property lowerCaseTableNames: Whether the table name is case sensitive, the value range is as follows: 1: Not case sensitive0: case sensitive The default value is 1.

Note: This parameter takes effect only when the value of DBType is MySQL.


maintainTimeOptional

public java.lang.Object getMaintainTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.

Example: 16:00Z-17:00Z, which means 0 to 1 (UTC+08:00) for routine maintenance.


parameterGroupIdOptional

public java.lang.Object getParameterGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property parameterGroupId: The ID of the parameter template.

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.


periodOptional

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: The subscription period of the clusterIf PeriodUnit is month, the valid range is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 If periodUnit is year, the valid range is 1, 2, 3.


periodUnitOptional

public java.lang.Object getPeriodUnit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.


provisionedIopsOptional

public java.lang.Object getProvisionedIops();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.

Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}.


proxyClassOptional

public java.lang.Object getProxyClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property proxyClass: The specifications of the Standard Edition PolarProxy.

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


proxyTypeOptional

public java.lang.Object getProxyType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property proxyType: The type of the database proxy.

Valid values:

  • EXCLUSIVE: Enterprise Dedicated
  • GENERAL: Enterprise General-purpose

The proxy type must be consistent with the type that corresponds to the node specification of the cluster:

  • If the node specification is general-purpose, the proxy type must be Enterprise General-purpose.
  • If the node specification is dedicated, the proxy type must be Enterprise Dedicated.

renewalStatusOptional

public java.lang.Object getRenewalStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.

Normal: manually renews the cluster. NotRenewal: does not renew the cluster. Default value: Normal. Note If this parameter is set to NotRenewal, the system does not send a reminder for expiration, but only sends an SMS message three days before the cluster expires to remind you that the cluster is not renewed.


resourceGroupIdOptional

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.


restartMasterNodeOptional

public java.lang.Object getRestartMasterNode();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property restartMasterNode: Whether to restart the master node.


scaleMaxOptional

public java.lang.Object getScaleMax();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleMax: The maximum number of PCUs for a single-node serverless cluster to scale up to.

Valid values: 1 to 32.

This parameter is supported only for serverless clusters.


scaleMinOptional

public java.lang.Object getScaleMin();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleMin: The minimum number of PolarDB compute units (PCUs) for a single-node serverless cluster to scale down to.

Valid values: 1 to 31.

This parameter is supported only for serverless clusters.


scaleRoNumMaxOptional

public java.lang.Object getScaleRoNumMax();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleRoNumMax: The maximum number of read-only nodes that the serverless cluster scales up to.

Valid values: 0 to 15.

This parameter is supported only for serverless clusters.


scaleRoNumMinOptional

public java.lang.Object getScaleRoNumMin();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleRoNumMin: The minimum number of read-only nodes that the serverless cluster scales down to.

Valid values: 0 to 15.

This parameter is supported only for serverless clusters.


securityGroupIdsOptional

public java.lang.Object getSecurityGroupIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property securityGroupIds: The ID of the security group.

You can add up to three security groups to a cluster.


securityIpListOptional

public java.lang.Object getSecurityIpList();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityIpList: The IP whitelist of the PolarDB cluster.

You can specify multiple IP addresses in the IP whitelist. Separate the IP addresses with commas (,).


serverlessTypeOptional

public java.lang.Object getServerlessType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property serverlessType: Serverless type.


sourceResourceIdOptional

public java.lang.Object getSourceResourceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceResourceId: The ID of the source ApsaraDB RDS instance or source PolarDB cluster.

This parameter is required only if CreationOption is set to MigrationFromRDS, CloneFromRDS, CloneFromPolarDB, or RecoverFromRecyclebin.

  • If CreationOption is set to MigrationFromRDS or CloneFromRDS, specify the ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must be ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 High-availability Edition.
  • If CreationOption is set to CloneFromPolarDB, specify the ID of the source PolarDB cluster. The new cluster must use the same database engine as the source cluster. For example, if the source cluster runs MySQL 8.0, you must set DBType to MySQL and DBVersion to 8.0 for the new cluster.
  • If CreationOption is set to RecoverFromRecyclebin, specify the ID of the released source PolarDB cluster. The restored cluster must use the same database engine as the source cluster.

sslEnabledOptional

public java.lang.Object getSslEnabled();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sslEnabled: Modifies the SSL status.

Valid values: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.


standbyAzOptional

public java.lang.Object getStandbyAz();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property standbyAz: The zone for the hot standby cluster.

This parameter is valid only when the hot standby cluster feature or multi-AZ strong consistency is enabled.


storageAutoScaleOptional

public java.lang.Object getStorageAutoScale();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.

The value range is as follows: Enable: Enable automatic storage scale. Disable: Disable automatic storage scale.


storagePayTypeOptional

public java.lang.Object getStoragePayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storagePayType: The billing method for storage.

Valid values:

  • Postpaid: pay-by-capacity (a pay-as-you-go method).
  • Prepaid: pay-by-space (a subscription method).

storageSpaceOptional

public java.lang.Object getStorageSpace();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageSpace: The storage space for a pay-by-space (subscription) cluster.

Unit: GB.

  • Valid values for a PolarDB for MySQL Enterprise Edition cluster: 10 to 50000.
  • Valid values for a PolarDB for MySQL Standard Edition cluster: 20 to 64000.
  • If the storage type of a Standard Edition cluster is ESSD AutoPL, the storage space must be a multiple of 10 between 40 and 64000.

storageTypeOptional

public java.lang.Object getStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storageType: The storage type.

Valid values for Enterprise Edition: PSL5 PSL4 Valid values for Standard Edition: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL This parameter is invalid for serverless clusters.


storageUpperBoundOptional

public java.lang.Object getStorageUpperBound();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.

The maximum value is 32000.


strictConsistencyOptional

public java.lang.Object getStrictConsistency();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.

Valid values: ON: enables the multi-zone data consistency feature, which is valid for Standard Edition clusters of Multi-zone Edition. OFF: disables the multi-zone data consistency feature.


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


tdeStatusOptional

public java.lang.Object getTdeStatus();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).

Valid values: true: enable TDE false: disable TDE (default) Note: The parameter takes effect only when DBType is PostgreSQL or Oracle. You cannot disable TDE after it is enabled.


vpcIdOptional

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The ID of the VPC to connect to.


vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the VSwitch.

If you specify the VPCId parameter, you must also specify this parameter.


zoneIdOptional

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone ID of the cluster.

You can call the DescribeRegions operation to query available zones.