Skip to content

InstancesProps

Properties for defining a Instances.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-ecs-instances

Initializer

from ros_cdk_ecs import datasource
datasource.InstancesProps(
  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
)

Properties

Name Type 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.

additional_attributesOptional

additional_attributes: 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]]]

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_addressesOptional

eip_addresses: 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]]]

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


filtersOptional

filters: typing.Union[IResolvable, typing.List[typing.Union[FiltersProperty, IResolvable]]]
  • 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_idOptional

hpc_cluster_id: typing.Union[str, IResolvable]
  • 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_idOptional

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

Property imageId: The ID of the image.


inner_ip_addressesOptional

inner_ip_addresses: 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]]]

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_typeOptional

instance_charge_type: typing.Union[str, IResolvable]
  • 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_idOptional

instance_id: typing.Union[str, IResolvable]
  • 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_idsOptional

instance_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]]]

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_nameOptional

instance_name: typing.Union[str, IResolvable]
  • 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_typeOptional

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

Property instanceNetworkType: The network type of the instance.

Valid values: classic: classic network vpc: VPC


instance_typeOptional

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

Property instanceType: The instance type of the instance.


instance_type_familyOptional

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

Property instanceTypeFamily: The instance family of the instance.


internet_charge_typeOptional

internet_charge_type: typing.Union[str, IResolvable]
  • 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_optimizedOptional

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

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


ipv6_addressOptional

ipv6_address: 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]]]

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_nameOptional

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

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


private_ip_addressesOptional

private_ip_addresses: 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]]]

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_addressesOptional

public_ip_addresses: 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]]]

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_addressesOptional

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

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


refresh_optionsOptional

refresh_options: typing.Union[str, IResolvable]
  • 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_idOptional

resource_group_id: typing.Union[str, IResolvable]
  • 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_idOptional

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

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


statusOptional

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

Property status: The state of the instance.

Valid values: Pending Running Starting Stopping Stopped


tagsOptional

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

Property tags: Tags of instance.


vpc_idOptional

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

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


v_switch_idOptional

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

Property vSwitchId: The ID of the vSwitch.


zone_idOptional

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

Property zoneId: The zone ID of the instance.