Instance

• Implements: ros_cdk_ecs.datasource.IInstance

This class encapsulates and extends 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.Instance(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_id^Required

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

Property instanceId: Instance ID.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_action_on_maintenance^Required

attr_action_on_maintenance: typing.Union[str, IResolvable]

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

Attribute ActionOnMaintenance: The O&M action attribute of the instance.

attr_auto_reboot_time^Required

attr_auto_reboot_time: typing.Union[str, IResolvable]

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

Attribute AutoRebootTime: Automatic reboot time after instance configuration change.

attr_auto_release_time^Required

attr_auto_release_time: typing.Union[str, IResolvable]

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

Attribute AutoReleaseTime: The time when to automatically release the pay-as-you-go instance.

attr_auto_renew_enabled^Required

attr_auto_renew_enabled: typing.Union[str, IResolvable]

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

Attribute AutoRenewEnabled: Whether automatic renewal has been set.

attr_cluster_id^Required

attr_cluster_id: typing.Union[str, IResolvable]

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

Attribute ClusterId: The ID of the cluster to which the instance belongs.

attr_cpu^Required

attr_cpu: typing.Union[str, IResolvable]

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

Attribute Cpu: The number of vCPUs.

attr_cpu_options^Required

attr_cpu_options: typing.Union[str, IResolvable]

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

Attribute CpuOptions: Details about the CPU options.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The create time.

attr_credit_specification^Required

attr_credit_specification: typing.Union[str, IResolvable]

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

Attribute CreditSpecification: The performance mode of the burstable instance.

attr_dedicated_host_attribute^Required

attr_dedicated_host_attribute: typing.Union[str, IResolvable]

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

Attribute DedicatedHostAttribute: Details about the dedicated host.

It is an array that consists of the DedicatedHostClusterId, DedicatedHostId, and DedicatedHostName parameters.

attr_dedicated_instance_attribute^Required

attr_dedicated_instance_attribute: typing.Union[str, IResolvable]

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

Attribute DedicatedInstanceAttribute: The attributes of the instance on the dedicated host.

attr_deletion_protection^Required

attr_deletion_protection: typing.Union[str, IResolvable]

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

Attribute DeletionProtection: The release protection attribute of the instance.

This parameter indicates whether you can use the ECS console or call the DeleteInstance operation to release the instance.

attr_deployment_set_group_no^Required

attr_deployment_set_group_no: typing.Union[str, IResolvable]

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

Attribute DeploymentSetGroupNo: The number of the deployment set group to which the instance belongs in a deployment set.

attr_deployment_set_id^Required

attr_deployment_set_id: typing.Union[str, IResolvable]

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

Attribute DeploymentSetId: The ID of the deployment set in which the instance is deployed.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the instance.

attr_device_available^Required

attr_device_available: typing.Union[str, IResolvable]

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

Attribute DeviceAvailable: Indicates whether data disks can be attached to the instance.

attr_duration^Required

attr_duration: typing.Union[str, IResolvable]

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

Attribute Duration: The duration of automatic renewal.

attr_ecs_capacity_reservation_attr^Required

attr_ecs_capacity_reservation_attr: typing.Union[str, IResolvable]

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

Attribute EcsCapacityReservationAttr: Details about the capacity reservation related to the instance.

attr_eip_address^Required

attr_eip_address: typing.Union[str, IResolvable]

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

Attribute EipAddress: Details about the EIP associated with the instance.

attr_expired_time^Required

attr_expired_time: typing.Union[str, IResolvable]

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

Attribute ExpiredTime: The time when the instance expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attr_gpu_amount^Required

attr_gpu_amount: typing.Union[str, IResolvable]

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

Attribute GpuAmount: The number of GPUs for the instance type.

attr_gpu_spec^Required

attr_gpu_spec: typing.Union[str, IResolvable]

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

Attribute GpuSpec: The category of GPUs for the instance type.

attr_host_name^Required

attr_host_name: typing.Union[str, IResolvable]

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

Attribute HostName: The hostname of the instance.

attr_hpc_cluster_id^Required

attr_hpc_cluster_id: typing.Union[str, IResolvable]

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

Attribute HpcClusterId: ID of the HPC cluster to which the instance belongs.

attr_image_id^Required

attr_image_id: typing.Union[str, IResolvable]

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

Attribute ImageId: The ID of the image.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The ID of the instance.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: The name of the instance.

Fuzzy search with the asterisk (*) wildcard characters is supported.

attr_instance_network_type^Required

attr_instance_network_type: typing.Union[str, IResolvable]

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

Attribute InstanceNetworkType: The network type of the instance.

attr_instance_type^Required

attr_instance_type: typing.Union[str, IResolvable]

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

Attribute InstanceType: The instance type of the instance.

attr_instance_type_family^Required

attr_instance_type_family: typing.Union[str, IResolvable]

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

Attribute InstanceTypeFamily: The instance family of the instance.

attr_internet_charge_type^Required

attr_internet_charge_type: typing.Union[str, IResolvable]

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

Attribute InternetChargeType: The billing method for network usage.

attr_internet_max_bandwidth_in^Required

attr_internet_max_bandwidth_in: typing.Union[str, IResolvable]

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

Attribute InternetMaxBandwidthIn: The maximum inbound public bandwidth.

Unit: Mbit/s.

attr_internet_max_bandwidth_out^Required

attr_internet_max_bandwidth_out: typing.Union[str, IResolvable]

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

Attribute InternetMaxBandwidthOut: The maximum outbound public bandwidth.

Unit: Mbit/s.

attr_io_optimized^Required

attr_io_optimized: typing.Union[str, IResolvable]

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

Attribute IoOptimized: Specifies whether the instance is I/O optimized.

attr_key_pair_name^Required

attr_key_pair_name: typing.Union[str, IResolvable]

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

Attribute KeyPairName: The name of the SSH key pair bound to the instance.

attr_local_storage_amount^Required

attr_local_storage_amount: typing.Union[str, IResolvable]

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

Attribute LocalStorageAmount: The number of local disks attached to the instance.

attr_local_storage_capacity^Required

attr_local_storage_capacity: typing.Union[str, IResolvable]

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

Attribute LocalStorageCapacity: The capacity of local disks attached to the instance.

attr_maintenance_windows^Required

attr_maintenance_windows: typing.Union[str, IResolvable]

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

Attribute MaintenanceWindows: The list of operations window instances.

attr_memory^Required

attr_memory: typing.Union[str, IResolvable]

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

Attribute Memory: The memory size of the instance.

Unit: MiB.

attr_metadata_options^Required

attr_metadata_options: typing.Union[str, IResolvable]

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

Attribute MetadataOptions: Details about the metadata options.

attr_network_interfaces^Required

attr_network_interfaces: typing.Union[str, IResolvable]

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

Attribute NetworkInterfaces: Details about the ENIs bound to the instance.

attr_notify_on_maintenance^Required

attr_notify_on_maintenance: typing.Union[str, IResolvable]

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

Attribute NotifyOnMaintenance: Whether to send an event notification before the instance goes down.

attr_operation_locks^Required

attr_operation_locks: typing.Union[str, IResolvable]

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

Attribute OperationLocks: The reasons why the instance was locked.

attr_os_name^Required

attr_os_name: typing.Union[str, IResolvable]

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

Attribute OsName: The name of the operating system of the instance.

attr_os_name_en^Required

attr_os_name_en: typing.Union[str, IResolvable]

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

Attribute OsNameEn: The English name of the operating system of the instance.

attr_os_type^Required

attr_os_type: typing.Union[str, IResolvable]

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

Attribute OsType: The type of the operating system of the instance.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The billing method of the instance.

attr_period_unit^Required

attr_period_unit: typing.Union[str, IResolvable]

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

Attribute PeriodUnit: Renewal unit.

attr_private_pool_options_id^Required

attr_private_pool_options_id: typing.Union[str, IResolvable]

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

Attribute PrivatePoolOptionsId: Private pool ID.

When the return value is open, the private pool ID is the private pool ID assigned when the system automatically matches.

attr_private_pool_options_match_criteria^Required

attr_private_pool_options_match_criteria: typing.Union[str, IResolvable]

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

Attribute PrivatePoolOptionsMatchCriteria: The private pool matching pattern of the instance.

attr_public_ip_address^Required

attr_public_ip_address: typing.Union[str, IResolvable]

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

Attribute PublicIpAddress: The public IP addresses of the instance.

attr_rdma_ip_address^Required

attr_rdma_ip_address: typing.Union[str, IResolvable]

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

Attribute RdmaIpAddress: The RDMA network IP of the HPC instance.

attr_recyclable^Required

attr_recyclable: typing.Union[str, IResolvable]

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

Attribute Recyclable: Indicates whether the instance can be recycled.

attr_renewal_status^Required

attr_renewal_status: typing.Union[str, IResolvable]

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

Attribute RenewalStatus: The automatic renewal status of the instance.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

attr_sale_cycle^Required

attr_sale_cycle: typing.Union[str, IResolvable]

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

Attribute SaleCycle: Instance billing cycles.

attr_security_group_ids^Required

attr_security_group_ids: typing.Union[str, IResolvable]

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

Attribute SecurityGroupIds: The IDs of the security groups to which the instance belongs.

attr_serial_number^Required

attr_serial_number: typing.Union[str, IResolvable]

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

Attribute SerialNumber: The serial number of the instance.

attr_spot_duration^Required

attr_spot_duration: typing.Union[str, IResolvable]

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

Attribute SpotDuration: The protection period of the preemptible instance.

Unit: hours.

attr_spot_price_limit^Required

attr_spot_price_limit: typing.Union[str, IResolvable]

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

Attribute SpotPriceLimit: The maximum hourly price of the instance.

It can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

attr_spot_strategy^Required

attr_spot_strategy: typing.Union[str, IResolvable]

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

Attribute SpotStrategy: The bidding policy for the pay-as-you-go instance.

attr_start_time^Required

attr_start_time: typing.Union[str, IResolvable]

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

Attribute StartTime: The time when the instance was last started.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attr_stopped_mode^Required

attr_stopped_mode: typing.Union[str, IResolvable]

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

Attribute StoppedMode: Indicates whether the instance continues to be billed after it is stopped.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The tags of the instance.

attr_user_data^Required

attr_user_data: typing.Union[str, IResolvable]

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

Attribute UserData: The custom data of the instance.

attr_vpc_attributes^Required

attr_vpc_attributes: typing.Union[str, IResolvable]

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

Attribute VpcAttributes: The VPC attributes of the instance.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: The zone ID of the instance.

props^Required

props: InstanceProps

• Type: InstanceProps