Skip to content

Cluster

This class encapsulates and extends the ROS resource type ALIYUN::EHPC::Cluster, which is used to create an Elastic High Performance Computing (E-HPC) cluster.

Initializers 

import ros_cdk_ehpc
ros_cdk_ehpc.Cluster(
  scope: Construct,
  id: str,
  ecs_order_compute_count: typing.Union[typing.Union[int, float], IResolvable],
  ecs_order_compute_instance_type: typing.Union[str, IResolvable],
  ecs_order_login_count: typing.Union[typing.Union[int, float], IResolvable],
  ecs_order_login_instance_type: typing.Union[str, IResolvable],
  ecs_order_manager_instance_type: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  os_tag: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  account_type: typing.Union[str, IResolvable] = None,
  additional_volumes: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalVolumesProperty]]] = None,
  application: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ApplicationProperty]]] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  client_version: typing.Union[str, IResolvable] = None,
  compute_enable_ht: typing.Union[bool, IResolvable] = None,
  compute_spot_price_limit: typing.Union[str, IResolvable] = None,
  compute_spot_strategy: typing.Union[str, IResolvable] = None,
  deploy_mode: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  ecs_charge_type: typing.Union[str, IResolvable] = None,
  ecs_order_manager_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ehpc_version: typing.Union[str, IResolvable] = None,
  ha_enable: typing.Union[bool, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_owner_alias: typing.Union[str, IResolvable] = None,
  input_file_url: typing.Union[str, IResolvable] = None,
  is_compute_ess: typing.Union[bool, IResolvable] = None,
  job_queue: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  network_interface_traffic_mode: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  post_install_script: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PostInstallScriptProperty]]] = None,
  ram_node_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  remote_directory: typing.Union[str, IResolvable] = None,
  remote_vis_enable: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scc_cluster_id: typing.Union[str, IResolvable] = None,
  scheduler_type: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_name: typing.Union[str, IResolvable] = None,
  system_disk_level: typing.Union[str, IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_type: typing.Union[str, IResolvable] = None,
  volume_id: typing.Union[str, IResolvable] = None,
  volume_mountpoint: typing.Union[str, IResolvable] = None,
  volume_protocol: typing.Union[str, IResolvable] = None,
  volume_type: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  without_elastic_ip: typing.Union[bool, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
ecs_order_compute_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ecsOrderComputeCount: Computing node number, which ranges from: 0-99.
ecs_order_compute_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property ecsOrderComputeInstanceType: Cluster computing node instance specifications.
ecs_order_login_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ecsOrderLoginCount: Login node number can only be 1.
ecs_order_login_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property ecsOrderLoginInstanceType: Log cluster node instance specifications.
ecs_order_manager_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property ecsOrderManagerInstanceType: Cluster control node instance specifications.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: Cluster name.
os_tag typing.Union[str, ros_cdk_core.IResolvable] Property osTag: Operating system image tag.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: VPC in switch ID.
account_type typing.Union[str, ros_cdk_core.IResolvable] Property accountType: The service type of the domain account.
additional_volumes typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AdditionalVolumesProperty]]] Property additionalVolumes:.
application typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ApplicationProperty]]] Property application: Application software tag (SoftwareTag) list, You can call ListSoftwares API to query.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: true: automatic renewals;
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: Duration of each automatic renewals, AutoRenew take effect when AutoRenew is True.
client_version typing.Union[str, ros_cdk_core.IResolvable] Property clientVersion: The version of the E-HPC client.
compute_enable_ht typing.Union[bool, ros_cdk_core.IResolvable] Property computeEnableHt: Specifies whether the compute nodes support hyper-threading.
compute_spot_price_limit typing.Union[str, ros_cdk_core.IResolvable] Property computeSpotPriceLimit: Set an example of the highest price per hour, are floating-point values, in the range of the current price range.
compute_spot_strategy typing.Union[str, ros_cdk_core.IResolvable] Property computeSpotStrategy: Compute nodes bidding strategy, value NoSpot, SpotWithPriceLimit or SpotAsPriceGo.
deploy_mode typing.Union[str, ros_cdk_core.IResolvable] Property deployMode: The mode in which the cluster is deployed.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Cluster description, 2 to 128 characters.
ecs_charge_type typing.Union[str, 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.
ecs_order_manager_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ecsOrderManagerCount: Control node number can be 1, 2.
ehpc_version typing.Union[str, ros_cdk_core.IResolvable] Property ehpcVersion: The version of E-HPC.
ha_enable typing.Union[bool, ros_cdk_core.IResolvable] Property haEnable: Specifies whether to enable the high availability feature.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: Mirror Id, if ImageType a system, based on the image ID is determined only according OsTag;
image_owner_alias typing.Union[str, ros_cdk_core.IResolvable] Property imageOwnerAlias: Mirror type: system, self, others or marketplace.
input_file_url typing.Union[str, ros_cdk_core.IResolvable] Property inputFileUrl: The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.
is_compute_ess typing.Union[bool, ros_cdk_core.IResolvable] Property isComputeEss: Specifies whether to enable auto scaling.
job_queue typing.Union[str, ros_cdk_core.IResolvable] Property jobQueue: The queue to which the compute nodes are added.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: Key pair name.
network_interface_traffic_mode typing.Union[str, ros_cdk_core.IResolvable] Property networkInterfaceTrafficMode: Communication mode of an elastic NIC.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: Root password of jump server (login node).
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The purchase of long resources, units: week \/ month \/ year.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The purchase of long-resources unit.
post_install_script typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PostInstallScriptProperty]]] Property postInstallScript:.
ram_node_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property ramNodeTypes: When authorizing instance configuration, the node type to which the RAM role is bound.
ram_role_name typing.Union[str, ros_cdk_core.IResolvable] Property ramRoleName: The name of the Resource Access Management (RAM) role.
remote_directory typing.Union[str, ros_cdk_core.IResolvable] Property remoteDirectory: Mount shared storage remote directory.
remote_vis_enable typing.Union[bool, ros_cdk_core.IResolvable] Property remoteVisEnable: Specifies whether to enable Virtual Network Computing (VNC).
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
scc_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property sccClusterId: When SCC models, if you pass this field, then the specified SccCluster create Scc instance, otherwise it will create an instance for the user.
scheduler_type typing.Union[str, ros_cdk_core.IResolvable] Property schedulerType: The type of the scheduler.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Security group ID.
security_group_name typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupName: If you do not use an existing security group (SecurityGroupId is empty), then use this name to create a new security group, the default policy.
system_disk_level typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskLevel: The performance level of the ESSD that is created as the system disk.
system_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property systemDiskSize: The size of the system disk.
system_disk_type typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskType: The type of the system disk.
volume_id typing.Union[str, ros_cdk_core.IResolvable] Property volumeId: The ID of the file system.
volume_mountpoint typing.Union[str, ros_cdk_core.IResolvable] Property volumeMountpoint: The mount target of the file system.
volume_protocol typing.Union[str, ros_cdk_core.IResolvable] Property volumeProtocol: The type of the protocol that is used by the file system.
volume_type typing.Union[str, ros_cdk_core.IResolvable] Property volumeType: The type of the shared storage.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.
without_elastic_ip typing.Union[bool, ros_cdk_core.IResolvable] Property withoutElasticIp: Specifies whether the logon node uses an elastic IP address (EIP).
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: Available area ID.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ecs_order_compute_countRequired

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

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

ecs_order_compute_instance_typeRequired

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

Property ecsOrderComputeInstanceType: Cluster computing node instance specifications.

ecs_order_login_countRequired

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

Property ecsOrderLoginCount: Login node number can only be 1.

ecs_order_login_instance_typeRequired

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

Property ecsOrderLoginInstanceType: Log cluster node instance specifications.

ecs_order_manager_instance_typeRequired

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

Property ecsOrderManagerInstanceType: Cluster control node instance specifications.

nameRequired

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

os_tagRequired

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

Property osTag: Operating system image tag.

You can call ListImages API to query.

v_switch_idRequired

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

Property vSwitchId: VPC in switch ID.

Products currently only supports VPC network.

account_typeOptional

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

Property accountType: The service type of the domain account.

Valid values: nis ldap Default value: nis

additional_volumesOptional

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

Property additionalVolumes:.

applicationOptional

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

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

auto_renewOptional

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

Property autoRenew: true: automatic renewals;

false: no automatic renewals.

auto_renew_periodOptional

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

Property autoRenewPeriod: Duration of each automatic renewals, AutoRenew take effect when AutoRenew is True.

client_versionOptional

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

compute_enable_htOptional

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

compute_spot_price_limitOptional

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

Property computeSpotPriceLimit: Set an example of the highest price per hour, are floating-point values, in the range of the current price range.

compute_spot_strategyOptional

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

Property computeSpotStrategy: Compute nodes bidding strategy, value NoSpot, SpotWithPriceLimit or SpotAsPriceGo.

deploy_modeOptional

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

descriptionOptional

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

Property description: Cluster description, 2 to 128 characters.

ecs_charge_typeOptional

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

ecs_order_manager_countOptional

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

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

ehpc_versionOptional

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

Property ehpcVersion: The version of E-HPC.

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

ha_enableOptional

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

image_idOptional

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

Property imageId: Mirror Id, if ImageType a system, based on the image ID is determined only according OsTag;

if self, others, or marketplace, ImageId is mandatory.

image_owner_aliasOptional

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

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

input_file_urlOptional

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

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

is_compute_essOptional

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

job_queueOptional

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

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

key_pair_nameOptional

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

Property keyPairName: Key pair name.

network_interface_traffic_modeOptional

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

passwordOptional

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

Property password: Root password of jump server (login node).

8 to 30 characters, must contain three (upper and lower case letters, numbers and special symbols). ! Supports the following special characters :() `~ @ # $% ^ & * - + = | {} []:; '<>, / Be sure to use the HTTPS protocol API call to avoid password leaks that may occur.?.

periodOptional

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

Property period: The purchase of long resources, units: week \/ month \/ year.

When the value of the parameter EcsChargeType when PrePaid take effect and for the selected value will be.

period_unitOptional

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

Property periodUnit: The purchase of long-resources unit.

Alternatively value Week / Month / year.

post_install_scriptOptional

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

Property postInstallScript:.

ram_node_typesOptional

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

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.

ram_role_nameOptional

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

remote_directoryOptional

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

remote_vis_enableOptional

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

resource_group_idOptional

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

scc_cluster_idOptional

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

Property sccClusterId: When SCC models, if you pass this field, then the specified SccCluster create Scc instance, otherwise it will create an instance for the user.

scheduler_typeOptional

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

Property schedulerType: The type of the scheduler.

Valid values: pbs slurm opengridscheduler deadline Default value: pbs

security_group_idOptional

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

Property securityGroupId: Security group ID.

security_group_nameOptional

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

Property securityGroupName: If you do not use an existing security group (SecurityGroupId is empty), then use this name to create a new security group, the default policy.

Format Requirements Reference ECS security group name.

system_disk_levelOptional

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

system_disk_sizeOptional

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

Property systemDiskSize: The size of the system disk.

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

system_disk_typeOptional

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

volume_idOptional

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

volume_mountpointOptional

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

volume_protocolOptional

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

volume_typeOptional

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

Property volumeType: The type of the shared storage.

Only Apsara File Storage nas file systems are supported.

vpc_idOptional

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

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

without_elastic_ipOptional

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

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

Default value: false

zone_idOptional

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

Property zoneId: Available area ID.

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

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.Cluster.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.
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.
attr_ecs_info ros_cdk_core.IResolvable Attribute EcsInfo: A data structure describing the number and specifications of ECS for various components of the cluster.
attr_name ros_cdk_core.IResolvable Attribute Name: Cluster name.
attr_security_group_id ros_cdk_core.IResolvable Attribute SecurityGroupId: Security group ID.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: Cluster Id.

attr_ecs_infoRequired 

attr_ecs_info: IResolvable
  • Type: 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"}}

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: Cluster name.

attr_security_group_idRequired 

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: Security group ID.