Skip to content

ClusterV2

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 ros_cdk_ehpc
ros_cdk_ehpc.ClusterV2(
  scope: Construct,
  id: str,
  cluster_name: typing.Union[str, IResolvable],
  shared_storages: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SharedStoragesProperty]]],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  additional_packages: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalPackagesProperty]]] = None,
  addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
  client_version: typing.Union[str, IResolvable] = None,
  cluster_category: typing.Union[str, IResolvable] = None,
  cluster_credentials: typing.Union[IResolvable, ClusterCredentialsProperty] = None,
  cluster_custom_configuration: typing.Union[IResolvable, ClusterCustomConfigurationProperty] = None,
  cluster_description: typing.Union[str, IResolvable] = None,
  cluster_mode: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  is_enterprise_security_group: typing.Union[bool, IResolvable] = None,
  manager: typing.Union[IResolvable, ManagerProperty] = None,
  max_core_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  queues: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, QueuesProperty]]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_name typing.Union[str, ros_cdk_core.IResolvable] Property clusterName: Cluster name.
shared_storages typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SharedStoragesProperty]]] Property sharedStorages: The list of shared storage configurations.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC used by the cluster.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch used by the cluster.
additional_packages typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AdditionalPackagesProperty]]] Property additionalPackages: A list of software to install on the cluster.
addons typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]] Property addons: Cluster custom service component configuration to support only one component.
client_version typing.Union[str, ros_cdk_core.IResolvable] Property clientVersion: Cluster client version.
cluster_category typing.Union[str, ros_cdk_core.IResolvable] Property clusterCategory: Cluster series.
cluster_credentials typing.Union[ros_cdk_core.IResolvable, ClusterCredentialsProperty] Property clusterCredentials: Security credentials for the cluster.
cluster_custom_configuration typing.Union[ros_cdk_core.IResolvable, ClusterCustomConfigurationProperty] Property clusterCustomConfiguration: Cluster post-processing scripts.
cluster_description typing.Union[str, ros_cdk_core.IResolvable] Property clusterDescription: Cluster description.
cluster_mode typing.Union[str, ros_cdk_core.IResolvable] Property clusterMode: Cluster deployment type.
deletion_protection typing.Union[bool, 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.
is_enterprise_security_group typing.Union[bool, ros_cdk_core.IResolvable] Property isEnterpriseSecurityGroup: Whether to create an enterprise security group.
manager typing.Union[ros_cdk_core.IResolvable, ManagerProperty] Property manager: The cluster manages node configuration.
max_core_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxCoreCount: Total number of cores that the cluster can manage on compute nodes, ranging from 0 to 100,000.
max_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxCount: Number of compute nodes that can be managed by the cluster, ranging from 0 to 5,000.
queues typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, QueuesProperty]]] Property queues: Cluster queue configuration.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Specifies the security group ID to which the newly created cluster belongs.
tags typing.List[TagsProperty] Property tags: Tags to attach to cluster_v2.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_nameRequired

  • Type: typing.Union[str, 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 (_).


shared_storagesRequired

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SharedStoragesProperty]]]

Property sharedStorages: The list of shared storage configurations.


vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


v_switch_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


additional_packagesOptional

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

Range from 0 to 10.


addonsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]

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


client_versionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clientVersion: Cluster client version.

By default, the latest version is used.


cluster_categoryOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterCategory: Cluster series.

Valid values:

  • Standard: The standard version.
  • Serverless: Hosted version

cluster_credentialsOptional

Property clusterCredentials: Security credentials for the cluster.


cluster_custom_configurationOptional

Property clusterCustomConfiguration: Cluster post-processing scripts.


cluster_descriptionOptional

  • Type: typing.Union[str, 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 (_).


cluster_modeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterMode: Cluster deployment type.

Valid values:

  • Integrated: Public cloud clustering.
  • Hybrid: Hybrid cloud cluster.
  • Custom: The cluster is customized

deletion_protectionOptional

  • Type: typing.Union[bool, 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

is_enterprise_security_groupOptional

  • Type: typing.Union[bool, 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

Property manager: The cluster manages node configuration.


max_core_countOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maxCoreCount: Total number of cores that the cluster can manage on compute nodes, ranging from 0 to 100,000.


max_countOptional

  • Type: typing.Union[typing.Union[int, float], 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: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, QueuesProperty]]]

Property queues: Cluster queue configuration.

The number of queues is supported from 0 to 8.


resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.


security_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityGroupId: Specifies the security group ID to which the newly created cluster belongs.


tagsOptional

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.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_ehpc
ros_cdk_ehpc.ClusterV2.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterId: Cluster Id.
props ClusterV2Props No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: 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

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cluster_idRequired

attr_cluster_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ClusterId: Cluster Id.


propsRequired

props: ClusterV2Props