Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Adb;
new DBClusterProps {
    object DbClusterCategory,
    object DbClusterVersion,
    object Mode,
    object PayType,
    object VpcId,
    object VSwitchId,
    object ComputeResource = null,
    object DbClusterClass = null,
    object DbClusterDescription = null,
    object DbNodeGroupCount = null,
    object DbNodeStorage = null,
    object DiskEncryption = null,
    object ElasticIoResource = null,
    object EnableSsl = null,
    object ExecutorCount = null,
    object KmsId = null,
    object Period = null,
    object PeriodType = null,
    object ResourceGroupId = null,
    TagsProperty[] Tags = null,
    object ZoneId = null
};

Properties

Name Type Description
DbClusterCategory object Property dbClusterCategory: The cluster edition.
DbClusterVersion object Property dbClusterVersion: The version of the cluster.
Mode object Property mode: The cluster mode.
PayType object Property payType: The billing method of the cluster.
VpcId object Property vpcId: The ID of the VPC.
VSwitchId object Property vSwitchId: The ID of the vSwitch.
ComputeResource object Property computeResource: The compute resources for the cluster.
DbClusterClass object Property dbClusterClass: The specification of the cluster.
DbClusterDescription object Property dbClusterDescription: The description of the cluster.
DbNodeGroupCount object Property dbNodeGroupCount: The number of node groups.
DbNodeStorage object Property dbNodeStorage: The storage space of the node.
DiskEncryption object Property diskEncryption: Whether to enable cloud disk encryption. Value:.
ElasticIoResource object Property elasticIoResource: The number of Elastic IO Units (EIUs).
EnableSsl object Property enableSsl: Whether to enable SSL link encryption function, value:.
ExecutorCount object Property executorCount: This parameter is reserved.
KmsId object Property kmsId: The kmsId used for cloud disk encryption, effective only when DiskEncryption is true.
Period object Property period: The subscription period unit.
PeriodType object Property periodType: The subscription period for the cluster.
ResourceGroupId object Property resourceGroupId: The ID of the resource group.
Tags TagsProperty[] Property tags: Tags to attach to instance.
ZoneId object Property zoneId: The zone ID of the cluster.

DbClusterCategoryRequired

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

Property dbClusterCategory: The cluster edition.

Valid values:

  • Cluster: reserved cluster.

Reserved clusters are available only in the Chinese mainland and Singapore regions. In the Singapore region, you can purchase reserved clusters only with the pay-as-you-go billing method.

  • MixedStorage: elastic cluster (new).

If you set DBClusterCategory to Cluster, you must set the Mode parameter to Reserved. If you set DBClusterCategory to MixedStorage, you must set the Mode parameter to Flexible. Otherwise, cluster creation will fail.


DbClusterVersionRequired

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

Property dbClusterVersion: The version of the cluster.

Set the value to 3.0.


ModeRequired

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

Property mode: The cluster mode.

Valid values:

  • Reserved: reserved mode.
  • Flexible: flexible mode.

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 ID of the VPC.


VSwitchIdRequired

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

Property vSwitchId: The ID of the vSwitch.


ComputeResourceOptional

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

Property computeResource: The compute resources for the cluster.

Compute resources are used for data queries. A larger amount of compute resources can provide better query performance. Compute resources are available in cluster and single-node editions:

  • Cluster edition: includes specifications such as 16 cores/64 GB, 24 cores/96 GB, and 32 cores or more. The cluster edition supports resource pool isolation, scheduled scaling, and tiered storage of hot and cold data.
  • Single-node edition: includes specifications such as 8 cores/32 GB and 16 cores/64 GB. The single-node edition does not provide an SLA guarantee and has a long recovery time from failures (4 to 8 hours). We do not recommend that you use the single-node edition in production environments.
  • You can call the DescribeAvailableResource operation to query the compute resources that are available in a specific region.
  • This parameter is required when Mode is set to Flexible (flexible mode).

DbClusterClassOptional

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

Property dbClusterClass: The specification of the cluster.

This parameter is required in reserved mode. Valid values: Basic Edition: T8, T16, T32, and T52 Cluster Edition: C8 and C32


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

DbNodeGroupCountOptional

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

Property dbNodeGroupCount: The number of node groups.

The value must be an integer from 1 to 200.

This parameter is required when Mode is set to Reserved (reserved mode).


DbNodeStorageOptional

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

Property dbNodeStorage: The storage space of the node.

This parameter is required in reserved mode. Unit: GB. Valid values: T8: 100 to 500 T16 and T32: 100 to 2000 T52: 100 to 4000 C8: 100 to 1000 C32: 100 to 8000 Note The storage space less than 1,000 GB increases in increments of 100 GB. The storage space greater than 1,000 GB increases in increments of 1,000 GB.


DiskEncryptionOptional

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

Property diskEncryption: Whether to enable cloud disk encryption. Value:.

  • true: yes.
  • false: no.

ElasticIoResourceOptional

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

Property elasticIoResource: The number of Elastic IO Units (EIUs).


EnableSslOptional

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

Property enableSsl: Whether to enable SSL link encryption function, value:.

  • true: open.
  • false: close.

ExecutorCountOptional

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

Property executorCount: This parameter is reserved.


KmsIdOptional

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

Property kmsId: The kmsId used for cloud disk encryption, effective only when DiskEncryption is true.


PeriodOptional

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

Property period: The subscription period unit.

Valid values:

  • Year
  • Month

This parameter is required when PayType is set to Prepaid (subscription).


PeriodTypeOptional

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

Property periodType: The subscription period for the cluster.

This parameter is required if the PayType parameter is set to Prepaid. Valid values: Year: subscription on a yearly basis Month: subscription on a monthly basis


ResourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.


TagsOptional

public TagsProperty[] Tags { get; set; }

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.


ZoneIdOptional

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

Property zoneId: The zone ID of the cluster.

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