RosEnterpriseDBCluster

This class is a base encapsulation around the ROS resource type ALIYUN::ClickHouse::EnterpriseDBCluster.

Initializers

import com.aliyun.ros.cdk.clickhouse.RosEnterpriseDBCluster;
RosEnterpriseDBCluster.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

scope in which this resource is defined.

id^Required

• Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

engine^Required

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

nodeCount^Required

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

nodeScaleMax^Required

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

nodeScaleMin^Required

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

vpcId^Required

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

vSwitchId^Required

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

zoneId^Required

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

backupSetId^Optional

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

dbInstanceDescription^Optional

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

dbTimeZone^Optional

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

deploySchema^Optional

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

multiZone^Optional

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

publicConnectionSetting^Optional

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

resourceGroupId^Optional

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

sourceDbInstanceId^Optional

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

storageQuota^Optional

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

storageType^Optional

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

tags^Optional

• Type: java.util.List<TagsProperty>

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.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

addCondition

public void addCondition(RosCondition con)

con^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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

path^Required

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

target^Required

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

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

addMetaData

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

key^Required

• Type: java.lang.String

value^Required

• 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"
       ...
     },
   ]
   ...
}

path^Required

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

value^Required

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

propertyPath^Required

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

propertyPath^Required

• Type: java.lang.String

The path of the property.

value^Required

• Type: java.lang.Object

The value.

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

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

policy^Optional

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

options^Optional

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

fetchCondition

public RosCondition fetchCondition()

fetchDesc

public java.lang.String fetchDesc()

fetchRosDependency

public java.util.List<java.lang.String> fetchRosDependency()

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.

attributeName^Required

• Type: java.lang.String

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.clickhouse.RosEnterpriseDBCluster;
RosEnterpriseDBCluster.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.

x^Required

• Type: java.lang.Object

isRosResource

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

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

creationStack^Required

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

• Type: java.util.List

logicalId^Required

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

stack^Required

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

ref^Required

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

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

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

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

attrDbInstanceId^Required

public IResolvable getAttrDbInstanceId();

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

attrPrivateConnectionString^Required

public IResolvable getAttrPrivateConnectionString();

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

attrPublicConnectionString^Required

public IResolvable getAttrPublicConnectionString();

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

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

engine^Required

public java.lang.Object getEngine();

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

nodeCount^Required

public java.lang.Object getNodeCount();

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

nodeScaleMax^Required

public java.lang.Object getNodeScaleMax();

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

nodeScaleMin^Required

public java.lang.Object getNodeScaleMin();

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

vpcId^Required

public java.lang.Object getVpcId();

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

vSwitchId^Required

public java.lang.Object getVSwitchId();

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

zoneId^Required

public java.lang.Object getZoneId();

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

backupSetId^Optional

public java.lang.Object getBackupSetId();

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

dbInstanceDescription^Optional

public java.lang.Object getDbInstanceDescription();

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

dbTimeZone^Optional

public java.lang.Object getDbTimeZone();

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

deploySchema^Optional

public java.lang.Object getDeploySchema();

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

multiZone^Optional

public java.lang.Object getMultiZone();

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

publicConnectionSetting^Optional

public java.lang.Object getPublicConnectionSetting();

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

resourceGroupId^Optional

public java.lang.Object getResourceGroupId();

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

sourceDbInstanceId^Optional

public java.lang.Object getSourceDbInstanceId();

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

storageQuota^Optional

public java.lang.Object getStorageQuota();

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

storageType^Optional

public java.lang.Object getStorageType();

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

tags^Optional

public java.util.List<TagsProperty> getTags();

• Type: java.util.List<TagsProperty>

Constants

ROS_RESOURCE_TYPE_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.