DBClusterProps

Properties for defining a DBCluster.

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

Initializer

import { DBClusterProps } from '@alicloud/ros-cdk-polardb'
const dBClusterProps: DBClusterProps = { ... }

Properties

dbNodeClass^Required

public readonly dbNodeClass: string | IResolvable;

• Type: string | @alicloud/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.

dbType^Required

public readonly dbType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

dbVersion^Required

public readonly dbVersion: string | IResolvable;

• Type: string | @alicloud/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

payType^Required

public readonly payType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method of the cluster.

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

allowShutDown^Optional

public readonly allowShutDown: boolean | IResolvable;

• Type: boolean | @alicloud/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.

architecture^Optional

public readonly architecture: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property architecture: The architecture of CPU.

Valid values: X86 ARM

autoRenewPeriod^Optional

public readonly autoRenewPeriod: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property autoRenewPeriod: Set the cluster auto renewal time.

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

backupRetentionPolicyOnClusterDeletion^Optional

public readonly backupRetentionPolicyOnClusterDeletion: string | IResolvable;

• Type: string | @alicloud/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.

cloneDataPoint^Optional

public readonly cloneDataPoint: string | IResolvable;

• Type: string | @alicloud/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.

clusterNetworkType^Optional

public readonly clusterNetworkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property clusterNetworkType: The network type of the cluster.

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

coldStorageOption^Optional

public readonly coldStorageOption: IResolvable | ColdStorageOptionProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | ColdStorageOptionProperty

Property coldStorageOption: The option of cold storage.

creationCategory^Optional

public readonly creationCategory: string | IResolvable;

• Type: string | @alicloud/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.

creationOption^Optional

public readonly creationOption: string | IResolvable;

• Type: string | @alicloud/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.

dbClusterDescription^Optional

public readonly dbClusterDescription: string | IResolvable;

• Type: string | @alicloud/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.

dbClusterParameters^Optional

public readonly dbClusterParameters: IResolvable | DBClusterParametersProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | DBClusterParametersProperty

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

dbMinorVersion^Optional

public readonly dbMinorVersion: string | IResolvable;

• Type: string | @alicloud/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.

dbNodeNum^Optional

public readonly dbNodeNum: number | IResolvable;

• Type: number | @alicloud/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.

defaultTimeZone^Optional

public readonly defaultTimeZone: string | IResolvable;

• Type: string | @alicloud/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.

deletionProtection^Optional

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

Default is false.

gdnId^Optional

public readonly gdnId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

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

hotStandbyCluster^Optional

public readonly hotStandbyCluster: string | IResolvable;

• Type: string | @alicloud/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.

loosePolarLogBin^Optional

public readonly loosePolarLogBin: string | IResolvable;

• Type: string | @alicloud/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^Optional

public readonly looseXEngine: string | IResolvable;

• Type: string | @alicloud/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.

looseXEngineUseMemoryPct^Optional

public readonly looseXEngineUseMemoryPct: number | IResolvable;

• Type: number | @alicloud/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.

lowerCaseTableNames^Optional

public readonly lowerCaseTableNames: number | IResolvable;

• Type: number | @alicloud/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.

maintainTime^Optional

public readonly maintainTime: string | IResolvable;

• Type: string | @alicloud/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.

parameterGroupId^Optional

public readonly parameterGroupId: string | IResolvable;

• Type: string | @alicloud/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.

period^Optional

public readonly period: number | IResolvable;

• Type: number | @alicloud/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^Optional

public readonly periodUnit: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

provisionedIops^Optional

public readonly provisionedIops: number | IResolvable;

• Type: number | @alicloud/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}.

proxyClass^Optional

public readonly proxyClass: string | IResolvable;

• Type: string | @alicloud/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

proxyType^Optional

public readonly proxyType: string | IResolvable;

• Type: string | @alicloud/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.

renewalStatus^Optional

public readonly renewalStatus: string | IResolvable;

• Type: string | @alicloud/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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

restartMasterNode^Optional

public readonly restartMasterNode: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property restartMasterNode: Whether to restart the master node.

scaleMax^Optional

public readonly scaleMax: number | IResolvable;

• Type: number | @alicloud/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.

scaleMin^Optional

public readonly scaleMin: number | IResolvable;

• Type: number | @alicloud/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.

scaleRoNumMax^Optional

public readonly scaleRoNumMax: number | IResolvable;

• Type: number | @alicloud/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.

scaleRoNumMin^Optional

public readonly scaleRoNumMin: number | IResolvable;

• Type: number | @alicloud/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.

securityGroupIds^Optional

public readonly securityGroupIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property securityGroupIds: The ID of the security group.

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

securityIpList^Optional

public readonly securityIpList: string | IResolvable;

• Type: string | @alicloud/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 (,).

serverlessType^Optional

public readonly serverlessType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property serverlessType: Serverless type.

sourceResourceId^Optional

public readonly sourceResourceId: string | IResolvable;

• Type: string | @alicloud/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.

sslEnabled^Optional

public readonly sslEnabled: string | IResolvable;

• Type: string | @alicloud/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.

standbyAz^Optional

public readonly standbyAz: string | IResolvable;

• Type: string | @alicloud/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.

storageAutoScale^Optional

public readonly storageAutoScale: string | IResolvable;

• Type: string | @alicloud/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.

storagePayType^Optional

public readonly storagePayType: string | IResolvable;

• Type: string | @alicloud/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).

storageSpace^Optional

public readonly storageSpace: number | IResolvable;

• Type: number | @alicloud/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.

storageType^Optional

public readonly storageType: string | IResolvable;

• Type: string | @alicloud/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.

storageUpperBound^Optional

public readonly storageUpperBound: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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

The maximum value is 32000.

strictConsistency^Optional

public readonly strictConsistency: string | IResolvable;

• Type: string | @alicloud/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.

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

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.

tdeStatus^Optional

public readonly tdeStatus: boolean | IResolvable;

• Type: boolean | @alicloud/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.

vpcId^Optional

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch.

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

zoneId^Optional

public readonly zoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID of the cluster.

You can call the DescribeRegions operation to query available zones.