RosCluster

This class is a base encapsulation around the ROS resource type ALIYUN::EHPC::Cluster, which is used to create an Elastic High Performance Computing (E-HPC) cluster.

Initializers

import { RosCluster } from '@alicloud/ros-cdk-ehpc'
new RosCluster(scope: Construct, id: string, props: RosClusterProps, 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	RosClusterProps	- resource properties.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

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

scope in which this resource is defined.

---

id^Required

• Type: string

scoped id of the resource.

---

props^Required

• Type: RosClusterProps

resource properties.

---

enableResourcePropertyConstraint^Required

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

session^Required

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

addCondition

public addCondition(con: RosCondition): void

con^Required

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

---

addCount

public addCount(count: number | IResolvable): void

count^Required

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

---

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

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

target^Required

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

---

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

---

addMetaData

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

key^Required

• Type: string

---

value^Required

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

path^Required

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

---

value^Required

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

propertyPath^Required

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

propertyPath^Required

• Type: string

The path of the property.

---

value^Required

• Type: any

The value.

---

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

---

applyRemovalPolicy

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

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

policy^Optional

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

---

options^Optional

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

attributeName^Required

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

Return whether the given object is a Construct.

x^Required

• Type: any

---

isRosElement

import { RosCluster } from '@alicloud/ros-cdk-ehpc'
RosCluster.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.

x^Required

• Type: any

---

isRosResource

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

Check whether the given construct is a RosResource.

construct^Required

• 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.
attrClusterId	@alicloud/ros-cdk-core.IResolvable	No description.
attrEcsInfo	@alicloud/ros-cdk-core.IResolvable	No description.
attrName	@alicloud/ros-cdk-core.IResolvable	No description.
attrSecurityGroupId	@alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderComputeCount	number | @alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderComputeInstanceType	string | @alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderLoginCount	number | @alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderLoginInstanceType	string | @alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderManagerInstanceType	string | @alicloud/ros-cdk-core.IResolvable	No description.
enableResourcePropertyConstraint	boolean	No description.
name	string | @alicloud/ros-cdk-core.IResolvable	No description.
osTag	string | @alicloud/ros-cdk-core.IResolvable	No description.
vSwitchId	string | @alicloud/ros-cdk-core.IResolvable	No description.
accountType	string | @alicloud/ros-cdk-core.IResolvable	No description.
additionalVolumes	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AdditionalVolumesProperty[]	No description.
application	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ApplicationProperty[]	No description.
autoRenew	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
autoRenewPeriod	number | @alicloud/ros-cdk-core.IResolvable	No description.
clientVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
computeEnableHt	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
computeSpotPriceLimit	string | @alicloud/ros-cdk-core.IResolvable	No description.
computeSpotStrategy	string | @alicloud/ros-cdk-core.IResolvable	No description.
deployMode	string | @alicloud/ros-cdk-core.IResolvable	No description.
description	string | @alicloud/ros-cdk-core.IResolvable	No description.
ecsChargeType	string | @alicloud/ros-cdk-core.IResolvable	No description.
ecsOrderManagerCount	number | @alicloud/ros-cdk-core.IResolvable	No description.
ehpcVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
haEnable	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
imageId	string | @alicloud/ros-cdk-core.IResolvable	No description.
imageOwnerAlias	string | @alicloud/ros-cdk-core.IResolvable	No description.
inputFileUrl	string | @alicloud/ros-cdk-core.IResolvable	No description.
isComputeEss	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
jobQueue	string | @alicloud/ros-cdk-core.IResolvable	No description.
keyPairName	string | @alicloud/ros-cdk-core.IResolvable	No description.
networkInterfaceTrafficMode	string | @alicloud/ros-cdk-core.IResolvable	No description.
password	string | @alicloud/ros-cdk-core.IResolvable	No description.
period	number | @alicloud/ros-cdk-core.IResolvable	No description.
periodUnit	string | @alicloud/ros-cdk-core.IResolvable	No description.
postInstallScript	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PostInstallScriptProperty[]	No description.
ramNodeTypes	@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]	No description.
ramRoleName	string | @alicloud/ros-cdk-core.IResolvable	No description.
remoteDirectory	string | @alicloud/ros-cdk-core.IResolvable	No description.
remoteVisEnable	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
resourceGroupId	string | @alicloud/ros-cdk-core.IResolvable	No description.
sccClusterId	string | @alicloud/ros-cdk-core.IResolvable	No description.
schedulerType	string | @alicloud/ros-cdk-core.IResolvable	No description.
securityGroupId	string | @alicloud/ros-cdk-core.IResolvable	No description.
securityGroupName	string | @alicloud/ros-cdk-core.IResolvable	No description.
systemDiskLevel	string | @alicloud/ros-cdk-core.IResolvable	No description.
systemDiskSize	number | @alicloud/ros-cdk-core.IResolvable	No description.
systemDiskType	string | @alicloud/ros-cdk-core.IResolvable	No description.
volumeId	string | @alicloud/ros-cdk-core.IResolvable	No description.
volumeMountpoint	string | @alicloud/ros-cdk-core.IResolvable	No description.
volumeProtocol	string | @alicloud/ros-cdk-core.IResolvable	No description.
volumeType	string | @alicloud/ros-cdk-core.IResolvable	No description.
vpcId	string | @alicloud/ros-cdk-core.IResolvable	No description.
withoutElasticIp	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
zoneId	string | @alicloud/ros-cdk-core.IResolvable	No description.

---

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

---

logicalId^Required

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

---

stack^Required

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

---

ref^Required

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

---

rosOptions^Required

public readonly rosOptions: IRosResourceOptions;

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

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

---

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

---

attrClusterId^Required

public readonly attrClusterId: IResolvable;

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

---

attrEcsInfo^Required

public readonly attrEcsInfo: IResolvable;

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

---

attrName^Required

public readonly attrName: IResolvable;

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

---

attrSecurityGroupId^Required

public readonly attrSecurityGroupId: IResolvable;

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

---

ecsOrderComputeCount^Required

public readonly ecsOrderComputeCount: number | IResolvable;

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

---

ecsOrderComputeInstanceType^Required

public readonly ecsOrderComputeInstanceType: string | IResolvable;

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

---

ecsOrderLoginCount^Required

public readonly ecsOrderLoginCount: number | IResolvable;

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

---

ecsOrderLoginInstanceType^Required

public readonly ecsOrderLoginInstanceType: string | IResolvable;

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

---

ecsOrderManagerInstanceType^Required

public readonly ecsOrderManagerInstanceType: string | IResolvable;

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

---

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

---

name^Required

public readonly name: string | IResolvable;

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

---

osTag^Required

public readonly osTag: string | IResolvable;

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

---

vSwitchId^Required

public readonly vSwitchId: string | IResolvable;

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

---

accountType^Optional

public readonly accountType: string | IResolvable;

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

---

additionalVolumes^Optional

public readonly additionalVolumes: IResolvable | IResolvable | AdditionalVolumesProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AdditionalVolumesProperty[]

---

application^Optional

public readonly application: IResolvable | IResolvable | ApplicationProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ApplicationProperty[]

---

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

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

---

autoRenewPeriod^Optional

public readonly autoRenewPeriod: number | IResolvable;

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

---

clientVersion^Optional

public readonly clientVersion: string | IResolvable;

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

---

computeEnableHt^Optional

public readonly computeEnableHt: boolean | IResolvable;

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

---

computeSpotPriceLimit^Optional

public readonly computeSpotPriceLimit: string | IResolvable;

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

---

computeSpotStrategy^Optional

public readonly computeSpotStrategy: string | IResolvable;

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

---

deployMode^Optional

public readonly deployMode: string | IResolvable;

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

---

description^Optional

public readonly description: string | IResolvable;

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

---

ecsChargeType^Optional

public readonly ecsChargeType: string | IResolvable;

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

---

ecsOrderManagerCount^Optional

public readonly ecsOrderManagerCount: number | IResolvable;

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

---

ehpcVersion^Optional

public readonly ehpcVersion: string | IResolvable;

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

---

haEnable^Optional

public readonly haEnable: boolean | IResolvable;

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

---

imageId^Optional

public readonly imageId: string | IResolvable;

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

---

imageOwnerAlias^Optional

public readonly imageOwnerAlias: string | IResolvable;

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

---

inputFileUrl^Optional

public readonly inputFileUrl: string | IResolvable;

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

---

isComputeEss^Optional

public readonly isComputeEss: boolean | IResolvable;

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

---

jobQueue^Optional

public readonly jobQueue: string | IResolvable;

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

---

keyPairName^Optional

public readonly keyPairName: string | IResolvable;

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

---

networkInterfaceTrafficMode^Optional

public readonly networkInterfaceTrafficMode: string | IResolvable;

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

---

password^Optional

public readonly password: string | IResolvable;

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

---

period^Optional

public readonly period: number | IResolvable;

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

---

periodUnit^Optional

public readonly periodUnit: string | IResolvable;

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

---

postInstallScript^Optional

public readonly postInstallScript: IResolvable | IResolvable | PostInstallScriptProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PostInstallScriptProperty[]

---

ramNodeTypes^Optional

public readonly ramNodeTypes: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

---

ramRoleName^Optional

public readonly ramRoleName: string | IResolvable;

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

---

remoteDirectory^Optional

public readonly remoteDirectory: string | IResolvable;

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

---

remoteVisEnable^Optional

public readonly remoteVisEnable: boolean | IResolvable;

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

---

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

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

---

sccClusterId^Optional

public readonly sccClusterId: string | IResolvable;

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

---

schedulerType^Optional

public readonly schedulerType: string | IResolvable;

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

---

securityGroupId^Optional

public readonly securityGroupId: string | IResolvable;

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

---

securityGroupName^Optional

public readonly securityGroupName: string | IResolvable;

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

---

systemDiskLevel^Optional

public readonly systemDiskLevel: string | IResolvable;

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

---

systemDiskSize^Optional

public readonly systemDiskSize: number | IResolvable;

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

---

systemDiskType^Optional

public readonly systemDiskType: string | IResolvable;

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

---

volumeId^Optional

public readonly volumeId: string | IResolvable;

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

---

volumeMountpoint^Optional

public readonly volumeMountpoint: string | IResolvable;

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

---

volumeProtocol^Optional

public readonly volumeProtocol: string | IResolvable;

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

---

volumeType^Optional

public readonly volumeType: string | IResolvable;

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

---

vpcId^Optional

public readonly vpcId: string | IResolvable;

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

---

withoutElasticIp^Optional

public readonly withoutElasticIp: boolean | IResolvable;

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

---

zoneId^Optional

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_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.

---