Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Adblake;
new DBClusterProps {
    object DbClusterVersion,
    object PayType,
    object VpcId,
    object VSwitchId,
    object ZoneId,
    object BackupSetId = null,
    object CloneSourceRegionId = null,
    object ComputeResource = null,
    object DbClusterDescription = null,
    object DbClusterNetworkType = null,
    object DiskEncryption = null,
    object EnableDefaultResourcePool = null,
    object KmsId = null,
    object Period = null,
    object PeriodType = null,
    object ProductForm = null,
    object ProductVersion = null,
    object ReservedNodeCount = null,
    object ReservedNodeSize = null,
    object ResourceGroupId = null,
    object RestoreToTime = null,
    object RestoreType = null,
    object SecondaryVSwitchId = null,
    object SecondaryZoneId = null,
    object SourceDbClusterId = null,
    object StorageResource = null,
    TagsProperty[] Tags = null
};

Properties

Name Type Description
DbClusterVersion object Property dbClusterVersion: The version of the cluster.
PayType object Property payType: The billing method of the cluster.
VpcId object Property vpcId: The virtual private cloud (VPC) ID of the cluster.
VSwitchId object Property vSwitchId: The vSwitch ID of the cluster.
ZoneId object Property zoneId: The zone ID.
BackupSetId object Property backupSetId: The ID of the backup set that you want to use to restore data.
CloneSourceRegionId object Property cloneSourceRegionId: The region ID of the source cluster.
ComputeResource object Property computeResource: The amount of reserved computing resources.
DbClusterDescription object Property dbClusterDescription: The description of the cluster.
DbClusterNetworkType object Property dbClusterNetworkType: The network type of the cluster.
DiskEncryption object Property diskEncryption: Specifies whether to encrypt the disk.
EnableDefaultResourcePool object Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
KmsId object Property kmsId: The ID of the key used to encrypt data on cloud disks.
Period object Property period: The unit of the subscription duration.
PeriodType object Property periodType: The subscription type of the subscription cluster.
ProductForm object Property productForm: The product form.
ProductVersion object Property productVersion: The version of the cluster.Note If only ProductForm is set to IntegrationForm, enter this parameter.
ReservedNodeCount object Property reservedNodeCount: The number of reserved nodes.
ReservedNodeSize object Property reservedNodeSize: The resource specification of each reserved node, in ACUs.
ResourceGroupId object Property resourceGroupId: The resource group ID.
RestoreToTime object Property restoreToTime: The point in time to which you want to restore the cluster.
RestoreType object Property restoreType: The method that you want to use to restore data.
SecondaryVSwitchId object Property secondaryVSwitchId: The ID of the secondary vSwitch.
SecondaryZoneId object Property secondaryZoneId: The ID of the secondary availability zone.
SourceDbClusterId object Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.
StorageResource object Property storageResource: The amount of reserved storage resources.
Tags TagsProperty[] Property tags: Tags to attach to cluster.

DbClusterVersionRequired

public object DbClusterVersion { get; set; }
  • Type: object

Property dbClusterVersion: The version of the cluster.

Set the value to 5.0.


PayTypeRequired

public object PayType { get; set; }
  • Type: object

Property payType: The billing method of the cluster.

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


VpcIdRequired

public object VpcId { get; set; }
  • Type: object

Property vpcId: The virtual private cloud (VPC) ID of the cluster.


VSwitchIdRequired

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: The vSwitch ID of the cluster.


ZoneIdRequired

public object ZoneId { get; set; }
  • Type: object

Property zoneId: The zone ID.

Note You can call the DescribeRegions operation to query the most recent zone list.


BackupSetIdOptional

public object BackupSetId { get; set; }
  • Type: object

Property backupSetId: The ID of the backup set that you want to use to restore data.

Note You can call the DescribeBackups operation to query the backup sets of the cluster.


CloneSourceRegionIdOptional

public object CloneSourceRegionId { get; set; }
  • Type: object

Property cloneSourceRegionId: The region ID of the source cluster.

This parameter is required for cross-region cloning.


ComputeResourceOptional

public object ComputeResource { get; set; }
  • Type: object

Property computeResource: The amount of reserved computing resources.

Unit: ACUs. Valid values: 0ACU to 4096ACU. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory. Note This parameter must be specified with a unit.


DbClusterDescriptionOptional

public object DbClusterDescription { get; set; }
  • Type: object

Property dbClusterDescription: The description of the cluster.

The description cannot start with http:// or https://. The description must be 2 to 256 characters in length


DbClusterNetworkTypeOptional

public object DbClusterNetworkType { get; set; }
  • Type: object

Property dbClusterNetworkType: The network type of the cluster.

Valid values: VPC


DiskEncryptionOptional

public object DiskEncryption { get; set; }
  • Type: object

Property diskEncryption: Specifies whether to encrypt the disk.

Valid values: true false (default)


EnableDefaultResourcePoolOptional

public object EnableDefaultResourcePool { get; set; }
  • Type: object

Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.

Valid values: true (default) false


KmsIdOptional

public object KmsId { get; set; }
  • Type: object

Property kmsId: The ID of the key used to encrypt data on cloud disks.

This parameter takes effect only when disk encryption is enabled for the AnalyticDB for MySQL cluster.


PeriodOptional

public object Period { get; set; }
  • Type: object

Property period: The unit of the subscription duration.

Valid values:

  • Year
  • Month

This parameter is required if you set PayType to Prepaid.


PeriodTypeOptional

public object PeriodType { get; set; }
  • Type: object

Property periodType: The subscription type of the subscription cluster.

Valid values: Year: subscription on a yearly basis. Month: subscription on a monthly basis. Note This parameter must be specified when PayType is set to Prepaid.


ProductFormOptional

public object ProductForm { get; set; }
  • Type: object

Property productForm: The product form.

Valid values:

  • IntegrationForm: Integration Form.
  • LegacyForm: Data Lakehouse Edition.

ProductVersionOptional

public object ProductVersion { get; set; }
  • Type: object

Property productVersion: The version of the cluster.Note If only ProductForm is set to IntegrationForm, enter this parameter.


ReservedNodeCountOptional

public object ReservedNodeCount { get; set; }
  • Type: object

Property reservedNodeCount: The number of reserved nodes.

  • For Enterprise Edition, the value must be a multiple of 3. The default value is

1.

  • For Basic Edition, the default value is 1.

This parameter is available only when ProductForm is set to IntegrationForm.


ReservedNodeSizeOptional

public object ReservedNodeSize { get; set; }
  • Type: object

Property reservedNodeSize: The resource specification of each reserved node, in ACUs.


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: The resource group ID.


RestoreToTimeOptional

public object RestoreToTime { get; set; }
  • Type: object

Property restoreToTime: The point in time to which you want to restore the cluster.

Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.


RestoreTypeOptional

public object RestoreType { get; set; }
  • Type: object

Property restoreType: The method that you want to use to restore data.

Valid values: backup: restores data from a backup set. You must also specify the BackupSetId and SourceDBClusterId parameters. timepoint: restores data to a point in time. You must also specify the RestoreToTime and SourceDBClusterId parameters.


SecondaryVSwitchIdOptional

public object SecondaryVSwitchId { get; set; }
  • Type: object

Property secondaryVSwitchId: The ID of the secondary vSwitch.

The value of this parameter cannot be the same as the value of the VSwitchId parameter.


SecondaryZoneIdOptional

public object SecondaryZoneId { get; set; }
  • Type: object

Property secondaryZoneId: The ID of the secondary availability zone.

The value of this parameter cannot be the same as the value of the ZoneId parameter.


SourceDbClusterIdOptional

public object SourceDbClusterId { get; set; }
  • Type: object

Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.

If you want to restore a Data Lakehouse Edition cluster from a Data Warehouse Edition cluster, you must specify this parameter.


StorageResourceOptional

public object StorageResource { get; set; }
  • Type: object

Property storageResource: The amount of reserved storage resources.

Unit: AnalyticDB compute units (ACUs). Valid values: 0ACU to 2064ACU. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory. Note This parameter must be specified with a unit.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to cluster.

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