ClusterV2

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

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.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`cluster_name`^Required

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_storages`^Required

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_id`^Required

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

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

`v_switch_id`^Required

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

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

`additional_packages`^Optional

Type: 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.

Range from 0 to 10.

`addons`^Optional

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_version`^Optional

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

Property clientVersion: Cluster client version.

By default, the latest version is used.

`cluster_category`^Optional

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

Property clusterCategory: Cluster series.

Valid values:

Standard: The standard version.
Serverless: Hosted version

`cluster_credentials`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, ClusterCredentialsProperty]

Property clusterCredentials: Security credentials for the cluster.

`cluster_custom_configuration`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, ClusterCustomConfigurationProperty]

Property clusterCustomConfiguration: Cluster post-processing scripts.

`cluster_description`^Optional

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_mode`^Optional

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_protection`^Optional

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_group`^Optional

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.

`manager`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, ManagerProperty]

Property manager: The cluster manages node configuration.

`max_core_count`^Optional

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_count`^Optional

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.

`queues`^Optional

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_id`^Optional

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

Property resourceGroupId: The ID of the resource group.

`security_group_id`^Optional

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

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

`tags`^Optional

Type: typing.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.

`enable_resource_property_constraint`^Optional

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

session^Required

Type: ros_cdk_core.ISynthesisSession

The synthesis session.

`add_condition`

def add_condition(
  condition: RosCondition
) -> None

condition^Required

Type: ros_cdk_core.RosCondition

`add_count`

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

count^Required

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

`add_dependency`

def add_dependency(
  resource: Resource
) -> None

resource^Required

Type: ros_cdk_core.Resource

`add_resource_desc`

def add_resource_desc(
  desc: str
) -> None

desc^Required

Type: str

`apply_removal_policy`

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

Type: ros_cdk_core.RemovalPolicy

`get_att`

def get_att(
  name: str
) -> IResolvable

name^Required

Type: str

`set_metadata`

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

key^Required

Type: str

value^Required

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.

x^Required

Type: typing.Any

Properties

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

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

ref: str

Type: str

`stack`^Required

stack: Stack

Type: ros_cdk_core.Stack

The stack in which this resource is defined.

`resource`^Optional

resource: RosResource

Type: ros_cdk_core.RosResource

`attr_cluster_id`^Required

attr_cluster_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute ClusterId: Cluster Id.

ClusterV2

Initializers

scopeRequired

idRequired

cluster_nameRequired

shared_storagesRequired

vpc_idRequired

v_switch_idRequired

additional_packagesOptional

addonsOptional

client_versionOptional

cluster_categoryOptional

cluster_credentialsOptional

cluster_custom_configurationOptional

cluster_descriptionOptional

cluster_modeOptional

deletion_protectionOptional

is_enterprise_security_groupOptional

managerOptional

max_core_countOptional

max_countOptional

queuesOptional

resource_group_idOptional

security_group_idOptional

tagsOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata

Static Functions

is_construct

Properties

nodeRequired

refRequired

stackRequired

resourceOptional

attr_cluster_idRequired

`scope`^Required

`id`^Required

`cluster_name`^Required

`shared_storages`^Required

`vpc_id`^Required

`v_switch_id`^Required

`additional_packages`^Optional

`addons`^Optional

`client_version`^Optional

`cluster_category`^Optional

`cluster_credentials`^Optional

`cluster_custom_configuration`^Optional

`cluster_description`^Optional

`cluster_mode`^Optional

`deletion_protection`^Optional

`is_enterprise_security_group`^Optional

`manager`^Optional

`max_core_count`^Optional

`max_count`^Optional

`queues`^Optional

`resource_group_id`^Optional

`security_group_id`^Optional

`tags`^Optional

`enable_resource_property_constraint`^Optional

`to_string`

`synthesize`

`add_condition`

`add_count`

`add_dependency`

`add_resource_desc`

`apply_removal_policy`

`get_att`

`set_metadata`

`is_construct`

`node`^Required

`ref`^Required

`stack`^Required

`resource`^Optional

`attr_cluster_id`^Required