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 { RosDBCluster } from '@alicloud/ros-cdk-clickhouse'
new RosDBCluster(scope: Construct, id: string, props: RosDBClusterProps, enableResourcePropertyConstraint: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct - scope in which this resource is defined.
id string - scoped id of the resource.
props RosDBClusterProps - resource properties.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

scope in which this resource is defined.

idRequired

  • Type: string

scoped id of the resource.

propsRequired

resource properties.

enableResourcePropertyConstraintRequired

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

overrideLogicalId 

public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.

addCondition 

public addCondition(con: RosCondition): void

conRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDeletionOverride 

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: string

The path of the value to delete.

addDependsOn 

public addDependsOn(target: RosResource): void

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: @alicloud/ros-cdk-core.RosResource

addDesc 

public addDesc(desc: string): void

descRequired

  • Type: string

addMetaData 

public addMetaData(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

addOverride 

public addOverride(path: string, value: any): void

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: 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: any

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public addPropertyDeletionOverride(propertyPath: string): void

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

propertyPathRequired

  • Type: string

The path to the property.

addPropertyOverride 

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

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

propertyPathRequired

  • Type: string

The path of the property.

valueRequired

  • Type: any

The value.

addRosDependency 

public addRosDependency(target: string): void

targetRequired

  • Type: string

applyRemovalPolicy 

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

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

policyOptional

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

optionsOptional

  • Type: @alicloud/ros-cdk-core.RemovalPolicyOptions

getAtt 

public getAtt(attributeName: string): Reference

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: 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 { RosDBCluster } from '@alicloud/ros-cdk-clickhouse'
RosDBCluster.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

isRosElement 

import { RosDBCluster } from '@alicloud/ros-cdk-clickhouse'
RosDBCluster.isRosElement(x: any)

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: any

isRosResource 

import { RosDBCluster } from '@alicloud/ros-cdk-clickhouse'
RosDBCluster.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

constructRequired

  • Type: @alicloud/ros-cdk-core.IConstruct

Properties

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

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

creationStackRequired 

public readonly creationStack: string[];
  • Type: string[]

logicalIdRequired 

public readonly logicalId: string;
  • Type: 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 readonly stack: Stack;
  • Type: @alicloud/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 readonly ref: string;
  • Type: 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 readonly rosOptions: IRosResourceOptions;
  • Type: @alicloud/ros-cdk-core.IRosResourceOptions

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

rosResourceTypeRequired 

public readonly rosResourceType: string;
  • Type: string

ROS resource type.

attrAliUidRequired 

public readonly attrAliUid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrBidRequired 

public readonly attrBid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrCategoryRequired 

public readonly attrCategory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrCommodityCodeRequired 

public readonly attrCommodityCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrConnectionStringRequired 

public readonly attrConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbClusterDescriptionRequired 

public readonly attrDbClusterDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbClusterIdRequired 

public readonly attrDbClusterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbClusterNetworkTypeRequired 

public readonly attrDbClusterNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbClusterTypeRequired 

public readonly attrDbClusterType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbClusterVersionRequired 

public readonly attrDbClusterVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbNodeClassRequired 

public readonly attrDbNodeClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbNodeCountRequired 

public readonly attrDbNodeCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbNodeStorageRequired 

public readonly attrDbNodeStorage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrDbNodeStorageTypeRequired 

public readonly attrDbNodeStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrEncryptionKeyRequired 

public readonly attrEncryptionKey: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrEncryptionTypeRequired 

public readonly attrEncryptionType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrEngineRequired 

public readonly attrEngine: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrEngineVersionRequired 

public readonly attrEngineVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrIsExpiredRequired 

public readonly attrIsExpired: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrLockModeRequired 

public readonly attrLockMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrLockReasonRequired 

public readonly attrLockReason: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrPeriodRequired 

public readonly attrPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrPortRequired 

public readonly attrPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrPublicConnectionStringRequired 

public readonly attrPublicConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrPublicPortRequired 

public readonly attrPublicPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrStorageTypeRequired 

public readonly attrStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrVpcCloudInstanceIdRequired 

public readonly attrVpcCloudInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

categoryRequired 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dbClusterNetworkTypeRequired 

public readonly dbClusterNetworkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dbClusterTypeRequired 

public readonly dbClusterType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dbClusterVersionRequired 

public readonly dbClusterVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dbNodeCountRequired 

public readonly dbNodeCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

dbNodeStorageRequired 

public readonly dbNodeStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

dbNodeStorageTypeRequired 

public readonly dbNodeStorageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

enableResourcePropertyConstraintRequired 

public readonly enableResourcePropertyConstraint: boolean;
  • Type: boolean

paymentTypeRequired 

public readonly paymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dbClusterDescriptionOptional 

public readonly dbClusterDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

encryptionKeyOptional 

public readonly encryptionKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

encryptionTypeOptional 

public readonly encryptionType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

periodOptional 

public readonly period: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

usedTimeOptional 

public readonly usedTime: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME string The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public readonly ROS_RESOURCE_TYPE_NAME: string;
  • Type: string

The resource type name for this resource class.