Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkpolardb"
&alicloudroscdkpolardb.DBClusterProps {
    DbNodeClass: interface{},
    DbType: interface{},
    DbVersion: interface{},
    PayType: interface{},
    AllowShutDown: interface{},
    Architecture: interface{},
    AutoRenewPeriod: interface{},
    BackupRetentionPolicyOnClusterDeletion: interface{},
    CloneDataPoint: interface{},
    ClusterNetworkType: interface{},
    ColdStorageOption: interface{},
    CreationCategory: interface{},
    CreationOption: interface{},
    DbClusterDescription: interface{},
    DbClusterParameters: interface{},
    DbMinorVersion: interface{},
    DbNodeNum: interface{},
    DefaultTimeZone: interface{},
    DeletionProtection: interface{},
    GdnId: interface{},
    HotStandbyCluster: interface{},
    LoosePolarLogBin: interface{},
    LooseXEngine: interface{},
    LooseXEngineUseMemoryPct: interface{},
    LowerCaseTableNames: interface{},
    MaintainTime: interface{},
    ParameterGroupId: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    ProvisionedIops: interface{},
    ProxyClass: interface{},
    ProxyType: interface{},
    RenewalStatus: interface{},
    ResourceGroupId: interface{},
    RestartMasterNode: interface{},
    ScaleMax: interface{},
    ScaleMin: interface{},
    ScaleRoNumMax: interface{},
    ScaleRoNumMin: interface{},
    SecurityGroupIds: interface{},
    SecurityIpList: interface{},
    ServerlessType: interface{},
    SourceResourceId: interface{},
    StandbyAz: interface{},
    StorageAutoScale: interface{},
    StoragePayType: interface{},
    StorageSpace: interface{},
    StorageType: interface{},
    StorageUpperBound: interface{},
    StrictConsistency: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkpolardb.RosDBCluster.TagsProperty,
    TdeStatus: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
}

Properties

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

DbNodeClassRequired 

DbNodeClass interface{}
  • Type: interface{}

Property dbNodeClass: The node specifications of the cluster.

For more information, see Specifications and pricing.

DbTypeRequired 

DbType interface{}
  • Type: interface{}

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

DbVersionRequired 

DbVersion interface{}
  • Type: interface{}

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 

PayType interface{}
  • Type: interface{}

Property payType: The billing method of the cluster.

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

AllowShutDownOptional 

AllowShutDown interface{}
  • Type: interface{}

Property allowShutDown: Whether to turn on No activity pause.

The default is false.

ArchitectureOptional 

Architecture interface{}
  • Type: interface{}

Property architecture: The architecture of CPU.

Valid values: X86 ARM

AutoRenewPeriodOptional 

AutoRenewPeriod interface{}
  • Type: interface{}

Property autoRenewPeriod: Set the cluster auto renewal time.

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

BackupRetentionPolicyOnClusterDeletionOptional 

BackupRetentionPolicyOnClusterDeletion interface{}
  • Type: interface{}

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 

CloneDataPoint interface{}
  • Type: interface{}

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 

ClusterNetworkType interface{}
  • Type: interface{}

Property clusterNetworkType: The network type of the cluster.

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

ColdStorageOptionOptional 

ColdStorageOption interface{}
  • Type: interface{}

Property coldStorageOption: The option of cold storage.

CreationCategoryOptional 

CreationCategory interface{}
  • Type: interface{}

Property creationCategory: Cluster series.

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

CreationOptionOptional 

CreationOption interface{}
  • Type: interface{}

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 

DbClusterDescription interface{}
  • Type: interface{}

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 

DbClusterParameters interface{}
  • Type: interface{}

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

DbMinorVersionOptional 

DbMinorVersion interface{}
  • Type: interface{}

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 

DbNodeNum interface{}
  • Type: interface{}

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 

DefaultTimeZone interface{}
  • Type: interface{}

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 

DeletionProtection interface{}
  • Type: interface{}

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

Default is false.

GdnIdOptional 

GdnId interface{}
  • Type: interface{}

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

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

HotStandbyClusterOptional 

HotStandbyCluster interface{}
  • Type: interface{}

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 

LoosePolarLogBin interface{}
  • Type: interface{}

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 

LooseXEngine interface{}
  • Type: interface{}

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 

LooseXEngineUseMemoryPct interface{}
  • Type: interface{}

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 

LowerCaseTableNames interface{}
  • Type: interface{}

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 

MaintainTime interface{}
  • Type: interface{}

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 

ParameterGroupId interface{}
  • Type: interface{}

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 

Period interface{}
  • Type: interface{}

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 

PeriodUnit interface{}
  • Type: interface{}

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

ProvisionedIopsOptional 

ProvisionedIops interface{}
  • Type: interface{}

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 

ProxyClass interface{}
  • Type: interface{}

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 

ProxyType interface{}
  • Type: interface{}

Property proxyType: The type of PolarProxy.

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

RenewalStatusOptional 

RenewalStatus interface{}
  • Type: interface{}

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 

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.

RestartMasterNodeOptional 

RestartMasterNode interface{}
  • Type: interface{}

Property restartMasterNode: Whether to restart the master node.

ScaleMaxOptional 

ScaleMax interface{}
  • Type: interface{}

Property scaleMax: Maximum limit of single-node scaling.

ScaleMinOptional 

ScaleMin interface{}
  • Type: interface{}

Property scaleMin: Minimum limit of single-node scaling.

ScaleRoNumMaxOptional 

ScaleRoNumMax interface{}
  • Type: interface{}

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

ScaleRoNumMinOptional 

ScaleRoNumMin interface{}
  • Type: interface{}

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

SecurityGroupIdsOptional 

SecurityGroupIds interface{}
  • Type: interface{}

Property securityGroupIds: The ID of the security group.

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

SecurityIpListOptional 

SecurityIpList interface{}
  • Type: interface{}

Property securityIpList: The whitelist of the Apsara PolarDB cluster.

ServerlessTypeOptional 

ServerlessType interface{}
  • Type: interface{}

Property serverlessType: Serverless type.

SourceResourceIdOptional 

SourceResourceId interface{}
  • Type: interface{}

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 

StandbyAz interface{}
  • Type: interface{}

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 

StorageAutoScale interface{}
  • Type: interface{}

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 

StoragePayType interface{}
  • Type: interface{}

Property storagePayType: The storage pay type.

StorageSpaceOptional 

StorageSpace interface{}
  • Type: interface{}

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 

StorageType interface{}
  • Type: interface{}

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 

StorageUpperBound interface{}
  • Type: interface{}

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

The maximum value is 32000.

StrictConsistencyOptional 

StrictConsistency interface{}
  • Type: interface{}

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 

Tags *[]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.

TdeStatusOptional 

TdeStatus interface{}
  • Type: interface{}

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 

VpcId interface{}
  • Type: interface{}

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

VSwitchIdOptional 

VSwitchId interface{}
  • Type: interface{}

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

ZoneIdOptional 

ZoneId interface{}
  • Type: interface{}

Property zoneId: The zone ID of the cluster.

You can call the DescribeRegions operation to query available zones.