Skip to content

RosDBCluster

This class is a base encapsulation around the ROS resource type ALIYUN::ClickHouse::DBCluster, which is used to create an ApsaraDB for ClickHouse cluster.

Initializers 

import com.aliyun.ros.cdk.clickhouse.RosDBCluster;
RosDBCluster.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 - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
usedTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

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

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

categoryRequired

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

dbClusterNetworkTypeRequired

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

dbClusterTypeRequired

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

dbClusterVersionRequired

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

dbNodeCountRequired

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

dbNodeStorageRequired

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

dbNodeStorageTypeRequired

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

paymentTypeRequired

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

dbClusterDescriptionOptional

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

encryptionKeyOptional

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

encryptionTypeOptional

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

periodOptional

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

usedTimeOptional

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

vpcIdOptional

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

vSwitchIdOptional

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

zoneIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
addCondition No description.
addCount No description.
addDeletionOverride Syntactic sugar for addOverride(path, undefined).
addDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc No description.
addMetaData No description.
addOverride Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride Adds an override to a resource property.
addRosDependency No description.
applyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
getAtt Returns a token for an runtime attribute of this resource.

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.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

  • 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

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

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

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

valueRequired

  • Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

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

optionsOptional

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

getAtt 

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: java.lang.String

The name of the attribute.

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.
isRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource Check whether the given construct is a RosResource.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.clickhouse.RosDBCluster;
RosDBCluster.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.clickhouse.RosDBCluster;
RosDBCluster.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrAliUid com.aliyun.ros.cdk.core.IResolvable No description.
attrBid com.aliyun.ros.cdk.core.IResolvable No description.
attrCategory com.aliyun.ros.cdk.core.IResolvable No description.
attrCommodityCode com.aliyun.ros.cdk.core.IResolvable No description.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable No description.
attrDbClusterDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrDbClusterId com.aliyun.ros.cdk.core.IResolvable No description.
attrDbClusterNetworkType com.aliyun.ros.cdk.core.IResolvable No description.
attrDbClusterType com.aliyun.ros.cdk.core.IResolvable No description.
attrDbClusterVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrDbNodeClass com.aliyun.ros.cdk.core.IResolvable No description.
attrDbNodeCount com.aliyun.ros.cdk.core.IResolvable No description.
attrDbNodeStorage com.aliyun.ros.cdk.core.IResolvable No description.
attrDbNodeStorageType com.aliyun.ros.cdk.core.IResolvable No description.
attrEncryptionKey com.aliyun.ros.cdk.core.IResolvable No description.
attrEncryptionType com.aliyun.ros.cdk.core.IResolvable No description.
attrEngine com.aliyun.ros.cdk.core.IResolvable No description.
attrEngineVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrIsExpired com.aliyun.ros.cdk.core.IResolvable No description.
attrLockMode com.aliyun.ros.cdk.core.IResolvable No description.
attrLockReason com.aliyun.ros.cdk.core.IResolvable No description.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable No description.
attrPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrPort com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicConnectionString com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicPort com.aliyun.ros.cdk.core.IResolvable No description.
attrStorageType com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcCloudInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcId com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
attrZoneId com.aliyun.ros.cdk.core.IResolvable No description.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbNodeStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbClusterDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
usedTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

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

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

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

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stackRequired 

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

refRequired 

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

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptionsRequired 

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

rosResourceTypeRequired 

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

ROS resource type.

attrAliUidRequired 

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

attrBidRequired 

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

attrCategoryRequired 

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

attrCommodityCodeRequired 

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

attrConnectionStringRequired 

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

attrDbClusterDescriptionRequired 

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

attrDbClusterIdRequired 

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

attrDbClusterNetworkTypeRequired 

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

attrDbClusterTypeRequired 

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

attrDbClusterVersionRequired 

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

attrDbNodeClassRequired 

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

attrDbNodeCountRequired 

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

attrDbNodeStorageRequired 

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

attrDbNodeStorageTypeRequired 

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

attrEncryptionKeyRequired 

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

attrEncryptionTypeRequired 

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

attrEngineRequired 

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

attrEngineVersionRequired 

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

attrIsExpiredRequired 

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

attrLockModeRequired 

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

attrLockReasonRequired 

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

attrPaymentTypeRequired 

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

attrPeriodRequired 

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

attrPortRequired 

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

attrPublicConnectionStringRequired 

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

attrPublicPortRequired 

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

attrStorageTypeRequired 

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

attrVpcCloudInstanceIdRequired 

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

attrVpcIdRequired 

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

attrVSwitchIdRequired 

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

attrZoneIdRequired 

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

categoryRequired 

public java.lang.Object getCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

dbClusterNetworkTypeRequired 

public java.lang.Object getDbClusterNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

dbClusterTypeRequired 

public java.lang.Object getDbClusterType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

dbClusterVersionRequired 

public java.lang.Object getDbClusterVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

dbNodeCountRequired 

public java.lang.Object getDbNodeCount();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

dbNodeStorageRequired 

public java.lang.Object getDbNodeStorage();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

dbNodeStorageTypeRequired 

public java.lang.Object getDbNodeStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

paymentTypeRequired 

public java.lang.Object getPaymentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

dbClusterDescriptionOptional 

public java.lang.Object getDbClusterDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

encryptionKeyOptional 

public java.lang.Object getEncryptionKey();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

encryptionTypeOptional 

public java.lang.Object getEncryptionType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

usedTimeOptional 

public java.lang.Object getUsedTime();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

vpcIdOptional 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

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

The resource type name for this resource class.