ClusterV2
- Implements: IClusterV2
This class encapsulates and extends the ROS resource type ALIYUN::EHPC::ClusterV2, which is used to create a cluster in Elastic High Performance Computing (E-HPC) of the new version.
Initializers
import com.aliyun.ros.cdk.ehpc.ClusterV2;
ClusterV2.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.clusterName(java.lang.String)
.clusterName(IResolvable)
.sharedStorages(IResolvable)
.sharedStorages(java.util.List<IResolvable)
.sharedStorages(SharedStoragesProperty>)
.vpcId(java.lang.String)
.vpcId(IResolvable)
.vSwitchId(java.lang.String)
.vSwitchId(IResolvable)
// .additionalPackages(IResolvable)
// .additionalPackages(java.util.List<IResolvable)
// .additionalPackages(AdditionalPackagesProperty>)
// .addons(IResolvable)
// .addons(java.util.List<IResolvable)
// .addons(AddonsProperty>)
// .clientVersion(java.lang.String)
// .clientVersion(IResolvable)
// .clusterCategory(java.lang.String)
// .clusterCategory(IResolvable)
// .clusterCredentials(IResolvable)
// .clusterCredentials(ClusterCredentialsProperty)
// .clusterCustomConfiguration(IResolvable)
// .clusterCustomConfiguration(ClusterCustomConfigurationProperty)
// .clusterDescription(java.lang.String)
// .clusterDescription(IResolvable)
// .clusterMode(java.lang.String)
// .clusterMode(IResolvable)
// .deletionProtection(java.lang.Boolean)
// .deletionProtection(IResolvable)
// .isEnterpriseSecurityGroup(java.lang.Boolean)
// .isEnterpriseSecurityGroup(IResolvable)
// .manager(IResolvable)
// .manager(ManagerProperty)
// .maxCoreCount(java.lang.Number)
// .maxCoreCount(IResolvable)
// .maxCount(java.lang.Number)
// .maxCount(IResolvable)
// .queues(IResolvable)
// .queues(java.util.List<IResolvable)
// .queues(QueuesProperty>)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .securityGroupId(java.lang.String)
// .securityGroupId(IResolvable)
// .tags(java.util.List<TagsProperty>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
clusterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterName: The cluster name. |
sharedStorages | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property sharedStorages: The list of shared storage configurations. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the VPC used by the cluster. |
vSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vSwitchId: The ID of the VSwitch used by the cluster. |
additionalPackages | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property additionalPackages: A list of software to install on the cluster. |
addons | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property addons: Cluster custom service component configuration to support only one component. |
clientVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clientVersion: Cluster client version. |
clusterCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterCategory: Cluster series. |
clusterCredentials | com.aliyun.ros.cdk.core.IResolvable OR ClusterCredentialsProperty | Property clusterCredentials: Security credentials for the cluster. |
clusterCustomConfiguration | com.aliyun.ros.cdk.core.IResolvable OR ClusterCustomConfigurationProperty | Property clusterCustomConfiguration: Cluster post-processing scripts. |
clusterDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterDescription: The cluster description. |
clusterMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterMode: Cluster deployment type. |
deletionProtection | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property deletionProtection: The cluster deletion protection property, which specifies whether cluster deletion via the console or the DeleteCluster API is supported. |
isEnterpriseSecurityGroup | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property isEnterpriseSecurityGroup: Whether to create an enterprise security group. |
manager | com.aliyun.ros.cdk.core.IResolvable OR ManagerProperty | Property manager: The cluster manages node configuration. |
maxCoreCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property maxCoreCount: Total number of cores that the cluster can manage on compute nodes, ranging from 0 to 100,000. |
maxCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property maxCount: Number of compute nodes that can be managed by the cluster, ranging from 0 to 5,000. |
queues | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property queues: Cluster queue configuration. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
securityGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityGroupId: Specifies the security group ID to which the newly created cluster belongs. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to cluster_v2. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
clusterNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterName: The cluster name.
The name must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (_).
sharedStoragesRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
SharedStoragesProperty>
Property sharedStorages: The list of shared storage configurations.
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the VPC used by the cluster.
vSwitchIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The ID of the VSwitch used by the cluster.
additionalPackagesOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
AdditionalPackagesProperty>
Property additionalPackages: A list of software to install on the cluster.
Range from 0 to 10.
addonsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
AddonsProperty>
Property addons: Cluster custom service component configuration to support only one component.
clientVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clientVersion: Cluster client version.
By default, the latest version is used.
clusterCategoryOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterCategory: Cluster series.
Valid values:
- Standard: The standard version.
- Serverless: Hosted version
clusterCredentialsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR ClusterCredentialsProperty
Property clusterCredentials: Security credentials for the cluster.
clusterCustomConfigurationOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR ClusterCustomConfigurationProperty
Property clusterCustomConfiguration: Cluster post-processing scripts.
clusterDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterDescription: The cluster description.
The description must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (_).
clusterModeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterMode: Cluster deployment type.
Valid values:
- Integrated: Public cloud clustering.
- Hybrid: Hybrid cloud cluster.
- Custom: The cluster is customized
deletionProtectionOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property deletionProtection: The cluster deletion protection property, which specifies whether cluster deletion via the console or the DeleteCluster API is supported.
- true: Cluster deletion protection is enabled.
- false: This turns off cluster deletion protection. Default value: false
isEnterpriseSecurityGroupOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property isEnterpriseSecurityGroup: Whether to create an enterprise security group.
Valid values:
- true: Enterprise security groups are automatically created and used.
- false: Normal security groups are automatically created and used instead of enterprise security groups.
managerOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR ManagerProperty
Property manager: The cluster manages node configuration.
maxCoreCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxCoreCount: Total number of cores that the cluster can manage on compute nodes, ranging from 0 to 100,000.
maxCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxCount: Number of compute nodes that can be managed by the cluster, ranging from 0 to 5,000.
queuesOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
QueuesProperty>
Property queues: Cluster queue configuration.
The number of queues is supported from 0 to 8.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
securityGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupId: Specifies the security group ID to which the newly created cluster belongs.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags to attach to cluster_v2.
Max support 20 tags to add during create cluster_v2. Each tag with two properties Key and Value, and Key is required.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.ehpc.ClusterV2;
ClusterV2.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterId: Cluster Id. |
props | ClusterV2Props | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrClusterIdRequired
public java.lang.Object getAttrClusterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterId: Cluster Id.
propsRequired
public ClusterV2Props getProps();
- Type: ClusterV2Props