EnterpriseDBCluster

• Implements: com.aliyun.ros.cdk.clickhouse.datasource.IEnterpriseDBCluster

This class encapsulates and extends the ROS resource type DATASOURCE::ClickHouse::EnterpriseDBCluster.

Initializers

import com.aliyun.ros.cdk.clickhouse.datasource.EnterpriseDBCluster;
EnterpriseDBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dbInstanceId^Required

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

Property dbInstanceId: The cluster ID.

refreshOptions^Optional

• 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

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.datasource.EnterpriseDBCluster;
EnterpriseDBCluster.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

attrCategory^Required

public java.lang.Object getAttrCategory();

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

Attribute Category: Type, value description: enterprise: Enterprise Edition.

attrChargeType^Required

public java.lang.Object getAttrChargeType();

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

Attribute ChargeType: The billing method.

Enterprise Edition clusters use the pay-as-you-go billing method.

attrComputingGroupIds^Required

public java.lang.Object getAttrComputingGroupIds();

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

Attribute ComputingGroupIds: The list of computing group IDs.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The creation time of the cluster.

attrDbInstanceId^Required

public java.lang.Object getAttrDbInstanceId();

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

Attribute DBInstanceId: The cluster ID.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The cluster description.

attrDisabledPorts^Required

public java.lang.Object getAttrDisabledPorts();

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

Attribute DisabledPorts: The specified database port is disabled.

Multiple ports separated by commas (,) are supported.

attrEndpoints^Required

public java.lang.Object getAttrEndpoints();

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

Attribute Endpoints: List of Endpoint details.

attrEngine^Required

public java.lang.Object getAttrEngine();

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

Attribute Engine: The engine type.

attrEngineMinorVersion^Required

public java.lang.Object getAttrEngineMinorVersion();

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

Attribute EngineMinorVersion: The minor version number of the cluster engine.

attrEngineVersion^Required

public java.lang.Object getAttrEngineVersion();

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

Attribute EngineVersion: The engine version.

attrInstanceNetworkType^Required

public java.lang.Object getAttrInstanceNetworkType();

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

Attribute InstanceNetworkType: The network type of the instance.

attrMaintainEndTime^Required

public java.lang.Object getAttrMaintainEndTime();

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

Attribute MaintainEndTime: The end time of the maintenance window.

attrMaintainStartTime^Required

public java.lang.Object getAttrMaintainStartTime();

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

Attribute MaintainStartTime: The maintainable time start time.

attrMultiZones^Required

public java.lang.Object getAttrMultiZones();

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

Attribute MultiZones: The information about the zones.

attrNodeCount^Required

public java.lang.Object getAttrNodeCount();

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

Attribute NodeCount: The number of nodes.

The value range is 2-16. Required when you use NodeScaleMin and NodeScaleMax to configure an elastic interval.

attrNodes^Required

public java.lang.Object getAttrNodes();

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

Attribute Nodes: The Node information.

attrNodeScaleMax^Required

public java.lang.Object getAttrNodeScaleMax();

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

Attribute NodeScaleMax: The maximum value of serverless node auto scaling.

attrNodeScaleMin^Required

public java.lang.Object getAttrNodeScaleMin();

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

Attribute NodeScaleMin: Minimum number of Serverless nodes for auto-scaling.

attrObjectStoreSize^Required

public java.lang.Object getAttrObjectStoreSize();

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

Attribute ObjectStoreSize: The size of the object storage space.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

attrScaleMax^Required

public java.lang.Object getAttrScaleMax();

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

Attribute ScaleMax: The maximum capacity for elastic scaling.

attrScaleMin^Required

public java.lang.Object getAttrScaleMin();

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

Attribute ScaleMin: The minimum capacity for elastic scaling.

attrStorageQuota^Required

public java.lang.Object getAttrStorageQuota();

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

Attribute StorageQuota: Storage Pre-purchased Capacity (GB).

attrStorageSize^Required

public java.lang.Object getAttrStorageSize();

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

Attribute StorageSize: The size of the storage space.

Unit: GB.

attrStorageType^Required

public java.lang.Object getAttrStorageType();

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

Attribute StorageType: The storage type.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: The details of the tags.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

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

Attribute VpcId: The VPC ID.

attrVswitchId^Required

public java.lang.Object getAttrVswitchId();

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

Attribute VswitchId: The VSwitch ID.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

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

Attribute ZoneId: The zone ID.

props^Required

public EnterpriseDBClusterProps getProps();

• Type: EnterpriseDBClusterProps