Skip to content

DBClusterProps

Properties for defining a DBCluster.

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

Initializer 

import com.aliyun.ros.cdk.adblake.DBClusterProps;
DBClusterProps.builder()
    .computeResource(java.lang.String)
    .computeResource(IResolvable)
    .dbClusterVersion(java.lang.String)
    .dbClusterVersion(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .storageResource(java.lang.String)
    .storageResource(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .backupSetId(java.lang.String)
//  .backupSetId(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .enableDefaultResourcePool(java.lang.Boolean)
//  .enableDefaultResourcePool(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreToTime(java.lang.String)
//  .restoreToTime(IResolvable)
//  .restoreType(java.lang.String)
//  .restoreType(IResolvable)
//  .sourceDbClusterId(java.lang.String)
//  .sourceDbClusterId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
computeResource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property computeResource: The amount of reserved computing resources.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterVersion: The version of the cluster.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the cluster.
storageResource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageResource: The amount of reserved storage resources.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The virtual private cloud (VPC) ID of the cluster.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch ID of the cluster.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID.
backupSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupSetId: The ID of the backup set that you want to use to restore data.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterDescription: The description of the cluster.
enableDefaultResourcePool java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
period java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription duration of the subscription cluster.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodType: The subscription type of the subscription cluster.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The resource group ID.
restoreToTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreToTime: The point in time to which you want to restore data from the backup set.
restoreType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreType: The method that you want to use to restore data.
sourceDbClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.
tags java.util.List<TagsProperty> Property tags: Tags to attach to cluster.

computeResourceRequired 

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

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.

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

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.

storageResourceRequired 

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

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.

vpcIdRequired 

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

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

vSwitchIdRequired 

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

Property vSwitchId: The vSwitch ID of the cluster.

zoneIdRequired 

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

Property zoneId: The zone ID.

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

backupSetIdOptional 

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

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.

dbClusterDescriptionOptional 

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

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

enableDefaultResourcePoolOptional 

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

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

Valid values: true (default) false

periodOptional 

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

Property period: The subscription duration of the subscription cluster.

Valid values when Period is set to Year: 1 to 3 (integer). Valid values when Period is set to Month: 1 to 9 (integer). Note This parameter must be specified when PayType is set to Prepaid.

periodTypeOptional 

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

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.

resourceGroupIdOptional 

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

Property resourceGroupId: The resource group ID.

restoreToTimeOptional 

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

Property restoreToTime: The point in time to which you want to restore data from the backup set.

restoreTypeOptional 

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

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.

sourceDbClusterIdOptional 

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

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.

tagsOptional 

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

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.