EnterpriseDBCluster

• Implements: IEnterpriseDBCluster

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

Initializers

import com.aliyun.ros.cdk.clickhouse.EnterpriseDBCluster;
EnterpriseDBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .engine(java.lang.String)
    .engine(IResolvable)
    .nodeCount(java.lang.Number)
    .nodeCount(IResolvable)
    .nodeScaleMax(java.lang.Number)
    .nodeScaleMax(IResolvable)
    .nodeScaleMin(java.lang.Number)
    .nodeScaleMin(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .backupSetId(java.lang.String)
//  .backupSetId(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbTimeZone(java.lang.String)
//  .dbTimeZone(IResolvable)
//  .deploySchema(java.lang.String)
//  .deploySchema(IResolvable)
//  .multiZone(IResolvable)
//  .multiZone(java.util.List<IResolvable)
//  .multiZone(MultiZoneProperty>)
//  .publicConnectionSetting(IResolvable)
//  .publicConnectionSetting(PublicConnectionSettingProperty)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .sourceDbInstanceId(java.lang.String)
//  .sourceDbInstanceId(IResolvable)
//  .storageQuota(java.lang.Number)
//  .storageQuota(IResolvable)
//  .storageType(java.lang.String)
//  .storageType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

engine^Required

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

Property engine: The engine type.

nodeCount^Required

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

Property nodeCount: The number of nodes.

Valid values: 2 to 16. This parameter is required when you configure an elastic scaling range by using the NodeScaleMin and NodeScaleMax parameters.

nodeScaleMax^Required

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

Property nodeScaleMax: The maximum number of nodes for scaling.

nodeScaleMin^Required

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

Property nodeScaleMin: The minimum number of nodes for scaling.

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.

zoneId^Required

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

Property zoneId: The ID of the zone.

backupSetId^Optional

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

Property backupSetId: The ID of the backup set.

dbInstanceDescription^Optional

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

Property dbInstanceDescription: The description of the database instance.

dbTimeZone^Optional

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

Property dbTimeZone: The time zone of the database, which must be an IANA time zone identifier.

deploySchema^Optional

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

Property deploySchema: The deployment schema.

multiZone^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListMultiZoneProperty>

Property multiZone: Multi-zone configuration.

publicConnectionSetting^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR PublicConnectionSettingProperty

Property publicConnectionSetting: The public connection setting.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

sourceDbInstanceId^Optional

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

Property sourceDbInstanceId: The ID of the source instance.

This parameter is required when restoring from a backup.

storageQuota^Optional

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

Property storageQuota: The storage quota.

storageType^Optional

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

Property storageType: The type of storage.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to clickhouse_enterprise_db.

Max support 20 tags to add during create clickhouse_enterprise_db. Each tag with two properties Key and Value, and Key is required.

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

attrDbInstanceId^Required

public java.lang.Object getAttrDbInstanceId();

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

Attribute DBInstanceId: The ID of the database instance.

attrPrivateConnectionString^Required

public java.lang.Object getAttrPrivateConnectionString();

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

Attribute PrivateConnectionString: The private connection string.

attrPublicConnectionString^Required

public java.lang.Object getAttrPublicConnectionString();

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

Attribute PublicConnectionString: The public connection string.

props^Required

public EnterpriseDBClusterProps getProps();

• Type: EnterpriseDBClusterProps