RosInstance

This class is a base encapsulation around the ROS resource type DATASOURCE::ECS::Instance, which is used to query the information about an Elastic Compute Service (ECS) instance.

Initializers

from ros_cdk_ecs import datasource
datasource.RosInstance(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  refresh_options: 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.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	No description.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

---

id^Required

• Type: str

scoped id of the resource.

---

instance_id^Required

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

---

refresh_options^Optional

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

---

enable_resource_property_constraint^Required

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

session^Required

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

• Type: str

The new logical ID to use for this stack element.

---

add_condition

def add_condition(
  con: RosCondition
) -> None

con^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

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

target^Required

• Type: ros_cdk_core.RosResource

---

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

add_meta_data

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

key^Required

• Type: str

---

value^Required

• 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"
       ...
     },
   ]
   ...
}

path^Required

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

---

value^Required

• 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_path^Required

• 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_path^Required

• Type: str

The path of the property.

---

value^Required

• Type: typing.Any

The value.

---

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

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

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

apply_to_update_replace_policy^Optional

• Type: bool

---

default_policy^Optional

• 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_name^Required

• 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

from ros_cdk_ecs import datasource
datasource.RosInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

from ros_cdk_ecs import datasource
datasource.RosInstance.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.

x^Required

• Type: typing.Any

---

is_ros_resource

from ros_cdk_ecs import datasource
datasource.RosInstance.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• 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_action_on_maintenance	ros_cdk_core.IResolvable	No description.
attr_auto_reboot_time	ros_cdk_core.IResolvable	No description.
attr_auto_release_time	ros_cdk_core.IResolvable	No description.
attr_auto_renew_enabled	ros_cdk_core.IResolvable	No description.
attr_cluster_id	ros_cdk_core.IResolvable	No description.
attr_cpu	ros_cdk_core.IResolvable	No description.
attr_cpu_options	ros_cdk_core.IResolvable	No description.
attr_create_time	ros_cdk_core.IResolvable	No description.
attr_credit_specification	ros_cdk_core.IResolvable	No description.
attr_dedicated_host_attribute	ros_cdk_core.IResolvable	No description.
attr_dedicated_instance_attribute	ros_cdk_core.IResolvable	No description.
attr_deletion_protection	ros_cdk_core.IResolvable	No description.
attr_deployment_set_group_no	ros_cdk_core.IResolvable	No description.
attr_deployment_set_id	ros_cdk_core.IResolvable	No description.
attr_description	ros_cdk_core.IResolvable	No description.
attr_device_available	ros_cdk_core.IResolvable	No description.
attr_duration	ros_cdk_core.IResolvable	No description.
attr_ecs_capacity_reservation_attr	ros_cdk_core.IResolvable	No description.
attr_eip_address	ros_cdk_core.IResolvable	No description.
attr_expired_time	ros_cdk_core.IResolvable	No description.
attr_gpu_amount	ros_cdk_core.IResolvable	No description.
attr_gpu_spec	ros_cdk_core.IResolvable	No description.
attr_host_name	ros_cdk_core.IResolvable	No description.
attr_hpc_cluster_id	ros_cdk_core.IResolvable	No description.
attr_image_id	ros_cdk_core.IResolvable	No description.
attr_instance_id	ros_cdk_core.IResolvable	No description.
attr_instance_name	ros_cdk_core.IResolvable	No description.
attr_instance_network_type	ros_cdk_core.IResolvable	No description.
attr_instance_type	ros_cdk_core.IResolvable	No description.
attr_instance_type_family	ros_cdk_core.IResolvable	No description.
attr_internet_charge_type	ros_cdk_core.IResolvable	No description.
attr_internet_max_bandwidth_in	ros_cdk_core.IResolvable	No description.
attr_internet_max_bandwidth_out	ros_cdk_core.IResolvable	No description.
attr_io_optimized	ros_cdk_core.IResolvable	No description.
attr_key_pair_name	ros_cdk_core.IResolvable	No description.
attr_local_storage_amount	ros_cdk_core.IResolvable	No description.
attr_local_storage_capacity	ros_cdk_core.IResolvable	No description.
attr_maintenance_windows	ros_cdk_core.IResolvable	No description.
attr_memory	ros_cdk_core.IResolvable	No description.
attr_metadata_options	ros_cdk_core.IResolvable	No description.
attr_network_interfaces	ros_cdk_core.IResolvable	No description.
attr_notify_on_maintenance	ros_cdk_core.IResolvable	No description.
attr_operation_locks	ros_cdk_core.IResolvable	No description.
attr_os_name	ros_cdk_core.IResolvable	No description.
attr_os_name_en	ros_cdk_core.IResolvable	No description.
attr_os_type	ros_cdk_core.IResolvable	No description.
attr_payment_type	ros_cdk_core.IResolvable	No description.
attr_period_unit	ros_cdk_core.IResolvable	No description.
attr_private_pool_options_id	ros_cdk_core.IResolvable	No description.
attr_private_pool_options_match_criteria	ros_cdk_core.IResolvable	No description.
attr_public_ip_address	ros_cdk_core.IResolvable	No description.
attr_rdma_ip_address	ros_cdk_core.IResolvable	No description.
attr_recyclable	ros_cdk_core.IResolvable	No description.
attr_renewal_status	ros_cdk_core.IResolvable	No description.
attr_resource_group_id	ros_cdk_core.IResolvable	No description.
attr_sale_cycle	ros_cdk_core.IResolvable	No description.
attr_security_group_ids	ros_cdk_core.IResolvable	No description.
attr_serial_number	ros_cdk_core.IResolvable	No description.
attr_spot_duration	ros_cdk_core.IResolvable	No description.
attr_spot_price_limit	ros_cdk_core.IResolvable	No description.
attr_spot_strategy	ros_cdk_core.IResolvable	No description.
attr_start_time	ros_cdk_core.IResolvable	No description.
attr_stopped_mode	ros_cdk_core.IResolvable	No description.
attr_tags	ros_cdk_core.IResolvable	No description.
attr_user_data	ros_cdk_core.IResolvable	No description.
attr_vpc_attributes	ros_cdk_core.IResolvable	No description.
attr_zone_id	ros_cdk_core.IResolvable	No description.
enable_resource_property_constraint	bool	No description.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

---

logical_id^Required

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

---

stack^Required

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

---

ref^Required

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_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

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

---

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

---

attr_action_on_maintenance^Required

attr_action_on_maintenance: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_auto_reboot_time^Required

attr_auto_reboot_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_auto_release_time^Required

attr_auto_release_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_auto_renew_enabled^Required

attr_auto_renew_enabled: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cluster_id^Required

attr_cluster_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cpu^Required

attr_cpu: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cpu_options^Required

attr_cpu_options: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_credit_specification^Required

attr_credit_specification: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_dedicated_host_attribute^Required

attr_dedicated_host_attribute: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_dedicated_instance_attribute^Required

attr_dedicated_instance_attribute: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_deletion_protection^Required

attr_deletion_protection: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_deployment_set_group_no^Required

attr_deployment_set_group_no: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_deployment_set_id^Required

attr_deployment_set_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_device_available^Required

attr_device_available: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_duration^Required

attr_duration: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_ecs_capacity_reservation_attr^Required

attr_ecs_capacity_reservation_attr: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_eip_address^Required

attr_eip_address: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_expired_time^Required

attr_expired_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_gpu_amount^Required

attr_gpu_amount: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_gpu_spec^Required

attr_gpu_spec: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_host_name^Required

attr_host_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_hpc_cluster_id^Required

attr_hpc_cluster_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_image_id^Required

attr_image_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_name^Required

attr_instance_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_network_type^Required

attr_instance_network_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_type^Required

attr_instance_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_instance_type_family^Required

attr_instance_type_family: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_internet_charge_type^Required

attr_internet_charge_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_internet_max_bandwidth_in^Required

attr_internet_max_bandwidth_in: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_internet_max_bandwidth_out^Required

attr_internet_max_bandwidth_out: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_io_optimized^Required

attr_io_optimized: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_key_pair_name^Required

attr_key_pair_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_local_storage_amount^Required

attr_local_storage_amount: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_local_storage_capacity^Required

attr_local_storage_capacity: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_maintenance_windows^Required

attr_maintenance_windows: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_memory^Required

attr_memory: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_metadata_options^Required

attr_metadata_options: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_network_interfaces^Required

attr_network_interfaces: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_notify_on_maintenance^Required

attr_notify_on_maintenance: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_operation_locks^Required

attr_operation_locks: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_os_name^Required

attr_os_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_os_name_en^Required

attr_os_name_en: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_os_type^Required

attr_os_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_period_unit^Required

attr_period_unit: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_private_pool_options_id^Required

attr_private_pool_options_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_private_pool_options_match_criteria^Required

attr_private_pool_options_match_criteria: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_public_ip_address^Required

attr_public_ip_address: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_rdma_ip_address^Required

attr_rdma_ip_address: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_recyclable^Required

attr_recyclable: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_renewal_status^Required

attr_renewal_status: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_sale_cycle^Required

attr_sale_cycle: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_security_group_ids^Required

attr_security_group_ids: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_serial_number^Required

attr_serial_number: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_spot_duration^Required

attr_spot_duration: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_spot_price_limit^Required

attr_spot_price_limit: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_spot_strategy^Required

attr_spot_strategy: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_start_time^Required

attr_start_time: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_stopped_mode^Required

attr_stopped_mode: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_user_data^Required

attr_user_data: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_vpc_attributes^Required

attr_vpc_attributes: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_zone_id^Required

attr_zone_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

instance_id^Required

instance_id: typing.Union[str, IResolvable]

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

---

refresh_options^Optional

refresh_options: 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_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.

---