Instances

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Instances, which is used to query the information about Elastic Compute Service (ECS) instances.

Initializers

from ros_cdk_ecs import datasource
datasource.Instances(
  scope: Construct,
  id: str,
  additional_attributes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  eip_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  filters: typing.Union[IResolvable, typing.List[typing.Union[FiltersProperty, IResolvable]]] = None,
  hpc_cluster_id: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  inner_ip_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  instance_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  instance_network_type: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  instance_type_family: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  io_optimized: typing.Union[bool, IResolvable] = None,
  ipv6_address: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  private_ip_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  public_ip_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  rdma_ip_addresses: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: 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 = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No description.
`additional_attributes`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property additionalAttributes: The value of attribute N.
`eip_addresses`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property eipAddresses: The elastic IP addresses (EIPs) of instances.
`filters`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosInstances.FiltersProperty, ros_cdk_core.IResolvable]]]`	Property filters: Filter value when querying resources.
`hpc_cluster_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property hpcClusterId: The ID of the High Performance Computing (HPC) cluster to which the instance belongs.
`image_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property imageId: The ID of the image.
`inner_ip_addresses`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property innerIpAddresses: The internal IP addresses of instances located in the classic network.
`instance_charge_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceChargeType: The billing method of the instance.
`instance_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceId: The IDs of instances.
`instance_ids`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property instanceIds: The IDs of instances.
`instance_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceName: The name of the instance.
`instance_network_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceNetworkType: The network type of the instance.
`instance_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceType: The instance type of the instance.
`instance_type_family`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceTypeFamily: The instance family of the instance.
`internet_charge_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property internetChargeType: The billing method for network usage.
`io_optimized`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property ioOptimized: Specifies whether the instance is I\/O optimized.
`ipv6_address`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property ipv6Address: IPv6 address N of the elastic network interface (ENI).
`key_pair_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property keyPairName: The name of the SSH key pair bound to the instance.
`private_ip_addresses`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property privateIpAddresses: The private IP addresses of instances located in VPCs.
`public_ip_addresses`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property publicIpAddresses: The public IP addresses of instances.
`rdma_ip_addresses`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property rdmaIpAddresses: The Remote Direct Memory Access (RDMA) IP addresses of HPC instances.
`refresh_options`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
`resource_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property resourceGroupId: The ID of the resource group to which the instance belongs.
`security_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property securityGroupId: The ID of the security group to which the instance belongs.
`status`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property status: The state of the instance.
`tags`	`typing.List[ros_cdk_ecs.datasource.RosInstances.TagsProperty]`	Property tags: Tags of instance.
`vpc_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vpcId: The ID of the virtual private cloud (VPC).
`v_switch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vSwitchId: The ID of the vSwitch.
`zone_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property zoneId: The zone ID of the instance.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`additional_attributes`^Optional

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

Property additionalAttributes: The value of attribute N.

Valid values of N: 1 to 20. Valid values: META_OPTIONS: instance metadata DDH_CLUSTER: dedicated host cluster NETWORK_PRIMARY_ENI_IP: secondary IP address associated with the primary ENI of the instance

`eip_addresses`^Optional

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

Property eipAddresses: The elastic IP addresses (EIPs) of instances.

This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

`filters`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosInstances.FiltersProperty, ros_cdk_core.IResolvable]]]

Property filters: Filter value when querying resources.

`hpc_cluster_id`^Optional

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

Property hpcClusterId: The ID of the High Performance Computing (HPC) cluster to which the instance belongs.

`image_id`^Optional

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

Property imageId: The ID of the image.

`inner_ip_addresses`^Optional

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

Property innerIpAddresses: The internal IP addresses of instances located in the classic network.

This parameter is valid when InstanceNetworkType is set to classic. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

`instance_charge_type`^Optional

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

Property instanceChargeType: The billing method of the instance.

Valid values: PostPaid: pay-as-you-go PrePaid: subscription

`instance_id`^Optional

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

Property instanceId: The IDs of instances.

The value can be a JSON array that consists of up to 100 instance IDs. Separate the instance IDs with commas (,).

`instance_ids`^Optional

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

Property instanceIds: The IDs of instances.

The value can be a JSON array that consists of up to 100 instance IDs. Separate the instance IDs with commas (,).

`instance_name`^Optional

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

Property instanceName: The name of the instance.

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

`instance_network_type`^Optional

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

Property instanceNetworkType: The network type of the instance.

Valid values: classic: classic network vpc: VPC

`instance_type`^Optional

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

Property instanceType: The instance type of the instance.

`instance_type_family`^Optional

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

Property instanceTypeFamily: The instance family of the instance.

`internet_charge_type`^Optional

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

Property internetChargeType: The billing method for network usage.

Valid values: PayByBandwidth: pay-by-bandwidth PayByTraffic: pay-by-traffic

`io_optimized`^Optional

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

Property ioOptimized: Specifies whether the instance is I\/O optimized.

`ipv6_address`^Optional

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

Property ipv6Address: IPv6 address N of the elastic network interface (ENI).

You can specify multiple IPv6 addresses. Valid values of N: 1 to 100.

`key_pair_name`^Optional

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

Property keyPairName: The name of the SSH key pair bound to the instance.

`private_ip_addresses`^Optional

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

Property privateIpAddresses: The private IP addresses of instances located in VPCs.

This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

`public_ip_addresses`^Optional

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

Property publicIpAddresses: The public IP addresses of instances.

The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

`rdma_ip_addresses`^Optional

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

Property rdmaIpAddresses: The Remote Direct Memory Access (RDMA) IP addresses of HPC instances.

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

`resource_group_id`^Optional

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

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

`security_group_id`^Optional

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

Property securityGroupId: The ID of the security group to which the instance belongs.

`status`^Optional

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

Property status: The state of the instance.

Valid values: Pending Running Starting Stopping Stopped

`tags`^Optional

Type: typing.List[ros_cdk_ecs.datasource.RosInstances.TagsProperty]

Property tags: Tags of instance.

`vpc_id`^Optional

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

Property vpcId: The ID of the virtual private cloud (VPC).

`v_switch_id`^Optional

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

Property vSwitchId: The ID of the vSwitch.

`zone_id`^Optional

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

Property zoneId: The zone ID of the instance.

`enable_resource_property_constraint`^Optional

Type: bool

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`add_condition`	No description.
`add_count`	No description.
`add_dependency`	No description.
`add_resource_desc`	No description.
`apply_removal_policy`	No description.
`get_att`	No description.
`set_metadata`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`synthesize`

def synthesize(
  session: ISynthesisSession
) -> None

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

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

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

`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

Name	Description
`is_construct`	Return whether the given object is a Construct.

`is_construct`

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

Return whether the given object is a Construct.

x^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`ros_cdk_core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`str`	No description.
`stack`	`ros_cdk_core.Stack`	The stack in which this resource is defined.
`resource`	`ros_cdk_core.RosResource`	No description.
`attr_instance_ids`	`ros_cdk_core.IResolvable`	Attribute InstanceIds: The list of InstanceIds.
`attr_instances`	`ros_cdk_core.IResolvable`	Attribute Instances: The list of Instances.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`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_instance_ids`^Required

attr_instance_ids: IResolvable

Type: ros_cdk_core.IResolvable

Attribute InstanceIds: The list of InstanceIds.

`attr_instances`^Required

attr_instances: IResolvable

Type: ros_cdk_core.IResolvable

Attribute Instances: The list of Instances.

Instances

Initializers

scopeRequired

idRequired

additional_attributesOptional

eip_addressesOptional

filtersOptional

hpc_cluster_idOptional

image_idOptional

inner_ip_addressesOptional

instance_charge_typeOptional

instance_idOptional

instance_idsOptional

instance_nameOptional

instance_network_typeOptional

instance_typeOptional

instance_type_familyOptional

internet_charge_typeOptional

io_optimizedOptional

ipv6_addressOptional

key_pair_nameOptional

private_ip_addressesOptional

public_ip_addressesOptional

rdma_ip_addressesOptional

refresh_optionsOptional

resource_group_idOptional

security_group_idOptional

statusOptional

tagsOptional

vpc_idOptional

v_switch_idOptional

zone_idOptional

enable_resource_property_constraintOptional