Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import com.aliyun.ros.cdk.adb.DBClusterProps;
DBClusterProps.builder()
    .dbClusterCategory(java.lang.String)
    .dbClusterCategory(IResolvable)
    .dbClusterVersion(java.lang.String)
    .dbClusterVersion(IResolvable)
    .mode(java.lang.String)
    .mode(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .computeResource(java.lang.String)
//  .computeResource(IResolvable)
//  .dbClusterClass(java.lang.String)
//  .dbClusterClass(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .dbNodeGroupCount(java.lang.Number)
//  .dbNodeGroupCount(IResolvable)
//  .dbNodeStorage(java.lang.Number)
//  .dbNodeStorage(IResolvable)
//  .elasticIoResource(java.lang.Number)
//  .elasticIoResource(IResolvable)
//  .executorCount(java.lang.Number)
//  .executorCount(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
dbClusterCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterCategory: The edition of the cluster.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterVersion: The version of the cluster.
mode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mode: The mode of the cluster.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the cluster.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch.
computeResource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property computeResource: The computing resource of the cluster.
dbClusterClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterClass: The specification of the cluster.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterDescription: The description of the cluster.
dbNodeGroupCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeGroupCount: The number of node groups.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorage: The storage space of the node.
elasticIoResource java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property elasticIoResource: Elastic IO Unit Note the flexible mode cluster will use this parameter.
executorCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property executorCount: ExecutorCount.
period java.lang.Number OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodType: The subscription period for the cluster.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the cluster.

dbClusterCategoryRequired 

public java.lang.Object getDbClusterCategory();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbClusterVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterVersion: The version of the cluster.

Set the value to 3.0.

modeRequired 

public java.lang.Object getMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mode: The mode of the cluster.

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

payTypeRequired 

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: The billing method of the cluster.

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

vpcIdRequired 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The ID of the VPC.

vSwitchIdRequired 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the vSwitch.

computeResourceOptional 

public java.lang.Object getComputeResource();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property computeResource: The computing resource of the cluster.

This parameter is required in elastic mode.

dbClusterClassOptional 

public java.lang.Object getDbClusterClass();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbClusterDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterDescription: The description of the cluster.

dbNodeGroupCountOptional 

public java.lang.Object getDbNodeGroupCount();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDbNodeStorage();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getElasticIoResource();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

executorCountOptional 

public java.lang.Object getExecutorCount();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property executorCount: ExecutorCount.

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public java.util.List<TagsProperty> getTags();

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 java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.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.