DBCluster

• Implements: IDBCluster

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

Initializers

import com.aliyun.ros.cdk.clickhouse.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .category(java.lang.String)
    .category(IResolvable)
    .dbClusterNetworkType(java.lang.String)
    .dbClusterNetworkType(IResolvable)
    .dbClusterType(java.lang.String)
    .dbClusterType(IResolvable)
    .dbClusterVersion(java.lang.String)
    .dbClusterVersion(IResolvable)
    .dbNodeCount(java.lang.Number)
    .dbNodeCount(IResolvable)
    .dbNodeStorage(java.lang.Number)
    .dbNodeStorage(IResolvable)
    .dbNodeStorageType(java.lang.String)
    .dbNodeStorageType(IResolvable)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .encryptionType(java.lang.String)
//  .encryptionType(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .usedTime(java.lang.Number)
//  .usedTime(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchBak(java.lang.String)
//  .vSwitchBak(IResolvable)
//  .vSwitchBak2(java.lang.String)
//  .vSwitchBak2(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zondIdBak2(java.lang.String)
//  .zondIdBak2(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
//  .zoneIdBak(java.lang.String)
//  .zoneIdBak(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

category^Required

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

Property category: The edition of the cluster.

Valid values: Basic: Single-replica Edition HighAvailability: Double-replica Edition

dbClusterNetworkType^Required

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

Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.

dbClusterType^Required

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

Property dbClusterType: The specification of the cluster.

If the cluster is of the Single-replica Edition, the following values are valid: S4: 4 cores, 16 GB. S8: 8 cores, 32 GB. S16: 16 cores, 64 GB. S32: 32 cores, 128 GB. S64: 64 cores, 256 GB. S104: 104 cores, 384 GB. If the cluster is of the Double-replica Edition, the following values are valid: C4: 4 cores, 16 GB. C8: 8 cores, 32 GB. C16: 16 cores, 64 GB. C32: 32 cores, 128 GB. C64: 64 cores, 256 GB. C104: 104 cores, 384 GB.

dbClusterVersion^Required

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

Property dbClusterVersion: Version, value: 19.15.2.2.

dbNodeCount^Required

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

Property dbNodeCount: The number of nodes.

If the cluster is of the Single-replica Edition, the value ranges from 1 to 48. If the cluster is of the Double-replica Edition, the value ranges from 1 to 24.

dbNodeStorage^Required

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

Property dbNodeStorage: The storage capacity of a single node.

Valid values: 100 to 32000. Unit: GB. Note self value is a multiple of 100.

dbNodeStorageType^Required

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

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

paymentType^Required

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

Property paymentType: The billing method of the cluster.

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

dbClusterDescription^Optional

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

Property dbClusterDescription: The description of the cluster.

encryptionKey^Optional

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

Property encryptionKey: KMS key ID.

encryptionType^Optional

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

Property encryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.

period^Optional

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

Property period: The subscription duration unit.

This parameter is required only when PayType is set to Prepaid.>

• Year: Measured in years.
• Month: Measured in months.

usedTime^Optional

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

Property usedTime: The subscription duration.

Valid values: When Period is Month, it could be from 1 to 9, 12, 24, 36. When Period is Year, it could be from 1 to 3.

vpcId^Optional

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

Property vpcId: VpcId.

vSwitchBak^Optional

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

Property vSwitchBak: The ID of the secondary VSwitch.

vSwitchBak2^Optional

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

Property vSwitchBak2: The ID of the third VSwitch.

vSwitchId^Optional

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

Property vSwitchId: VSwitchId.

zondIdBak2^Optional

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

Property zondIdBak2: The ID of the third zone.

zoneId^Optional

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

Property zoneId: ZoneId.

zoneIdBak^Optional

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

Property zoneIdBak: The ID of the secondary zone.

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

attrAliUid^Required

public java.lang.Object getAttrAliUid();

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

Attribute AliUid: AliUid.

attrBid^Required

public java.lang.Object getAttrBid();

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

Attribute Bid: BusinessID.

attrCategory^Required

public java.lang.Object getAttrCategory();

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

Attribute Category: The edition of the cluster.

attrCommodityCode^Required

public java.lang.Object getAttrCommodityCode();

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

Attribute CommodityCode: Product Code.

attrConnectionString^Required

public java.lang.Object getAttrConnectionString();

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

Attribute ConnectionString: ConnectionString.

attrDbClusterDescription^Required

public java.lang.Object getAttrDbClusterDescription();

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

Attribute DBClusterDescription: The description of the cluster.

attrDbClusterId^Required

public java.lang.Object getAttrDbClusterId();

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

Attribute DBClusterId: The id of DBCluster.

attrDbClusterNetworkType^Required

public java.lang.Object getAttrDbClusterNetworkType();

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

Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.

attrDbClusterType^Required

public java.lang.Object getAttrDbClusterType();

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

Attribute DBClusterType: The specification of the cluster.

attrDbClusterVersion^Required

public java.lang.Object getAttrDbClusterVersion();

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

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attrDbNodeClass^Required

public java.lang.Object getAttrDbNodeClass();

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

Attribute DBNodeClass: DBNodeClass.

attrDbNodeCount^Required

public java.lang.Object getAttrDbNodeCount();

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

Attribute DBNodeCount: The number of nodes.

attrDbNodeStorage^Required

public java.lang.Object getAttrDbNodeStorage();

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

Attribute DBNodeStorage: The storage capacity of a single node.

attrDbNodeStorageType^Required

public java.lang.Object getAttrDbNodeStorageType();

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

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attrEncryptionKey^Required

public java.lang.Object getAttrEncryptionKey();

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

Attribute EncryptionKey: KMS key ID.

attrEncryptionType^Required

public java.lang.Object getAttrEncryptionType();

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

Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.

attrEngine^Required

public java.lang.Object getAttrEngine();

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

Attribute Engine: Engine.

attrEngineVersion^Required

public java.lang.Object getAttrEngineVersion();

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

Attribute EngineVersion: EngineVersion.

attrIsExpired^Required

public java.lang.Object getAttrIsExpired();

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

Attribute IsExpired: IsExpired.

attrLockMode^Required

public java.lang.Object getAttrLockMode();

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

Attribute LockMode: LockMode.

attrLockReason^Required

public java.lang.Object getAttrLockReason();

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

Attribute LockReason: Reason for lock.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: PayType.

attrPeriod^Required

public java.lang.Object getAttrPeriod();

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

Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.

attrPort^Required

public java.lang.Object getAttrPort();

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

Attribute Port: Connection port.

attrPublicConnectionString^Required

public java.lang.Object getAttrPublicConnectionString();

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

Attribute PublicConnectionString: Internet connection address.

attrPublicPort^Required

public java.lang.Object getAttrPublicPort();

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

Attribute PublicPort: PublicPort.

attrStorageType^Required

public java.lang.Object getAttrStorageType();

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

Attribute StorageType: StorageType.

attrVpcCloudInstanceId^Required

public java.lang.Object getAttrVpcCloudInstanceId();

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

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

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

Attribute VpcId: VpcId.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

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

Attribute VSwitchId: VSwitchId.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

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

Attribute ZoneId: ZoneId.

props^Required

public DBClusterProps getProps();

• Type: DBClusterProps