Skip to content

RosCluster

This class is a base encapsulation around 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.RosCluster(
  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
)
Name Type Description
scope ros_cdk_core.Construct - scope in which this resource is defined.
id str - scoped id of the resource.
ecs_order_compute_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ecs_order_compute_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_login_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ecs_order_login_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_manager_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
name typing.Union[str, ros_cdk_core.IResolvable] No description.
os_tag typing.Union[str, ros_cdk_core.IResolvable] No description.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] No description.
account_type typing.Union[str, ros_cdk_core.IResolvable] No description.
additional_volumes typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AdditionalVolumesProperty]]] No description.
application typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ApplicationProperty]]] No description.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
client_version typing.Union[str, ros_cdk_core.IResolvable] No description.
compute_enable_ht typing.Union[bool, ros_cdk_core.IResolvable] No description.
compute_spot_price_limit typing.Union[str, ros_cdk_core.IResolvable] No description.
compute_spot_strategy typing.Union[str, ros_cdk_core.IResolvable] No description.
deploy_mode typing.Union[str, ros_cdk_core.IResolvable] No description.
description typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_manager_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ehpc_version typing.Union[str, ros_cdk_core.IResolvable] No description.
ha_enable typing.Union[bool, ros_cdk_core.IResolvable] No description.
image_id typing.Union[str, ros_cdk_core.IResolvable] No description.
image_owner_alias typing.Union[str, ros_cdk_core.IResolvable] No description.
input_file_url typing.Union[str, ros_cdk_core.IResolvable] No description.
is_compute_ess typing.Union[bool, ros_cdk_core.IResolvable] No description.
job_queue typing.Union[str, ros_cdk_core.IResolvable] No description.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] No description.
network_interface_traffic_mode typing.Union[str, ros_cdk_core.IResolvable] No description.
password typing.Union[str, ros_cdk_core.IResolvable] No description.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
period_unit typing.Union[str, ros_cdk_core.IResolvable] No description.
post_install_script typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PostInstallScriptProperty]]] No description.
ram_node_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
ram_role_name typing.Union[str, ros_cdk_core.IResolvable] No description.
remote_directory typing.Union[str, ros_cdk_core.IResolvable] No description.
remote_vis_enable typing.Union[bool, ros_cdk_core.IResolvable] No description.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
scc_cluster_id typing.Union[str, ros_cdk_core.IResolvable] No description.
scheduler_type typing.Union[str, ros_cdk_core.IResolvable] No description.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
security_group_name typing.Union[str, ros_cdk_core.IResolvable] No description.
system_disk_level typing.Union[str, ros_cdk_core.IResolvable] No description.
system_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
system_disk_type typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_id typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_mountpoint typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_protocol typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_type typing.Union[str, ros_cdk_core.IResolvable] No description.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] No description.
without_elastic_ip typing.Union[bool, ros_cdk_core.IResolvable] No description.
zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

scope in which this resource is defined.


idRequired

  • Type: str

scoped id of the resource.


ecs_order_compute_countRequired

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

ecs_order_compute_instance_typeRequired

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

ecs_order_login_countRequired

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

ecs_order_login_instance_typeRequired

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

ecs_order_manager_instance_typeRequired

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

nameRequired

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

os_tagRequired

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

v_switch_idRequired

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

account_typeOptional

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

additional_volumesOptional

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

applicationOptional

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

auto_renewOptional

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

auto_renew_periodOptional

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

client_versionOptional

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

compute_enable_htOptional

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

compute_spot_price_limitOptional

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

compute_spot_strategyOptional

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

deploy_modeOptional

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

descriptionOptional

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

ecs_charge_typeOptional

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

ecs_order_manager_countOptional

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

ehpc_versionOptional

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

ha_enableOptional

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

image_idOptional

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

image_owner_aliasOptional

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

input_file_urlOptional

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

is_compute_essOptional

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

job_queueOptional

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

key_pair_nameOptional

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

network_interface_traffic_modeOptional

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

passwordOptional

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

periodOptional

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

period_unitOptional

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

post_install_scriptOptional

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

ram_node_typesOptional

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

ram_role_nameOptional

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

remote_directoryOptional

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

remote_vis_enableOptional

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

resource_group_idOptional

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

scc_cluster_idOptional

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

scheduler_typeOptional

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

security_group_idOptional

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

security_group_nameOptional

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

system_disk_levelOptional

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

system_disk_sizeOptional

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

system_disk_typeOptional

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

volume_idOptional

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

volume_mountpointOptional

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

volume_protocolOptional

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

volume_typeOptional

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

vpc_idOptional

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

without_elastic_ipOptional

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

zone_idOptional

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

enable_resource_property_constraintRequired

  • 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.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
add_condition No description.
add_count No description.
add_deletion_override Syntactic sugar for addOverride(path, undefined).
add_depends_on Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
add_desc No description.
add_meta_data No description.
add_override Adds an override to the synthesized ROS resource.
add_property_deletion_override Adds an override that deletes the value of a property from the resource definition.
add_property_override Adds an override to a resource property.
add_ros_dependency No description.
apply_removal_policy Sets the deletion policy of the resource based on the removal policy specified.
get_att Returns a token for an runtime attribute of this resource.

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.


override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired

  • Type: str

The new logical ID to use for this stack element.


add_condition

def add_condition(
  con: RosCondition
) -> None

conRequired

  • 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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: str

The path of the value to delete.


add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

  • Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

descRequired

  • Type: str

add_meta_data

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: typing.Any

The value.

Could be primitive or complex.


add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_pathRequired

  • Type: str

The path to the property.


add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_pathRequired

  • Type: str

The path of the property.


valueRequired

  • Type: typing.Any

The value.


add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

targetRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policyOptional

  • Type: bool

default_policyOptional

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_nameRequired

  • Type: str

The name of the attribute.


Static Functions

Name Description
is_construct Return whether the given object is a Construct.
is_ros_element Returns true if a construct is a stack element (i.e. part of the synthesized template).
is_ros_resource Check whether the given construct is a RosResource.

is_construct

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

is_ros_element

import ros_cdk_ehpc
ros_cdk_ehpc.RosCluster.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: typing.Any

is_ros_resource

import ros_cdk_ehpc
ros_cdk_ehpc.RosCluster.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

constructRequired

  • Type: ros_cdk_core.IConstruct

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
creation_stack typing.List[str] No description.
logical_id str The logical ID for this stack element.
stack ros_cdk_core.Stack The stack in which this element is defined.
ref str Return a string that will be resolved to a RosTemplate { Ref } for this element.
ros_options ros_cdk_core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
ros_resource_type str ROS resource type.
attr_cluster_id ros_cdk_core.IResolvable No description.
attr_ecs_info ros_cdk_core.IResolvable No description.
attr_name ros_cdk_core.IResolvable No description.
attr_security_group_id ros_cdk_core.IResolvable No description.
ecs_order_compute_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ecs_order_compute_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_login_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ecs_order_login_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_manager_instance_type typing.Union[str, ros_cdk_core.IResolvable] No description.
enable_resource_property_constraint bool No description.
name typing.Union[str, ros_cdk_core.IResolvable] No description.
os_tag typing.Union[str, ros_cdk_core.IResolvable] No description.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] No description.
account_type typing.Union[str, ros_cdk_core.IResolvable] No description.
additional_volumes typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AdditionalVolumesProperty]]] No description.
application typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ApplicationProperty]]] No description.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
client_version typing.Union[str, ros_cdk_core.IResolvable] No description.
compute_enable_ht typing.Union[bool, ros_cdk_core.IResolvable] No description.
compute_spot_price_limit typing.Union[str, ros_cdk_core.IResolvable] No description.
compute_spot_strategy typing.Union[str, ros_cdk_core.IResolvable] No description.
deploy_mode typing.Union[str, ros_cdk_core.IResolvable] No description.
description typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
ecs_order_manager_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ehpc_version typing.Union[str, ros_cdk_core.IResolvable] No description.
ha_enable typing.Union[bool, ros_cdk_core.IResolvable] No description.
image_id typing.Union[str, ros_cdk_core.IResolvable] No description.
image_owner_alias typing.Union[str, ros_cdk_core.IResolvable] No description.
input_file_url typing.Union[str, ros_cdk_core.IResolvable] No description.
is_compute_ess typing.Union[bool, ros_cdk_core.IResolvable] No description.
job_queue typing.Union[str, ros_cdk_core.IResolvable] No description.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] No description.
network_interface_traffic_mode typing.Union[str, ros_cdk_core.IResolvable] No description.
password typing.Union[str, ros_cdk_core.IResolvable] No description.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
period_unit typing.Union[str, ros_cdk_core.IResolvable] No description.
post_install_script typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PostInstallScriptProperty]]] No description.
ram_node_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
ram_role_name typing.Union[str, ros_cdk_core.IResolvable] No description.
remote_directory typing.Union[str, ros_cdk_core.IResolvable] No description.
remote_vis_enable typing.Union[bool, ros_cdk_core.IResolvable] No description.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
scc_cluster_id typing.Union[str, ros_cdk_core.IResolvable] No description.
scheduler_type typing.Union[str, ros_cdk_core.IResolvable] No description.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
security_group_name typing.Union[str, ros_cdk_core.IResolvable] No description.
system_disk_level typing.Union[str, ros_cdk_core.IResolvable] No description.
system_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
system_disk_type typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_id typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_mountpoint typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_protocol typing.Union[str, ros_cdk_core.IResolvable] No description.
volume_type typing.Union[str, ros_cdk_core.IResolvable] No description.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] No description.
without_elastic_ip typing.Union[bool, ros_cdk_core.IResolvable] No description.
zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


creation_stackRequired

creation_stack: typing.List[str]
  • Type: typing.List[str]

logical_idRequired

logical_id: str
  • Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


refRequired

ref: str
  • Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


ros_optionsRequired

ros_options: IRosResourceOptions
  • Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


ros_resource_typeRequired

ros_resource_type: str
  • Type: str

ROS resource type.


attr_cluster_idRequired

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_ecs_infoRequired

attr_ecs_info: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_nameRequired

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_security_group_idRequired

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

ecs_order_compute_countRequired

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

ecs_order_compute_instance_typeRequired

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

ecs_order_login_countRequired

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

ecs_order_login_instance_typeRequired

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

ecs_order_manager_instance_typeRequired

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

enable_resource_property_constraintRequired

enable_resource_property_constraint: bool
  • Type: bool

nameRequired

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

os_tagRequired

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

v_switch_idRequired

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

account_typeOptional

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

additional_volumesOptional

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

applicationOptional

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

auto_renewOptional

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

auto_renew_periodOptional

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

client_versionOptional

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

compute_enable_htOptional

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

compute_spot_price_limitOptional

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

compute_spot_strategyOptional

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

deploy_modeOptional

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

descriptionOptional

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

ecs_charge_typeOptional

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

ecs_order_manager_countOptional

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

ehpc_versionOptional

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

ha_enableOptional

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

image_idOptional

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

image_owner_aliasOptional

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

input_file_urlOptional

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

is_compute_essOptional

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

job_queueOptional

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

key_pair_nameOptional

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

network_interface_traffic_modeOptional

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

passwordOptional

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

periodOptional

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

period_unitOptional

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

post_install_scriptOptional

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

ram_node_typesOptional

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

ram_role_nameOptional

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

remote_directoryOptional

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

remote_vis_enableOptional

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

resource_group_idOptional

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

scc_cluster_idOptional

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

scheduler_typeOptional

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

security_group_idOptional

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

security_group_nameOptional

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

system_disk_levelOptional

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

system_disk_sizeOptional

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

system_disk_typeOptional

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

volume_idOptional

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

volume_mountpointOptional

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

volume_protocolOptional

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

volume_typeOptional

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

vpc_idOptional

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

without_elastic_ipOptional

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

zone_idOptional

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

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME str The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

ROS_RESOURCE_TYPE_NAME: str
  • Type: str

The resource type name for this resource class.