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)
// .diskEncryption(java.lang.Boolean)
// .diskEncryption(IResolvable)
// .elasticIoResource(java.lang.Number)
// .elasticIoResource(IResolvable)
// .enableSsl(java.lang.Boolean)
// .enableSsl(IResolvable)
// .executorCount(java.lang.Number)
// .executorCount(IResolvable)
// .kmsId(java.lang.String)
// .kmsId(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 cluster edition. |
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 cluster mode. |
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 compute resources for 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. |
diskEncryption | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property diskEncryption: Whether to enable cloud disk encryption. Value:. |
elasticIoResource | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property elasticIoResource: The number of Elastic IO Units (EIUs). |
enableSsl | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableSsl: Whether to enable SSL link encryption function, value:. |
executorCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property executorCount: This parameter is reserved. |
kmsId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property kmsId: The kmsId used for cloud disk encryption, effective only when DiskEncryption is true. |
period | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property period: The subscription period unit. |
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 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
DBClusterCategorytoCluster, you must set theModeparameter toReserved. If you setDBClusterCategorytoMixedStorage, you must set theModeparameter toFlexible. Otherwise, cluster creation will fail.
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 cluster mode.
Valid values:
- Reserved: reserved mode.
- Flexible: flexible 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 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
Modeis set toFlexible(flexible 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.
- The description cannot start with
http:\/\/orhttps:\/\/. - The description must be 2 to 256 characters long.
dbNodeGroupCountOptional
public java.lang.Object getDbNodeGroupCount();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property dbNodeGroupCount: The number of node groups.
The value must be an integer from 1 to 200.
This parameter is required when
Modeis set toReserved(reserved mode).
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.
diskEncryptionOptional
public java.lang.Object getDiskEncryption();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property diskEncryption: Whether to enable cloud disk encryption. Value:.
- true: yes.
- false: no.
elasticIoResourceOptional
public java.lang.Object getElasticIoResource();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property elasticIoResource: The number of Elastic IO Units (EIUs).
enableSslOptional
public java.lang.Object getEnableSsl();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableSsl: Whether to enable SSL link encryption function, value:.
- true: open.
- false: close.
executorCountOptional
public java.lang.Object getExecutorCount();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property executorCount: This parameter is reserved.
kmsIdOptional
public java.lang.Object getKmsId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property kmsId: The kmsId used for cloud disk encryption, effective only when DiskEncryption is true.
periodOptional
public java.lang.Object getPeriod();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: The subscription period unit.
Valid values:
- Year
- Month
This parameter is required when
PayTypeis set toPrepaid(subscription).
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();
- Type: java.util.List<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 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.