RosLaunchTemplate
This class is a base encapsulation around the ROS resource type ALIYUN::ECS::LaunchTemplate, which is used to create a launch template.
You can use a launch template to create an Elastic Compute Service (ECS) instance.
Initializers
import ros_cdk_ecs
ros_cdk_ecs.RosLaunchTemplate(
  scope: Construct,
  id: str,
  launch_template_name: typing.Union[str, IResolvable],
  auto_release_time: typing.Union[str, IResolvable] = None,
  deployment_set_id: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]] = None,
  host_name: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_owner_alias: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_optimized: typing.Union[str, IResolvable] = None,
  ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  network_interfaces: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NetworkInterfacesProperty]]] = None,
  network_type: typing.Union[str, IResolvable] = None,
  password_inherit: typing.Union[bool, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_enhancement_strategy: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  spot_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  spot_price_limit: typing.Union[str, IResolvable] = None,
  spot_strategy: typing.Union[str, IResolvable] = None,
  system_disk_category: typing.Union[str, IResolvable] = None,
  system_disk_delete_with_instance: typing.Union[bool, IResolvable] = None,
  system_disk_description: typing.Union[str, IResolvable] = None,
  system_disk_disk_name: typing.Union[str, IResolvable] = None,
  system_disk_performance_level: typing.Union[str, IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  template_resource_group_id: typing.Union[str, IResolvable] = None,
  template_tags: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TemplateTagsProperty]]] = None,
  user_data: typing.Union[str, IResolvable] = None,
  version_description: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, 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. | 
launch_template_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
auto_release_time | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
deployment_set_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
disk_mappings | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] | 
No description. | 
host_name | 
typing.Union[str, 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. | 
instance_charge_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
instance_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
instance_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
internet_charge_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
internet_max_bandwidth_out | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
io_optimized | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
ipv6_address_count | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
key_pair_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
network_interfaces | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkInterfacesProperty]]] | 
No description. | 
network_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
password_inherit | 
typing.Union[bool, ros_cdk_core.IResolvable] | 
No description. | 
period | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
private_ip_address | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
ram_role_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
resource_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_enhancement_strategy | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_group_ids | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | 
No description. | 
spot_duration | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
spot_price_limit | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
spot_strategy | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_category | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_delete_with_instance | 
typing.Union[bool, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_disk_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_performance_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. | 
tags | 
typing.List[TagsProperty] | 
No description. | 
template_resource_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
template_tags | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TemplateTagsProperty]]] | 
No description. | 
user_data | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
version_description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
v_switch_id | 
typing.Union[str, 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.
launch_template_nameRequired 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
auto_release_timeOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
deployment_set_idOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
descriptionOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
disk_mappingsOptional 
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]]
 
host_nameOptional 
- Type: typing.Union[str, 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]
 
instance_charge_typeOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
instance_nameOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
instance_typeOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
internet_charge_typeOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
internet_max_bandwidth_outOptional 
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
io_optimizedOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
ipv6_address_countOptional 
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
key_pair_nameOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
network_interfacesOptional 
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkInterfacesProperty]]]
 
network_typeOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
password_inheritOptional 
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
 
periodOptional 
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
private_ip_addressOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
ram_role_nameOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
resource_group_idOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
security_enhancement_strategyOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
security_group_idOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
security_group_idsOptional 
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
 
spot_durationOptional 
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
spot_price_limitOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
spot_strategyOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_categoryOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_delete_with_instanceOptional 
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
 
system_disk_descriptionOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_disk_nameOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_performance_levelOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_sizeOptional 
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
tagsOptional 
- Type: typing.List[TagsProperty]
 
template_resource_group_idOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
template_tagsOptional 
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TemplateTagsProperty]]]
 
user_dataOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
version_descriptionOptional 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
v_switch_idOptional 
- Type: typing.Union[str, 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.
- 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.
- Type: str
 
The new logical ID to use for this stack element.
add_condition 
def add_condition(
  con: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
 
add_count 
def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- 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).
- 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.
- Type: ros_cdk_core.RosResource
 
add_desc 
def add_desc(
  desc: str
) -> None
- Type: str
 
add_meta_data 
def add_meta_data(
  key: str,
  value: typing.Any
) -> None
- Type: str
 
- 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"
       ...
     },
   ]
   ...
}
- 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.
- 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.
- 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).
- Type: str
 
The path of the property.
- Type: typing.Any
 
The value.
add_ros_dependency 
def add_ros_dependency(
  target: str
) -> None
- 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.
- Type: ros_cdk_core.RemovalPolicy
 
apply_to_update_replace_policyOptional 
- Type: bool
 
- 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.
- 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_ecs
ros_cdk_ecs.RosLaunchTemplate.is_construct(
  x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
 
is_ros_element 
import ros_cdk_ecs
ros_cdk_ecs.RosLaunchTemplate.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.
- Type: typing.Any
 
is_ros_resource 
import ros_cdk_ecs
ros_cdk_ecs.RosLaunchTemplate.is_ros_resource(
  construct: IConstruct
)
Check whether the given construct is a RosResource.
- 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_default_version_number | 
ros_cdk_core.IResolvable | 
No description. | 
attr_latest_version_number | 
ros_cdk_core.IResolvable | 
No description. | 
attr_launch_template_id | 
ros_cdk_core.IResolvable | 
No description. | 
attr_launch_template_name | 
ros_cdk_core.IResolvable | 
No description. | 
enable_resource_property_constraint | 
bool | 
No description. | 
launch_template_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
auto_release_time | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
deployment_set_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
disk_mappings | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] | 
No description. | 
host_name | 
typing.Union[str, 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. | 
instance_charge_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
instance_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
instance_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
internet_charge_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
internet_max_bandwidth_out | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
io_optimized | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
ipv6_address_count | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
key_pair_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
network_interfaces | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkInterfacesProperty]]] | 
No description. | 
network_type | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
password_inherit | 
typing.Union[bool, ros_cdk_core.IResolvable] | 
No description. | 
period | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
private_ip_address | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
ram_role_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
resource_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_enhancement_strategy | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
security_group_ids | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | 
No description. | 
spot_duration | 
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | 
No description. | 
spot_price_limit | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
spot_strategy | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_category | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_delete_with_instance | 
typing.Union[bool, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_disk_name | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
system_disk_performance_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. | 
tags | 
typing.List[TagsProperty] | 
No description. | 
template_resource_group_id | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
template_tags | 
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TemplateTagsProperty]]] | 
No description. | 
user_data | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
version_description | 
typing.Union[str, ros_cdk_core.IResolvable] | 
No description. | 
v_switch_id | 
typing.Union[str, 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_default_version_numberRequired 
attr_default_version_number: IResolvable
- Type: ros_cdk_core.IResolvable
 
attr_latest_version_numberRequired 
attr_latest_version_number: IResolvable
- Type: ros_cdk_core.IResolvable
 
attr_launch_template_idRequired 
attr_launch_template_id: IResolvable
- Type: ros_cdk_core.IResolvable
 
attr_launch_template_nameRequired 
attr_launch_template_name: IResolvable
- Type: ros_cdk_core.IResolvable
 
enable_resource_property_constraintRequired 
enable_resource_property_constraint: bool
- Type: bool
 
launch_template_nameRequired 
launch_template_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
auto_release_timeOptional 
auto_release_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
deployment_set_idOptional 
deployment_set_id: 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]
 
disk_mappingsOptional 
disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]]
 
host_nameOptional 
host_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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]
 
instance_charge_typeOptional 
instance_charge_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
instance_nameOptional 
instance_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
instance_typeOptional 
instance_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
internet_charge_typeOptional 
internet_charge_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
internet_max_bandwidth_outOptional 
internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
io_optimizedOptional 
io_optimized: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
ipv6_address_countOptional 
ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
key_pair_nameOptional 
key_pair_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
network_interfacesOptional 
network_interfaces: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NetworkInterfacesProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkInterfacesProperty]]]
 
network_typeOptional 
network_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
password_inheritOptional 
password_inherit: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
 
periodOptional 
period: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
private_ip_addressOptional 
private_ip_address: typing.Union[str, IResolvable]
- Type: 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]
 
resource_group_idOptional 
resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
security_enhancement_strategyOptional 
security_enhancement_strategy: 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_idsOptional 
security_group_ids: 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]]]
 
spot_durationOptional 
spot_duration: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
 
spot_price_limitOptional 
spot_price_limit: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
spot_strategyOptional 
spot_strategy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_categoryOptional 
system_disk_category: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_delete_with_instanceOptional 
system_disk_delete_with_instance: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
 
system_disk_descriptionOptional 
system_disk_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_disk_nameOptional 
system_disk_disk_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
system_disk_performance_levelOptional 
system_disk_performance_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]
 
tagsOptional 
tags: typing.List[TagsProperty]
- Type: typing.List[TagsProperty]
 
template_resource_group_idOptional 
template_resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
template_tagsOptional 
template_tags: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TemplateTagsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TemplateTagsProperty]]]
 
user_dataOptional 
user_data: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
version_descriptionOptional 
version_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
 
v_switch_idOptional 
v_switch_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.