Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkadb"
&alicloudroscdkadb.DBClusterProps {
    DbClusterCategory: interface{},
    DbClusterVersion: interface{},
    Mode: interface{},
    PayType: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ComputeResource: interface{},
    DbClusterClass: interface{},
    DbClusterDescription: interface{},
    DbNodeGroupCount: interface{},
    DbNodeStorage: interface{},
    DiskEncryption: interface{},
    ElasticIoResource: interface{},
    EnableSsl: interface{},
    ExecutorCount: interface{},
    KmsId: interface{},
    Period: interface{},
    PeriodType: interface{},
    ResourceGroupId: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkadb.RosDBCluster.TagsProperty,
    ZoneId: interface{},
}

Properties

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

DbClusterCategoryRequired

DbClusterCategory interface{}
  • Type: interface{}

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

DbClusterVersion interface{}
  • Type: interface{}

Property dbClusterVersion: The version of the cluster.

Set the value to 3.0.


ModeRequired

Mode interface{}
  • Type: interface{}

Property mode: The cluster mode.

Valid values:

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

PayTypeRequired

PayType interface{}
  • Type: interface{}

Property payType: The billing method of the cluster.

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


VpcIdRequired

VpcId interface{}
  • Type: interface{}

Property vpcId: The ID of the VPC.


VSwitchIdRequired

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The ID of the vSwitch.


ComputeResourceOptional

ComputeResource interface{}
  • Type: interface{}

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

DbClusterClass interface{}
  • Type: interface{}

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

DbClusterDescription interface{}
  • Type: interface{}

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

DbNodeGroupCount interface{}
  • Type: interface{}

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

DbNodeStorage interface{}
  • Type: interface{}

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

DiskEncryption interface{}
  • Type: interface{}

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

  • true: yes.
  • false: no.

ElasticIoResourceOptional

ElasticIoResource interface{}
  • Type: interface{}

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


EnableSslOptional

EnableSsl interface{}
  • Type: interface{}

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

  • true: open.
  • false: close.

ExecutorCountOptional

ExecutorCount interface{}
  • Type: interface{}

Property executorCount: This parameter is reserved.


KmsIdOptional

KmsId interface{}
  • Type: interface{}

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


PeriodOptional

Period interface{}
  • Type: interface{}

Property period: The subscription period unit.

Valid values:

  • Year
  • Month

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


PeriodTypeOptional

PeriodType interface{}
  • Type: interface{}

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

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.


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.


ZoneIdOptional

ZoneId interface{}
  • Type: interface{}

Property zoneId: The zone ID of the cluster.

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