Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import { DBClusterProps } from '@alicloud/ros-cdk-adb'
const dBClusterProps: DBClusterProps = { ... }

Properties

Name Type Description
dbClusterCategory string | @alicloud/ros-cdk-core.IResolvable Property dbClusterCategory: The edition of the cluster.
dbClusterVersion string | @alicloud/ros-cdk-core.IResolvable Property dbClusterVersion: The version of the cluster.
mode string | @alicloud/ros-cdk-core.IResolvable Property mode: The mode of the cluster.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the cluster.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the vSwitch.
computeResource string | @alicloud/ros-cdk-core.IResolvable Property computeResource: The computing resource of the cluster.
dbClusterClass string | @alicloud/ros-cdk-core.IResolvable Property dbClusterClass: The specification of the cluster.
dbClusterDescription string | @alicloud/ros-cdk-core.IResolvable Property dbClusterDescription: The description of the cluster.
dbNodeGroupCount number | @alicloud/ros-cdk-core.IResolvable Property dbNodeGroupCount: The number of node groups.
dbNodeStorage number | @alicloud/ros-cdk-core.IResolvable Property dbNodeStorage: The storage space of the node.
elasticIoResource number | @alicloud/ros-cdk-core.IResolvable Property elasticIoResource: Elastic IO Unit Note the flexible mode cluster will use this parameter.
executorCount number | @alicloud/ros-cdk-core.IResolvable Property executorCount: ExecutorCount.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Valid values when the Period parameter is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
periodType string | @alicloud/ros-cdk-core.IResolvable Property periodType: The subscription period for the cluster.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags to attach to instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID of the cluster.

dbClusterCategoryRequired 

public readonly dbClusterCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterCategory: The edition of the cluster.

Valid values when the cluster is in reserved mode: Basic Cluster When the cluster is in elastic mode, set the value to MixedStorage.

dbClusterVersionRequired 

public readonly dbClusterVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterVersion: The version of the cluster.

Set the value to 3.0.

modeRequired 

public readonly mode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mode: The mode of the cluster.

Valid values: Reserver: the reserved mode Flexible: the elastic mode

payTypeRequired 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method of the cluster.

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

vpcIdRequired 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.

vSwitchIdRequired 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the vSwitch.

computeResourceOptional 

public readonly computeResource: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property computeResource: The computing resource of the cluster.

This parameter is required in elastic mode.

dbClusterClassOptional 

public readonly dbClusterClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly dbClusterDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterDescription: The description of the cluster.

dbNodeGroupCountOptional 

public readonly dbNodeGroupCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property dbNodeGroupCount: The number of node groups.

This parameter is required in reserved mode. Valid values: T8, T16, T32, and T52: 1 C8 and C32: 1 to 128

dbNodeStorageOptional 

public readonly dbNodeStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

elasticIoResourceOptional 

public readonly elasticIoResource: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property elasticIoResource: Elastic IO Unit Note the flexible mode cluster will use this parameter.

executorCountOptional 

public readonly executorCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property executorCount: ExecutorCount.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: Valid values when the Period parameter is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.

Valid values when the Period parameter is set to Year: 1, 2, and 3.

periodTypeOptional 

public readonly periodType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly 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 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID of the cluster.

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