ClusterV2

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

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: Cluster name.
`sharedStorages`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSharedStoragesProperty>`	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.ListAdditionalPackagesProperty>`	Property additionalPackages: A list of software to install on the cluster.
`addons`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAddonsProperty>`	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: 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.ListQueuesProperty>`	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.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`clusterName`^Required

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

Property clusterName: Cluster name.

The length is from 2 to 128 characters, and it supports English, Chinese and numbers. You can include a dash (-) and an underscore (_).

`sharedStorages`^Required

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

Property sharedStorages: The list of shared storage configurations.

`vpcId`^Required

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

Property vpcId: The ID of the VPC used by the cluster.

`vSwitchId`^Required

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

Property vSwitchId: The ID of the VSwitch used by the cluster.

`additionalPackages`^Optional

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

Property additionalPackages: A list of software to install on the cluster.

Range from 0 to 10.

`addons`^Optional

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

Property addons: Cluster custom service component configuration to support only one component.

`clientVersion`^Optional

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

Property clientVersion: Cluster client version.

By default, the latest version is used.

`clusterCategory`^Optional

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

Property clusterCategory: Cluster series.

Valid values:

Standard: The standard version.
Serverless: Hosted version

`clusterCredentials`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR ClusterCredentialsProperty

Property clusterCredentials: Security credentials for the cluster.

`clusterCustomConfiguration`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR ClusterCustomConfigurationProperty

Property clusterCustomConfiguration: Cluster post-processing scripts.

`clusterDescription`^Optional

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

Property clusterDescription: Cluster description.

The length is from 2 to 128 characters, and it supports English, Chinese and numbers. You can include a dash (-) and an underscore (_).

`clusterMode`^Optional

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

`deletionProtection`^Optional

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

`isEnterpriseSecurityGroup`^Optional

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.

`manager`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR ManagerProperty

Property manager: The cluster manages node configuration.

`maxCoreCount`^Optional

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.

`maxCount`^Optional

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.

`queues`^Optional

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

Property queues: Cluster queue configuration.

The number of queues is supported from 0 to 8.

`resourceGroupId`^Optional

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

Property resourceGroupId: The ID of the resource group.

`securityGroupId`^Optional

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.

`tags`^Optional

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

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

`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

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.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`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`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ClusterId: Cluster Id.

`node`^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

`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 IResolvable getAttrClusterId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: Cluster Id.

ClusterV2

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

clusterNameRequired

sharedStoragesRequired

vpcIdRequired

vSwitchIdRequired

additionalPackagesOptional

addonsOptional

clientVersionOptional

clusterCategoryOptional

clusterCredentialsOptional

clusterCustomConfigurationOptional

clusterDescriptionOptional

clusterModeOptional

deletionProtectionOptional

isEnterpriseSecurityGroupOptional

managerOptional

maxCoreCountOptional

maxCountOptional

queuesOptional

resourceGroupIdOptional

securityGroupIdOptional

tagsOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata

Static Functions

isConstruct

Properties

nodeRequired

refRequired

stackRequired

resourceOptional

attrClusterIdRequired

`scope`^Required

`id`^Required

`enableResourcePropertyConstraint`^Optional

`clusterName`^Required

`sharedStorages`^Required

`vpcId`^Required

`vSwitchId`^Required

`additionalPackages`^Optional

`addons`^Optional

`clientVersion`^Optional

`clusterCategory`^Optional

`clusterCredentials`^Optional

`clusterCustomConfiguration`^Optional

`clusterDescription`^Optional

`clusterMode`^Optional

`deletionProtection`^Optional

`isEnterpriseSecurityGroup`^Optional

`manager`^Optional

`maxCoreCount`^Optional

`maxCount`^Optional

`queues`^Optional

`resourceGroupId`^Optional

`securityGroupId`^Optional

`tags`^Optional

`toString`

`synthesize`

`addCondition`

`addCount`

`addDependency`

`addResourceDesc`

`applyRemovalPolicy`

`getAtt`

`setMetadata`

`isConstruct`

`node`^Required

`ref`^Required

`stack`^Required

`resource`^Optional

`attrClusterId`^Required