DBClusterProps

Properties for defining a DBCluster.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Polardb;
new DBClusterProps {
    object DbNodeClass,
    object DbType,
    object DbVersion,
    object PayType,
    object AllowShutDown = null,
    object Architecture = null,
    object AutoRenewPeriod = null,
    object BackupRetentionPolicyOnClusterDeletion = null,
    object CloneDataPoint = null,
    object ClusterNetworkType = null,
    object ColdStorageOption = null,
    object CreationCategory = null,
    object CreationOption = null,
    object DbClusterDescription = null,
    object DbClusterParameters = null,
    object DbMinorVersion = null,
    object DbNodeNum = null,
    object DefaultTimeZone = null,
    object GdnId = null,
    object HotStandbyCluster = null,
    object LoosePolarLogBin = null,
    object LooseXEngine = null,
    object LooseXEngineUseMemoryPct = null,
    object LowerCaseTableNames = null,
    object MaintainTime = null,
    object ParameterGroupId = null,
    object Period = null,
    object PeriodUnit = null,
    object ProxyClass = null,
    object ProxyType = null,
    object RenewalStatus = null,
    object ResourceGroupId = null,
    object RestartMasterNode = null,
    object ScaleMax = null,
    object ScaleMin = null,
    object ScaleRoNumMax = null,
    object ScaleRoNumMin = null,
    object SecurityGroupIds = null,
    object SecurityIpList = null,
    object ServerlessType = null,
    object SourceResourceId = null,
    object StandbyAz = null,
    object StorageAutoScale = null,
    object StoragePayType = null,
    object StorageSpace = null,
    object StorageType = null,
    object StorageUpperBound = null,
    object StrictConsistency = null,
    TagsProperty[] Tags = null,
    object TdeStatus = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

Name	Type	Description
`DbNodeClass`	`object`	Property dbNodeClass: The node specifications of the cluster.
`DbType`	`object`	Property dbType: Database type, value: MySQL PostgreSQL Oracle.
`DbVersion`	`object`	Property dbVersion: The version of the database.
`PayType`	`object`	Property payType: The billing method of the cluster.
`AllowShutDown`	`object`	Property allowShutDown: Whether to turn on No activity pause.
`Architecture`	`object`	Property architecture: The architecture of CPU.
`AutoRenewPeriod`	`object`	Property autoRenewPeriod: Set the cluster auto renewal time.
`BackupRetentionPolicyOnClusterDeletion`	`object`	Property backupRetentionPolicyOnClusterDeletion: The backup set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.
`CloneDataPoint`	`object`	Property cloneDataPoint: The time point of data to be cloned.
`ClusterNetworkType`	`object`	Property clusterNetworkType: The network type of the cluster.
`ColdStorageOption`	`object`	Property coldStorageOption: The option of cold storage.
`CreationCategory`	`object`	Property creationCategory: Cluster series.
`CreationOption`	`object`	Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.
`DbClusterDescription`	`object`	Property dbClusterDescription: The description of the cluster.
`DbClusterParameters`	`object`	Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.
`DbMinorVersion`	`object`	Property dbMinorVersion: The minor version of the cluster.
`DbNodeNum`	`object`	Property dbNodeNum: The number of Standard Edition nodes.
`DefaultTimeZone`	`object`	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.
`GdnId`	`object`	Property gdnId: The ID of the Global Database Network (GDN).
`HotStandbyCluster`	`object`	Property hotStandbyCluster: Specifies whether to enable the hot standby storage cluster feature.
`LoosePolarLogBin`	`object`	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`	`object`	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`	`object`	Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.
`LowerCaseTableNames`	`object`	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`	`object`	Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.
`ParameterGroupId`	`object`	Property parameterGroupId: The ID of the parameter template.
`Period`	`object`	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`	`object`	Property periodUnit: The unit of the subscription duration.
`ProxyClass`	`object`	Property proxyClass: The specifications of the Standard Edition PolarProxy.
`ProxyType`	`object`	Property proxyType: The type of PolarProxy.
`RenewalStatus`	`object`	Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.
`ResourceGroupId`	`object`	Property resourceGroupId: The ID of the resource group.
`RestartMasterNode`	`object`	Property restartMasterNode: Whether to restart the master node.
`ScaleMax`	`object`	Property scaleMax: Maximum limit of single-node scaling.
`ScaleMin`	`object`	Property scaleMin: Minimum limit of single-node scaling.
`ScaleRoNumMax`	`object`	Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.
`ScaleRoNumMin`	`object`	Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.
`SecurityGroupIds`	`object`	Property securityGroupIds: The ID of the security group.
`SecurityIpList`	`object`	Property securityIpList: The whitelist of the Apsara PolarDB cluster.
`ServerlessType`	`object`	Property serverlessType: Serverless type.
`SourceResourceId`	`object`	Property sourceResourceId: The ID of the source RDS instance or source POLARDB cluster.
`StandbyAz`	`object`	Property standbyAz: The zone where the hot standby storage cluster is stored.
`StorageAutoScale`	`object`	Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.
`StoragePayType`	`object`	Property storagePayType: The storage pay type.
`StorageSpace`	`object`	Property storageSpace: The storage space that uses the subscription billing method.
`StorageType`	`object`	Property storageType: The storage type.
`StorageUpperBound`	`object`	Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.
`StrictConsistency`	`object`	Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.
`Tags`	`TagsProperty[]`	Property tags: Tags to attach to instance.
`TdeStatus`	`object`	Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
`VpcId`	`object`	Property vpcId: The ID of the VPC to connect to.
`VSwitchId`	`object`	Property vSwitchId: The ID of the VSwitch to connect to.
`ZoneId`	`object`	Property zoneId: The zone ID of the cluster.

`DbNodeClass`^Required

public object DbNodeClass { get; set; }

Type: object

Property dbNodeClass: The node specifications of the cluster.

For more information, see Specifications and pricing.

`DbType`^Required

public object DbType { get; set; }

Type: object

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

`DbVersion`^Required

public object DbVersion { get; set; }

Type: object

Property dbVersion: The version of the database.

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

`PayType`^Required

public object PayType { get; set; }

Type: object

Property payType: The billing method of the cluster.

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

`AllowShutDown`^Optional

public object AllowShutDown { get; set; }

Type: object

Property allowShutDown: Whether to turn on No activity pause.

The default is false.

`Architecture`^Optional

public object Architecture { get; set; }

Type: object

Property architecture: The architecture of CPU.

Valid values: X86 ARM

`AutoRenewPeriod`^Optional

public object AutoRenewPeriod { get; set; }

Type: object

Property autoRenewPeriod: Set the cluster auto renewal time.

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

`BackupRetentionPolicyOnClusterDeletion`^Optional

public object BackupRetentionPolicyOnClusterDeletion { get; set; }

Type: object

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.

`CloneDataPoint`^Optional

public object CloneDataPoint { get; set; }

Type: object

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.

`ClusterNetworkType`^Optional

public object ClusterNetworkType { get; set; }

Type: object

Property clusterNetworkType: The network type of the cluster.

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

`ColdStorageOption`^Optional

public object ColdStorageOption { get; set; }

Type: object

Property coldStorageOption: The option of cold storage.

`CreationCategory`^Optional

public object CreationCategory { get; set; }

Type: object

Property creationCategory: Cluster series.

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

`CreationOption`^Optional

public object CreationOption { get; set; }

Type: object

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. 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 object DbClusterDescription { get; set; }

Type: object

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 object DbClusterParameters { get; set; }

Type: object

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

`DbMinorVersion`^Optional

public object DbMinorVersion { get; set; }

Type: object

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 object DbNodeNum { get; set; }

Type: object

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.

`DefaultTimeZone`^Optional

public object DefaultTimeZone { get; set; }

Type: object

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.

`GdnId`^Optional

public object GdnId { get; set; }

Type: object

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

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

`HotStandbyCluster`^Optional

public object HotStandbyCluster { get; set; }

Type: object

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.

`LoosePolarLogBin`^Optional

public object LoosePolarLogBin { get; set; }

Type: object

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 object LooseXEngine { get; set; }

Type: object

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`^Optional

public object LooseXEngineUseMemoryPct { get; set; }

Type: object

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 object LowerCaseTableNames { get; set; }

Type: object

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 object MaintainTime { get; set; }

Type: object

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 object ParameterGroupId { get; set; }

Type: object

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 object Period { get; set; }

Type: object

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 object PeriodUnit { get; set; }

Type: object

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

`ProxyClass`^Optional

public object ProxyClass { get; set; }

Type: object

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 object ProxyType { get; set; }

Type: object

Property proxyType: The type of PolarProxy.

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

`RenewalStatus`^Optional

public object RenewalStatus { get; set; }

Type: object

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 object ResourceGroupId { get; set; }

Type: object

Property resourceGroupId: The ID of the resource group.

`RestartMasterNode`^Optional

public object RestartMasterNode { get; set; }

Type: object

Property restartMasterNode: Whether to restart the master node.

`ScaleMax`^Optional

public object ScaleMax { get; set; }

Type: object

Property scaleMax: Maximum limit of single-node scaling.

`ScaleMin`^Optional

public object ScaleMin { get; set; }

Type: object

Property scaleMin: Minimum limit of single-node scaling.

`ScaleRoNumMax`^Optional

public object ScaleRoNumMax { get; set; }

Type: object

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

`ScaleRoNumMin`^Optional

public object ScaleRoNumMin { get; set; }

Type: object

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

`SecurityGroupIds`^Optional

public object SecurityGroupIds { get; set; }

Type: object

Property securityGroupIds: The ID of the security group.

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

`SecurityIpList`^Optional

public object SecurityIpList { get; set; }

Type: object

Property securityIpList: The whitelist of the Apsara PolarDB cluster.

`ServerlessType`^Optional

public object ServerlessType { get; set; }

Type: object

Property serverlessType: Serverless type.

`SourceResourceId`^Optional

public object SourceResourceId { get; set; }

Type: object

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.

`StandbyAz`^Optional

public object StandbyAz { get; set; }

Type: object

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.

`StorageAutoScale`^Optional

public object StorageAutoScale { get; set; }

Type: object

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 object StoragePayType { get; set; }

Type: object

Property storagePayType: The storage pay type.

`StorageSpace`^Optional

public object StorageSpace { get; set; }

Type: object

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

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

`StorageType`^Optional

public object StorageType { get; set; }

Type: object

Property storageType: The storage type.

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

`StorageUpperBound`^Optional

public object StorageUpperBound { get; set; }

Type: object

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

The maximum value is 32000.

`StrictConsistency`^Optional

public object StrictConsistency { get; set; }

Type: object

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 TagsProperty[] Tags { get; set; }

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 object TdeStatus { get; set; }

Type: object

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 object VpcId { get; set; }

Type: object

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

`VSwitchId`^Optional

public object VSwitchId { get; set; }

Type: object

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

`ZoneId`^Optional

public object ZoneId { get; set; }

Type: object

Property zoneId: The zone ID of the cluster.

You can call the DescribeRegions operation to query available zones.

DBClusterProps

Initializer

Properties

DbNodeClassRequired

DbTypeRequired

DbVersionRequired

PayTypeRequired

AllowShutDownOptional

ArchitectureOptional

AutoRenewPeriodOptional

BackupRetentionPolicyOnClusterDeletionOptional

CloneDataPointOptional

ClusterNetworkTypeOptional

ColdStorageOptionOptional

CreationCategoryOptional

CreationOptionOptional

DbClusterDescriptionOptional

DbClusterParametersOptional

DbMinorVersionOptional

DbNodeNumOptional

DefaultTimeZoneOptional

GdnIdOptional

HotStandbyClusterOptional

LoosePolarLogBinOptional

LooseXEngineOptional

LooseXEngineUseMemoryPctOptional

LowerCaseTableNamesOptional

MaintainTimeOptional

ParameterGroupIdOptional

PeriodOptional

PeriodUnitOptional

ProxyClassOptional

ProxyTypeOptional

RenewalStatusOptional

ResourceGroupIdOptional

RestartMasterNodeOptional

ScaleMaxOptional

ScaleMinOptional

ScaleRoNumMaxOptional

ScaleRoNumMinOptional

SecurityGroupIdsOptional

SecurityIpListOptional

ServerlessTypeOptional

SourceResourceIdOptional

StandbyAzOptional

StorageAutoScaleOptional

StoragePayTypeOptional

StorageSpaceOptional

StorageTypeOptional

StorageUpperBoundOptional

StrictConsistencyOptional

TagsOptional

TdeStatusOptional

VpcIdOptional

VSwitchIdOptional

ZoneIdOptional