Skip to content

DBCluster

This class encapsulates and extends the ROS resource type DATASOURCE::ClickHouse::DBCluster, which is used to query the information about an ApsaraDB for ClickHouse cluster.

Initializers 

import com.aliyun.ros.cdk.clickhouse.datasource.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
dbClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterId: Instance ID.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbClusterIdRequired

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

Property dbClusterId: Instance ID.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.datasource.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: Alibaba Cloud account.
attrBid com.aliyun.ros.cdk.core.IResolvable Attribute Bid: The ID of the business process flow.
attrCategory com.aliyun.ros.cdk.core.IResolvable Attribute Category: Copy configuration, value description:.
attrCommodityCode com.aliyun.ros.cdk.core.IResolvable Attribute CommodityCode: Buy Product Code.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionString: Connection string.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrDbClusterId com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterId: Instance ID.
attrDbClusterIpArrayName com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
attrDbClusterName com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterName: The cluster description information.
attrDbClusterNetworkType com.aliyun.ros.cdk.core.IResolvable Attribute DbClusterNetworkType: Network type.
attrDbClusterType com.aliyun.ros.cdk.core.IResolvable Attribute DBClusterType: Instance type.
attrDbNodeClass com.aliyun.ros.cdk.core.IResolvable Attribute DbNodeClass: Set the node type.
attrDbNodeCount com.aliyun.ros.cdk.core.IResolvable Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
attrDbNodeStorage com.aliyun.ros.cdk.core.IResolvable Attribute DbNodeStorage: Single-node storage space.
attrEncryptionKey com.aliyun.ros.cdk.core.IResolvable Attribute EncryptionKey: Key management service KMS key ID.
attrEncryptionType com.aliyun.ros.cdk.core.IResolvable Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
attrEngine com.aliyun.ros.cdk.core.IResolvable Attribute Engine: Engine.
attrEngineVersion com.aliyun.ros.cdk.core.IResolvable Attribute EngineVersion: The engine version.
attrExpireTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpireTime: The expiration time.
attrIsExpired com.aliyun.ros.cdk.core.IResolvable Attribute IsExpired: If the instance has expired.
attrLockMode com.aliyun.ros.cdk.core.IResolvable Attribute LockMode: The lock mode.
attrLockReason com.aliyun.ros.cdk.core.IResolvable Attribute LockReason: Lock reason.
attrMaintainTime com.aliyun.ros.cdk.core.IResolvable Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The paymen type of the resource.
attrPort com.aliyun.ros.cdk.core.IResolvable Attribute Port: Connection port.
attrPublicConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute PublicConnectionString: A public IP address for the connection.
attrPublicIpAddr com.aliyun.ros.cdk.core.IResolvable Attribute PublicIpAddr: Public IP address.
attrPublicPort com.aliyun.ros.cdk.core.IResolvable Attribute PublicPort: Public network port.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrScaleOutStatus com.aliyun.ros.cdk.core.IResolvable Attribute ScaleOutStatus: Scale state.
attrSecurityIps com.aliyun.ros.cdk.core.IResolvable Attribute SecurityIps: The whitelist supports the following two formats:.
attrStorageType com.aliyun.ros.cdk.core.IResolvable Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
attrSupportBackup com.aliyun.ros.cdk.core.IResolvable Attribute SupportBackup: Support fallback scheme.
attrSupportHttpsPort com.aliyun.ros.cdk.core.IResolvable Attribute SupportHttpsPort: The system supports http port number.
attrSupportMysqlPort com.aliyun.ros.cdk.core.IResolvable Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
attrSupportOss com.aliyun.ros.cdk.core.IResolvable Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
attrVpcCloudInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: VPC ID.
attrVpcIpAddr com.aliyun.ros.cdk.core.IResolvable Attribute VpcIpAddr: VPC IP address.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: Switch ID.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: On behalf of the zone resource attribute field.

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: Alibaba Cloud account.

attrBidRequired 

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

Attribute Bid: The ID of the business process flow.

attrCategoryRequired 

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

Attribute Category: Copy configuration, value description:.

attrCommodityCodeRequired 

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

Attribute CommodityCode: Buy Product Code.

attrConnectionStringRequired 

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

Attribute ConnectionString: Connection string.

attrCreateTimeRequired 

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

Attribute CreateTime: The creation time of the resource.

attrDbClusterIdRequired 

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

Attribute DBClusterId: Instance ID.

attrDbClusterIpArrayNameRequired 

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

Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.

attrDbClusterNameRequired 

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

Attribute DBClusterName: The cluster description information.

attrDbClusterNetworkTypeRequired 

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

Attribute DbClusterNetworkType: Network type.

Currently, only VPC is supported.

attrDbClusterTypeRequired 

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

Attribute DBClusterType: Instance type.

attrDbNodeClassRequired 

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

Attribute DbNodeClass: Set the node type.

attrDbNodeCountRequired 

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

Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.

attrDbNodeStorageRequired 

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

Attribute DbNodeStorage: Single-node storage space.

Value range: 100 GB to 32000GB.

attrEncryptionKeyRequired 

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

Attribute EncryptionKey: Key management service KMS key ID.

attrEncryptionTypeRequired 

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

Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

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: The engine version.

attrExpireTimeRequired 

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

Attribute ExpireTime: The expiration time.

attrIsExpiredRequired 

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

Attribute IsExpired: If the instance has expired.

attrLockModeRequired 

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

Attribute LockMode: The lock mode.

attrLockReasonRequired 

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

Attribute LockReason: Lock reason.

attrMaintainTimeRequired 

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

Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.

attrPaymentTypeRequired 

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

Attribute PaymentType: The paymen type of the resource.

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: A public IP address for the connection.

attrPublicIpAddrRequired 

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

Attribute PublicIpAddr: Public IP address.

attrPublicPortRequired 

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

Attribute PublicPort: Public network port.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrScaleOutStatusRequired 

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

Attribute ScaleOutStatus: Scale state.

attrSecurityIpsRequired 

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

Attribute SecurityIps: The whitelist supports the following two formats:.

attrStorageTypeRequired 

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

Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.

attrSupportBackupRequired 

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

Attribute SupportBackup: Support fallback scheme.

attrSupportHttpsPortRequired 

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

Attribute SupportHttpsPort: The system supports http port number.

attrSupportMysqlPortRequired 

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

Attribute SupportMysqlPort: Supports Mysql, and those of the ports.

attrSupportOssRequired 

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

Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.

attrVpcCloudInstanceIdRequired 

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

Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.

attrVpcIdRequired 

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

Attribute VpcId: VPC ID.

attrVpcIpAddrRequired 

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

Attribute VpcIpAddr: VPC IP address.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Switch ID.

attrZoneIdRequired 

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

Attribute ZoneId: On behalf of the zone resource attribute field.