DBCluster

• Implements: IDBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ADB::DBCluster.

Initializers

import com.aliyun.ros.cdk.adb.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dbClusterCategory^Required

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

dbClusterVersion^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterVersion: The version of the cluster.

Set the value to 3.0.

mode^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mode: The cluster mode.

Valid values:

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

payType^Required

• 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

vpcId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The ID of the VPC.

vSwitchId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the vSwitch.

computeResource^Optional

• 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 Mode is set to Flexible (flexible mode).

dbClusterClass^Optional

• 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

dbClusterDescription^Optional

• 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 long.

dbNodeGroupCount^Optional

• 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 Mode is set to Reserved (reserved mode).

dbNodeStorage^Optional

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

diskEncryption^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

• true: yes.
• false: no.

elasticIoResource^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

enableSsl^Optional

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

executorCount^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property executorCount: This parameter is reserved.

kmsId^Optional

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

period^Optional

• 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 PayType is set to Prepaid (subscription).

periodType^Optional

• 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

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tags^Optional

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

zoneId^Optional

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.adb.DBCluster;
DBCluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrConnectionString^Required

public java.lang.Object getAttrConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: Vpc connection string.

attrDbClusterId^Required

public java.lang.Object getAttrDbClusterId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterId: The ID of the cluster.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The ID of the order.

props^Required

public DBClusterProps getProps();

• Type: DBClusterProps