Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.

Initializers 

import com.aliyun.ros.cdk.polardb.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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)
//  .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
dbNodeClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeClass: The node specifications of the cluster.
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.
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: Whether to turn on No activity pause.
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 set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.
cloneDataPoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cloneDataPoint: The time point of data to be cloned.
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: Cluster series.
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 Standard Edition nodes.
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 storage 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: Enable the X-Engine storage engine function, the value range is as follows: ON: The cluster starts the X-Engine enginen OFF: The cluster shuts down the X-Engine engine This parameter takes effect only when the parameter CreationOption is not equal to CreateGdnStandby, DBType is MySQL and DBVersion is 8.0. The memory specification of the node with X-Engine enabled must be greater than or equal to 16 GB.
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: ESSD AutoPL preconfigured read and write IOPS for 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 PolarProxy.
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: Maximum limit of single-node scaling.
scaleMin java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleMin: Minimum limit of single-node scaling.
scaleRoNumMax java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.
scaleRoNumMin java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.
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 whitelist of the Apsara 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 RDS instance or source POLARDB cluster.
standbyAz java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property standbyAz: The zone where the hot standby storage cluster is stored.
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 storage pay type.
storageSpace java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSpace: The storage space that uses the subscription billing method.
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 to connect to.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the cluster.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbNodeClassRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeClass: The node specifications of the cluster.

For more information, see Specifications and pricing.

dbTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dbVersionRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbVersion: The version of the database.

Valid values: MySQL: 5.6, 5.7 or 8.0 PostgreSQL: 11, 14, 15 Oracle: 11, 14

payTypeRequired

  • 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

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allowShutDown: Whether to turn on No activity pause.

The default is false.

architectureOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property architecture: The architecture of CPU.

Valid values: X86 ARM

autoRenewPeriodOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupRetentionPolicyOnClusterDeletion: The backup set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.

LATEST: Permanently keep the last backup (automatic backup before deletion). NONE: The backup set is not retained when the cluster is deleted. When creating a cluster, the default value is NONE, that is, the backup set is not retained when the cluster is deleted. Note: This parameter takes effect only when the value of DBType is MySQL.

cloneDataPointOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cloneDataPoint: The time point of data to be cloned.

Valid values: LATEST: clones data of the latest time point. : clones historical backup data. Specify the ID of the specific backup set. : clones data of a historical time point. Specify the specific time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Default value: LATEST. Note This parameter takes effect only when the DBType parameter is set to MySQL, the DBVersion parameter is set to 5.6, and the CreationOption parameter is set to CloneFromRDS or CloneFromPolarDB. If the CreationOption parameter is set to CloneFromRDS, the value of this parameter must be LATEST.

clusterNetworkTypeOptional

  • 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

Property coldStorageOption: The option of cold storage.

creationCategoryOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property creationCategory: Cluster series.

The value could be Normal (standard version), Basic, ArchiveNormal, NormalMultimaster and SENormal.

creationOptionOptional

  • 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

  • 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

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

dbMinorVersionOptional

  • 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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeNum: The number of Standard Edition nodes.

Default value: 1. Valid values: 1: only one primary node. 2: one read-only node and one primary node.

defaultTimeZoneOptional

  • 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

  • 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

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default value: ON. Valid values: ON: enables the hot standby storage cluster feature. OFF: disables the hot standby storage cluster feature STANDBY: enables the hot standby storage cluster feature only for Standard Edition clusters. The default value for Standard Edition clusters is STANDBY.

loosePolarLogBinOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property looseXEngine: Enable the X-Engine storage engine function, the value range is as follows: ON: The cluster starts the X-Engine enginen OFF: The cluster shuts down the X-Engine engine This parameter takes effect only when the parameter CreationOption is not equal to CreateGdnStandby, DBType is MySQL and DBVersion is 8.0. The memory specification of the node with X-Engine enabled must be greater than or equal to 16 GB.

looseXEngineUseMemoryPctOptional

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property provisionedIops: ESSD AutoPL preconfigured read and write IOPS for cloud disk.

Possible values: 0-min {50,000, 1000 capacity - baseline performance}. Baseline performance =min{1,800+50 capacity, 50000}.

proxyClassOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property proxyType: The type of PolarProxy.

Default value: OFF. Valid values: OFF: disables PolarProxy. EXCLUSIVE: Dedicated Enterprise Edition GENERAL: Standard Enterprise Edition

renewalStatusOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

restartMasterNodeOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property restartMasterNode: Whether to restart the master node.

scaleMaxOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleMax: Maximum limit of single-node scaling.

scaleMinOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleMin: Minimum limit of single-node scaling.

scaleRoNumMaxOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.

scaleRoNumMinOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.

securityGroupIdsOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityIpList: The whitelist of the Apsara PolarDB cluster.

serverlessTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property serverlessType: Serverless type.

sourceResourceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Note This parameter takes effect only when the DBType parameter is set to MySQL and the DBVersion parameter is set to 5.6. This parameter is required if the CreationOption parameter is not set to Normal.

standbyAzOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property standbyAz: The zone where the hot standby storage cluster is stored.

This is valid for Standard Edition clusters of Multi-zone Edition. This parameter takes effect only when the multi-zone data consistency feature is enabled.

storageAutoScaleOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storagePayType: The storage pay type.

storageSpaceOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageSpace: The storage space that uses the subscription billing method.

Unit: GB. Valid values for PolarDB for MySQL Standard Edition: 20 to 32000.

storageTypeOptional

  • 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

  • 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

  • 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

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

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the VSwitch to connect to.

zoneIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.polardb.DBCluster;
DBCluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrClusterConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ClusterConnectionString: The cluster connection string of the db cluster.
attrClusterEndpointId com.aliyun.ros.cdk.core.IResolvable Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
attrColdStorageInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute ColdStorageInstanceId: The ID of the cold storage instance.
attrCustomConnectionStrings com.aliyun.ros.cdk.core.IResolvable Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
attrCustomEndpointIds com.aliyun.ros.cdk.core.IResolvable Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
attrDbClusterDescription com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterDescription: The description of the db cluster.
attrDbClusterId com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
attrDbNodeIds com.aliyun.ros.cdk.core.IResolvable Attribute DBNodeIds: The ID list of cluster nodes.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: The Order ID.
attrPrimaryConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute PrimaryConnectionString: The primary connection string of the db cluster.
attrPrimaryConnectionStrings com.aliyun.ros.cdk.core.IResolvable Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
attrPrimaryEndpointId com.aliyun.ros.cdk.core.IResolvable Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
attrPrimaryEndpointIds com.aliyun.ros.cdk.core.IResolvable Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrClusterConnectionStringRequired 

public IResolvable getAttrClusterConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterConnectionString: The cluster connection string of the db cluster.

attrClusterEndpointIdRequired 

public IResolvable getAttrClusterEndpointId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.

attrColdStorageInstanceIdRequired 

public IResolvable getAttrColdStorageInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ColdStorageInstanceId: The ID of the cold storage instance.

attrCustomConnectionStringsRequired 

public IResolvable getAttrCustomConnectionStrings();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CustomConnectionStrings: The custom connection strings of the db cluster.

attrCustomEndpointIdsRequired 

public IResolvable getAttrCustomEndpointIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.

attrDbClusterDescriptionRequired 

public IResolvable getAttrDbClusterDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterDescription: The description of the db cluster.

attrDbClusterIdRequired 

public IResolvable getAttrDbClusterId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.

attrDbNodeIdsRequired 

public IResolvable getAttrDbNodeIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBNodeIds: The ID list of cluster nodes.

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The Order ID.

attrPrimaryConnectionStringRequired 

public IResolvable getAttrPrimaryConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrimaryConnectionString: The primary connection string of the db cluster.

attrPrimaryConnectionStringsRequired 

public IResolvable getAttrPrimaryConnectionStrings();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.

attrPrimaryEndpointIdRequired 

public IResolvable getAttrPrimaryEndpointId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.

attrPrimaryEndpointIdsRequired 

public IResolvable getAttrPrimaryEndpointIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.