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

using AlibabaCloud.SDK.ROS.CDK.Ehpc;
new RosCluster(Construct Scope, string Id, RosClusterProps Props, bool EnableResourcePropertyConstraint);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	- scope in which this resource is defined.
Id	string	- scoped id of the resource.
Props	RosClusterProps	- resource properties.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.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: bool

---

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void AddCondition(RosCondition Con)

Con^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

---

AddDependsOn

private 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: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

---

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

AddOverride

private void AddOverride(string Path, 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: 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: object

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

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

PropertyPath^Required

• Type: string

The path to the property.

---

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

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

The value.

---

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

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

Policy^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

Options^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

---

GetAtt

private Reference GetAtt(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: 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

using AlibabaCloud.SDK.ROS.CDK.Ehpc;
RosCluster.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Ehpc;
RosCluster.IsRosElement(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: object

---

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Ehpc;
RosCluster.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.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	AlibabaCloud.SDK.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	AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	string	ROS resource type.
AttrClusterId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrEcsInfo	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSecurityGroupId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
EcsOrderComputeCount	object	No description.
EcsOrderComputeInstanceType	object	No description.
EcsOrderLoginCount	object	No description.
EcsOrderLoginInstanceType	object	No description.
EcsOrderManagerInstanceType	object	No description.
EnableResourcePropertyConstraint	bool	No description.
Name	object	No description.
OsTag	object	No description.
VSwitchId	object	No description.
AccountType	object	No description.
AdditionalVolumes	object	No description.
Application	object	No description.
AutoRenew	object	No description.
AutoRenewPeriod	object	No description.
ClientVersion	object	No description.
ComputeEnableHt	object	No description.
ComputeSpotPriceLimit	object	No description.
ComputeSpotStrategy	object	No description.
DeployMode	object	No description.
Description	object	No description.
EcsChargeType	object	No description.
EcsOrderManagerCount	object	No description.
EhpcVersion	object	No description.
HaEnable	object	No description.
ImageId	object	No description.
ImageOwnerAlias	object	No description.
InputFileUrl	object	No description.
IsComputeEss	object	No description.
JobQueue	object	No description.
KeyPairName	object	No description.
NetworkInterfaceTrafficMode	object	No description.
Password	object	No description.
Period	object	No description.
PeriodUnit	object	No description.
PostInstallScript	object	No description.
RamNodeTypes	object	No description.
RamRoleName	object	No description.
RemoteDirectory	object	No description.
RemoteVisEnable	object	No description.
ResourceGroupId	object	No description.
SccClusterId	object	No description.
SchedulerType	object	No description.
SecurityGroupId	object	No description.
SecurityGroupName	object	No description.
SystemDiskLevel	object	No description.
SystemDiskSize	object	No description.
SystemDiskType	object	No description.
VolumeId	object	No description.
VolumeMountpoint	object	No description.
VolumeProtocol	object	No description.
VolumeType	object	No description.
VpcId	object	No description.
WithoutElasticIp	object	No description.
ZoneId	object	No description.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• 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 Stack Stack { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• 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 IRosResourceOptions RosOptions { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

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

---

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

---

AttrClusterId^Required

public IResolvable AttrClusterId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrEcsInfo^Required

public IResolvable AttrEcsInfo { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrName^Required

public IResolvable AttrName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrSecurityGroupId^Required

public IResolvable AttrSecurityGroupId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

EcsOrderComputeCount^Required

public object EcsOrderComputeCount { get; }

• Type: object

---

EcsOrderComputeInstanceType^Required

public object EcsOrderComputeInstanceType { get; }

• Type: object

---

EcsOrderLoginCount^Required

public object EcsOrderLoginCount { get; }

• Type: object

---

EcsOrderLoginInstanceType^Required

public object EcsOrderLoginInstanceType { get; }

• Type: object

---

EcsOrderManagerInstanceType^Required

public object EcsOrderManagerInstanceType { get; }

• Type: object

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

Name^Required

public object Name { get; }

• Type: object

---

OsTag^Required

public object OsTag { get; }

• Type: object

---

VSwitchId^Required

public object VSwitchId { get; }

• Type: object

---

AccountType^Optional

public object AccountType { get; }

• Type: object

---

AdditionalVolumes^Optional

public object AdditionalVolumes { get; }

• Type: object

---

Application^Optional

public object Application { get; }

• Type: object

---

AutoRenew^Optional

public object AutoRenew { get; }

• Type: object

---

AutoRenewPeriod^Optional

public object AutoRenewPeriod { get; }

• Type: object

---

ClientVersion^Optional

public object ClientVersion { get; }

• Type: object

---

ComputeEnableHt^Optional

public object ComputeEnableHt { get; }

• Type: object

---

ComputeSpotPriceLimit^Optional

public object ComputeSpotPriceLimit { get; }

• Type: object

---

ComputeSpotStrategy^Optional

public object ComputeSpotStrategy { get; }

• Type: object

---

DeployMode^Optional

public object DeployMode { get; }

• Type: object

---

Description^Optional

public object Description { get; }

• Type: object

---

EcsChargeType^Optional

public object EcsChargeType { get; }

• Type: object

---

EcsOrderManagerCount^Optional

public object EcsOrderManagerCount { get; }

• Type: object

---

EhpcVersion^Optional

public object EhpcVersion { get; }

• Type: object

---

HaEnable^Optional

public object HaEnable { get; }

• Type: object

---

ImageId^Optional

public object ImageId { get; }

• Type: object

---

ImageOwnerAlias^Optional

public object ImageOwnerAlias { get; }

• Type: object

---

InputFileUrl^Optional

public object InputFileUrl { get; }

• Type: object

---

IsComputeEss^Optional

public object IsComputeEss { get; }

• Type: object

---

JobQueue^Optional

public object JobQueue { get; }

• Type: object

---

KeyPairName^Optional

public object KeyPairName { get; }

• Type: object

---

NetworkInterfaceTrafficMode^Optional

public object NetworkInterfaceTrafficMode { get; }

• Type: object

---

Password^Optional

public object Password { get; }

• Type: object

---

Period^Optional

public object Period { get; }

• Type: object

---

PeriodUnit^Optional

public object PeriodUnit { get; }

• Type: object

---

PostInstallScript^Optional

public object PostInstallScript { get; }

• Type: object

---

RamNodeTypes^Optional

public object RamNodeTypes { get; }

• Type: object

---

RamRoleName^Optional

public object RamRoleName { get; }

• Type: object

---

RemoteDirectory^Optional

public object RemoteDirectory { get; }

• Type: object

---

RemoteVisEnable^Optional

public object RemoteVisEnable { get; }

• Type: object

---

ResourceGroupId^Optional

public object ResourceGroupId { get; }

• Type: object

---

SccClusterId^Optional

public object SccClusterId { get; }

• Type: object

---

SchedulerType^Optional

public object SchedulerType { get; }

• Type: object

---

SecurityGroupId^Optional

public object SecurityGroupId { get; }

• Type: object

---

SecurityGroupName^Optional

public object SecurityGroupName { get; }

• Type: object

---

SystemDiskLevel^Optional

public object SystemDiskLevel { get; }

• Type: object

---

SystemDiskSize^Optional

public object SystemDiskSize { get; }

• Type: object

---

SystemDiskType^Optional

public object SystemDiskType { get; }

• Type: object

---

VolumeId^Optional

public object VolumeId { get; }

• Type: object

---

VolumeMountpoint^Optional

public object VolumeMountpoint { get; }

• Type: object

---

VolumeProtocol^Optional

public object VolumeProtocol { get; }

• Type: object

---

VolumeType^Optional

public object VolumeType { get; }

• Type: object

---

VpcId^Optional

public object VpcId { get; }

• Type: object

---

WithoutElasticIp^Optional

public object WithoutElasticIp { get; }

• Type: object

---

ZoneId^Optional

public object ZoneId { get; }

• Type: object

---

Constants

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

---

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.

---