Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::DBCluster, which is used to create an ApsaraDB for ClickHouse cluster.

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)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The edition of the cluster.
dbClusterNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterNetworkType: Network type of the cluster instance, value: VPC.
dbClusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterType: The specification of the cluster.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterVersion: Version, value: 19.15.2.2.
dbNodeCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeCount: The number of nodes.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorage: The storage capacity of a single node.
dbNodeStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorageType: Instance node storage type.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The billing method of the cluster.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterDescription: The description of the cluster.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encryptionKey: KMS key ID.
encryptionType 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property 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.
usedTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property usedTime: The subscription duration.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VpcId.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: VSwitchId.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: ZoneId.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

categoryRequired

  • 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

dbClusterNetworkTypeRequired

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

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

dbClusterTypeRequired

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

dbClusterVersionRequired

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

Property dbClusterVersion: Version, value: 19.15.2.2.

dbNodeCountRequired

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

dbNodeStorageRequired

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

dbNodeStorageTypeRequired

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

Property dbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

paymentTypeRequired

  • 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

dbClusterDescriptionOptional

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

Property dbClusterDescription: The description of the cluster.

encryptionKeyOptional

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

Property encryptionKey: KMS key ID.

encryptionTypeOptional

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

periodOptional

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

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

usedTimeOptional

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

vpcIdOptional

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

Property vpcId: VpcId.

vSwitchIdOptional

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

Property vSwitchId: VSwitchId.

zoneIdOptional

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

Property zoneId: ZoneId.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAliUid com.aliyun.ros.cdk.core.IResolvable Attribute AliUid: AliUid.
attrBid com.aliyun.ros.cdk.core.IResolvable Attribute Bid: BusinessID.
attrCategory com.aliyun.ros.cdk.core.IResolvable Attribute Category: The edition of the cluster.
attrCommodityCode com.aliyun.ros.cdk.core.IResolvable Attribute CommodityCode: Product Code.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionString: ConnectionString.
attrDbClusterDescription com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterDescription: The description of the cluster.
attrDbClusterId com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterId: The id of DBCluster.
attrDbClusterNetworkType com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
attrDbClusterType com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterType: The specification of the cluster.
attrDbClusterVersion com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterVersion: Version, value: 19.15.2.2.
attrDbNodeClass com.aliyun.ros.cdk.core.IResolvable Attribute DBNodeClass: DBNodeClass.
attrDbNodeCount com.aliyun.ros.cdk.core.IResolvable Attribute DBNodeCount: The number of nodes.
attrDbNodeStorage com.aliyun.ros.cdk.core.IResolvable Attribute DBNodeStorage: The storage capacity of a single node.
attrDbNodeStorageType com.aliyun.ros.cdk.core.IResolvable Attribute DbNodeStorageType: Instance node storage type.
attrEncryptionKey com.aliyun.ros.cdk.core.IResolvable Attribute EncryptionKey: KMS key ID.
attrEncryptionType com.aliyun.ros.cdk.core.IResolvable Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
attrEngine com.aliyun.ros.cdk.core.IResolvable Attribute Engine: Engine.
attrEngineVersion com.aliyun.ros.cdk.core.IResolvable Attribute EngineVersion: EngineVersion.
attrIsExpired com.aliyun.ros.cdk.core.IResolvable Attribute IsExpired: IsExpired.
attrLockMode com.aliyun.ros.cdk.core.IResolvable Attribute LockMode: LockMode.
attrLockReason com.aliyun.ros.cdk.core.IResolvable Attribute LockReason: Reason for lock.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: PayType.
attrPeriod 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 com.aliyun.ros.cdk.core.IResolvable Attribute Port: Connection port.
attrPublicConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute PublicConnectionString: Internet connection address.
attrPublicPort com.aliyun.ros.cdk.core.IResolvable Attribute PublicPort: PublicPort.
attrStorageType com.aliyun.ros.cdk.core.IResolvable Attribute StorageType: StorageType.
attrVpcCloudInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute VpcCloudInstanceId: VpcCloudInstanceId.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: VpcId.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: VSwitchId.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: ZoneId.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAliUidRequired 

public IResolvable getAttrAliUid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AliUid: AliUid.

attrBidRequired 

public IResolvable getAttrBid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Bid: BusinessID.

attrCategoryRequired 

public IResolvable getAttrCategory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Category: The edition of the cluster.

attrCommodityCodeRequired 

public IResolvable getAttrCommodityCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CommodityCode: Product Code.

attrConnectionStringRequired 

public IResolvable getAttrConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: ConnectionString.

attrDbClusterDescriptionRequired 

public IResolvable getAttrDbClusterDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterDescription: The description of the cluster.

attrDbClusterIdRequired 

public IResolvable getAttrDbClusterId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterId: The id of DBCluster.

attrDbClusterNetworkTypeRequired 

public IResolvable getAttrDbClusterNetworkType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDbClusterTypeRequired 

public IResolvable getAttrDbClusterType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterType: The specification of the cluster.

attrDbClusterVersionRequired 

public IResolvable getAttrDbClusterVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterVersion: Version, value: 19.15.2.2.

attrDbNodeClassRequired 

public IResolvable getAttrDbNodeClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBNodeClass: DBNodeClass.

attrDbNodeCountRequired 

public IResolvable getAttrDbNodeCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBNodeCount: The number of nodes.

attrDbNodeStorageRequired 

public IResolvable getAttrDbNodeStorage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBNodeStorage: The storage capacity of a single node.

attrDbNodeStorageTypeRequired 

public IResolvable getAttrDbNodeStorageType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.

attrEncryptionKeyRequired 

public IResolvable getAttrEncryptionKey();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EncryptionKey: KMS key ID.

attrEncryptionTypeRequired 

public IResolvable getAttrEncryptionType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrEngineRequired 

public IResolvable getAttrEngine();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Engine: Engine.

attrEngineVersionRequired 

public IResolvable getAttrEngineVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EngineVersion: EngineVersion.

attrIsExpiredRequired 

public IResolvable getAttrIsExpired();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IsExpired: IsExpired.

attrLockModeRequired 

public IResolvable getAttrLockMode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LockMode: LockMode.

attrLockReasonRequired 

public IResolvable getAttrLockReason();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LockReason: Reason for lock.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: PayType.

attrPeriodRequired 

public IResolvable getAttrPeriod();
  • Type: 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.

attrPortRequired 

public IResolvable getAttrPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Connection port.

attrPublicConnectionStringRequired 

public IResolvable getAttrPublicConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicConnectionString: Internet connection address.

attrPublicPortRequired 

public IResolvable getAttrPublicPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicPort: PublicPort.

attrStorageTypeRequired 

public IResolvable getAttrStorageType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StorageType: StorageType.

attrVpcCloudInstanceIdRequired 

public IResolvable getAttrVpcCloudInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcCloudInstanceId: VpcCloudInstanceId.

attrVpcIdRequired 

public IResolvable getAttrVpcId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: VpcId.

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: VSwitchId.

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: ZoneId.