Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::EHPC::Cluster.

Initializers

import com.aliyun.ros.cdk.ehpc.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ecsOrderComputeCount(java.lang.Number)
    .ecsOrderComputeCount(IResolvable)
    .ecsOrderComputeInstanceType(java.lang.String)
    .ecsOrderComputeInstanceType(IResolvable)
    .ecsOrderLoginCount(java.lang.Number)
    .ecsOrderLoginCount(IResolvable)
    .ecsOrderLoginInstanceType(java.lang.String)
    .ecsOrderLoginInstanceType(IResolvable)
    .ecsOrderManagerInstanceType(java.lang.String)
    .ecsOrderManagerInstanceType(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .accountType(java.lang.String)
//  .accountType(IResolvable)
//  .additionalVolumes(IResolvable)
//  .additionalVolumes(java.util.List<IResolvable)
//  .additionalVolumes(AdditionalVolumesProperty>)
//  .application(IResolvable)
//  .application(java.util.List<IResolvable)
//  .application(ApplicationProperty>)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .clientVersion(java.lang.String)
//  .clientVersion(IResolvable)
//  .computeEnableHt(java.lang.Boolean)
//  .computeEnableHt(IResolvable)
//  .computeSpotPriceLimit(java.lang.String)
//  .computeSpotPriceLimit(IResolvable)
//  .computeSpotStrategy(java.lang.String)
//  .computeSpotStrategy(IResolvable)
//  .deployMode(java.lang.String)
//  .deployMode(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .ecsChargeType(java.lang.String)
//  .ecsChargeType(IResolvable)
//  .ecsOrderManagerCount(java.lang.Number)
//  .ecsOrderManagerCount(IResolvable)
//  .ehpcVersion(java.lang.String)
//  .ehpcVersion(IResolvable)
//  .haEnable(java.lang.Boolean)
//  .haEnable(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .imageOwnerAlias(java.lang.String)
//  .imageOwnerAlias(IResolvable)
//  .inputFileUrl(java.lang.String)
//  .inputFileUrl(IResolvable)
//  .isComputeEss(java.lang.Boolean)
//  .isComputeEss(IResolvable)
//  .jobQueue(java.lang.String)
//  .jobQueue(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .networkInterfaceTrafficMode(java.lang.String)
//  .networkInterfaceTrafficMode(IResolvable)
//  .osTag(java.lang.String)
//  .osTag(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .postInstallScript(IResolvable)
//  .postInstallScript(java.util.List<IResolvable)
//  .postInstallScript(PostInstallScriptProperty>)
//  .ramNodeTypes(IResolvable)
//  .ramNodeTypes(java.util.List<java.lang.String)
//  .ramNodeTypes(IResolvable>)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .remoteDirectory(java.lang.String)
//  .remoteDirectory(IResolvable)
//  .remoteVisEnable(java.lang.Boolean)
//  .remoteVisEnable(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .sccClusterId(java.lang.String)
//  .sccClusterId(IResolvable)
//  .schedulerType(java.lang.String)
//  .schedulerType(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupName(java.lang.String)
//  .securityGroupName(IResolvable)
//  .systemDiskLevel(java.lang.String)
//  .systemDiskLevel(IResolvable)
//  .systemDiskSize(java.lang.Number)
//  .systemDiskSize(IResolvable)
//  .systemDiskType(java.lang.String)
//  .systemDiskType(IResolvable)
//  .volumeId(java.lang.String)
//  .volumeId(IResolvable)
//  .volumeMountpoint(java.lang.String)
//  .volumeMountpoint(IResolvable)
//  .volumeProtocol(java.lang.String)
//  .volumeProtocol(IResolvable)
//  .volumeType(java.lang.String)
//  .volumeType(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .withoutElasticIp(java.lang.Boolean)
//  .withoutElasticIp(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

ecsOrderComputeCount^Required

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

Property ecsOrderComputeCount: Computing node number, which ranges from: 0-99.

ecsOrderComputeInstanceType^Required

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

Property ecsOrderComputeInstanceType: Cluster computing node instance specifications.

ecsOrderLoginCount^Required

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

Property ecsOrderLoginCount: Login node number can only be 1.

ecsOrderLoginInstanceType^Required

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

Property ecsOrderLoginInstanceType: Log cluster node instance specifications.

ecsOrderManagerInstanceType^Required

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

Property ecsOrderManagerInstanceType: Cluster control node instance specifications.

name^Required

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

Property name: Cluster name.

2-64 characters in length, allowing only include Chinese, letters, numbers, dashes (-) and underscore (_), must begin with a letter or Chinese.

vSwitchId^Required

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

Property vSwitchId: VPC in switch ID.

Products currently only supports VPC network.

accountType^Optional

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

Property accountType: The service type of the domain account.

Valid values: nis ldap Default value: nis

additionalVolumes^Optional

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

Property additionalVolumes: The information of the NAS file system.

application^Optional

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

Property application: Application software tag (SoftwareTag) list, You can call ListSoftwares API to query.

autoRenew^Optional

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

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values:

• true
• false Default value: false.

autoRenewPeriod^Optional

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

Property autoRenewPeriod: The auto-renewal period of the subscription compute nodes.

The parameter takes effect when AutoRenew is set to true.

clientVersion^Optional

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

Property clientVersion: The version of the E-HPC client.

By default, the parameter is set to the latest version number. You can call the ListCurrentClientVersion operation to query the current version of the E-HPC client.

computeEnableHt^Optional

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

Property computeEnableHt: Specifies whether the compute nodes support hyper-threading.

Valid values: true: Hyper-threading is supported. false: Hyper-threading is not supported. Default value: true

computeSpotPriceLimit^Optional

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

Property computeSpotPriceLimit: The maximum hourly price of the compute nodes.

A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.

computeSpotStrategy^Optional

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

Property computeSpotStrategy: The bidding method of the compute nodes.

Valid values:

• NoSpot: The compute nodes are pay-as-you-go instances.
• SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.
• SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price. Default value: NoSpot.

deployMode^Optional

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

Property deployMode: The mode in which the cluster is deployed.

Valid values: Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed. Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed. Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed. Default value: Standard

description^Optional

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

Property description: The description of the E-HPC cluster.

The description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

ecsChargeType^Optional

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

Property ecsChargeType: ECS instance payment type, PostPaid: Pay-As-You-Go.PrePaid: Subscription.If you choose PrePaid, automatic renewal will be enabled by default, and closed when node is released.

ecsOrderManagerCount^Optional

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

Property ecsOrderManagerCount: Control node number can be 1, 2.

ehpcVersion^Optional

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

Property ehpcVersion: The version of E-HPC.

By default, the parameter is set to the latest version number.

haEnable^Optional

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

Property haEnable: Specifies whether to enable the high availability feature.

Valid values: true: enables the high availability feature false: disables the high availability feature Default value: false Note If high availability is enabled, primary management nodes and secondary management nodes are used.

imageId^Optional

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

Property imageId: The image IDs.

You can call the ListImages and ListCustomImages operations to query the images that are supported by E-HPC.

imageOwnerAlias^Optional

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

Property imageOwnerAlias: Mirror type: system, self, others or marketplace.

inputFileUrl^Optional

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

Property inputFileUrl: The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.

isComputeEss^Optional

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

Property isComputeEss: Specifies whether to enable auto scaling.

Valid values: true: enables auto scaling false: disables auto scaling Default value: false

jobQueue^Optional

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

Property jobQueue: The queue to which the compute nodes are added.

keyPairName^Optional

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

Property keyPairName: Key pair name.

networkInterfaceTrafficMode^Optional

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

Property networkInterfaceTrafficMode: Communication mode of an elastic NIC.

Value values:

• Standard: The TCP communication mode is used.
• HighPerformance: Enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.

osTag^Optional

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

Property osTag: Operating system image tag.

You can call ListImages API to query.

password^Optional

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

Property password: The root password of the logon node.

The password must be 8 to 30 characters in length and contain at least three of the following items: uppercase letters, lowercase letters, digits, and special characters. Special characters include: ( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? \/ You must specify either Password or KeyPairName. If both are specified, the Password parameter prevails.

We recommend that you use HTTPS to call the API operation to prevent password leakage.

period^Optional

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

Property period: The duration of the subscription.

The unit of the duration is specified by the PeriodUnit parameter.

• Valid values if PriceUnit is set to Year: 1, 2, and 3.
• Valid values if PriceUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
• Valid value if PriceUnit is set to Hour: 1. Default value: 1.

periodUnit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values:

• Year
• Month
• Hour Default value: Month.

postInstallScript^Optional

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

Property postInstallScript: The information of the post-installation script.

ramNodeTypes^Optional

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

Property ramNodeTypes: When authorizing instance configuration, the node type to which the RAM role is bound.

When the value of DeployMode is Standard, the value range: scheduler, account, login, compute. When the value of DeployMode is Simple, the value range: manager, login, compute. When the value of DeployMode is Tiny, the value range: manager, compute.

ramRoleName^Optional

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

Property ramRoleName: The name of the Resource Access Management (RAM) role.

You can call the ListRoles operation provided by RAM to query the created RAM roles.

remoteDirectory^Optional

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

Property remoteDirectory: Mount shared storage remote directory.

The final path to the mount point and mount the remote directory composition: NasMountpoint: / RemoteDirectory

remoteVisEnable^Optional

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

Property remoteVisEnable: Specifies whether to enable Virtual Network Computing (VNC).

Valid values: true: enables VNC false: disables VNC Default value: false

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

You can call the ListResourceGroups operation to obtain the ID of the resource group.

sccClusterId^Optional

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

Property sccClusterId: The Super Computing Cluster (SCC) instance ID.

If you specify the parameter, the SCC instance is moved to a new SCC cluster.

schedulerType^Optional

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

Property schedulerType: The type of the scheduler.

Valid values: pbs slurm opengridscheduler deadline Default value: pbs

securityGroupId^Optional

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

Property securityGroupId: Security group ID.

securityGroupName^Optional

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

Property securityGroupName: If you do not use an existing security group, set the parameter to the name of a new security group.

A default policy is applied to the new security group.

systemDiskLevel^Optional

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

Property systemDiskLevel: The performance level of the ESSD that is created as the system disk.

Valid values: PL0: A single ESSD can deliver up to 10,000 input/output operations per second (IOPS) of random read/write. PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write. PL2: A single ESSD can deliver up to 100,000 IOPS of random read/write. PL3: A single ESSD can deliver up to 1,000,000 IOPS of random read/write. Default value: PL1

systemDiskSize^Optional

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

Property systemDiskSize: The size of the system disk.

Unit: GB Valid values: 40 to 500 Default value: 40

systemDiskType^Optional

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

Property systemDiskType: The type of the system disk.

Valid values: cloud_efficiency: ultra disk. cloud_ssd: SSD. cloud_essd: ESSD. Default value: cloud_ssd

volumeId^Optional

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

Property volumeId: The ID of the file system.

If you leave the parameter empty, a Performance NAS file system is created by default.

volumeMountpoint^Optional

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

Property volumeMountpoint: The mount target of the file system.

Take note of the following information: If you do not specify the VolumeId parameter, you can leave the VolumeMountpoint parameter empty. A mount target is created by default. If you specify the VolumeId parameter, the VolumeMountpoint parameter is required.

volumeProtocol^Optional

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

Property volumeProtocol: The type of the protocol that is used by the file system.

Valid values: nfs smb Default value: nfs

volumeType^Optional

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

Property volumeType: The type of the shared storage.

Only Apsara File Storage nas file systems are supported.

vpcId^Optional

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

Property vpcId: The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.

withoutElasticIp^Optional

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

Property withoutElasticIp: Specifies whether the logon node uses an elastic IP address (EIP).

Default value: false

zoneId^Optional

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

Property zoneId: Available area ID.

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.

addCondition

public void addCondition(RosCondition condition)

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

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

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ehpc.Cluster;
Cluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrClusterId^Required

public java.lang.Object getAttrClusterId();

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

Attribute ClusterId: Cluster Id.

attrEcsInfo^Required

public java.lang.Object getAttrEcsInfo();

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

Attribute EcsInfo: A data structure describing the number and specifications of ECS for various components of the cluster.

You will get results similar to the following: EcsInfo: {"Manager": {"Count": 2, "InstanceType": "ecs.n1.large"}, "Compute": {"Count": 8, "InstanceType": "ecs.n1.large"}, "Login": {"Count": 1, "InstanceType": "ecs.n1.large"}}

attrName^Required

public java.lang.Object getAttrName();

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

Attribute Name: Cluster name.

attrSecurityGroupId^Required

public java.lang.Object getAttrSecurityGroupId();

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

Attribute SecurityGroupId: Security group ID.

props^Required

public ClusterProps getProps();

• Type: ClusterProps