Skip to content

InstancesProps

Properties for defining a Instances.

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

Initializer 

import { datasource } from '@alicloud/ros-cdk-ecs'
const instancesProps: datasource.InstancesProps = { ... }

Properties

Name Type Description
additionalAttributes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property additionalAttributes: The value of attribute N.
eipAddresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property eipAddresses: The elastic IP addresses (EIPs) of instances.
filters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosInstances.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[] Property filters: Filter value when querying resources.
hpcClusterId string | @alicloud/ros-cdk-core.IResolvable Property hpcClusterId: The ID of the High Performance Computing (HPC) cluster to which the instance belongs.
imageId string | @alicloud/ros-cdk-core.IResolvable Property imageId: The ID of the image.
innerIpAddresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property innerIpAddresses: The internal IP addresses of instances located in the classic network.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: The billing method of the instance.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The IDs of instances.
instanceIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property instanceIds: The IDs of instances.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the instance.
instanceNetworkType string | @alicloud/ros-cdk-core.IResolvable Property instanceNetworkType: The network type of the instance.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: The instance type of the instance.
instanceTypeFamily string | @alicloud/ros-cdk-core.IResolvable Property instanceTypeFamily: The instance family of the instance.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: The billing method for network usage.
ioOptimized boolean | @alicloud/ros-cdk-core.IResolvable Property ioOptimized: Specifies whether the instance is I\/O optimized.
ipv6Address @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property ipv6Address: IPv6 address N of the elastic network interface (ENI).
keyPairName string | @alicloud/ros-cdk-core.IResolvable Property keyPairName: The name of the SSH key pair bound to the instance.
privateIpAddresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property privateIpAddresses: The private IP addresses of instances located in VPCs.
publicIpAddresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property publicIpAddresses: The public IP addresses of instances.
rdmaIpAddresses string | @alicloud/ros-cdk-core.IResolvable Property rdmaIpAddresses: The Remote Direct Memory Access (RDMA) IP addresses of HPC instances.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the instance belongs.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the security group to which the instance belongs.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The state of the instance.
tags @alicloud/ros-cdk-ecs.datasource.RosInstances.TagsProperty[] Property tags: Tags of instance.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC).
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the vSwitch.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID of the instance.

additionalAttributesOptional 

public readonly additionalAttributes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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

eipAddressesOptional 

public readonly eipAddresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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 

public readonly filters: IResolvable | FiltersProperty | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosInstances.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[]

Property filters: Filter value when querying resources.

hpcClusterIdOptional 

public readonly hpcClusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

imageIdOptional 

public readonly imageId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property imageId: The ID of the image.

innerIpAddressesOptional 

public readonly innerIpAddresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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 (,).

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: The billing method of the instance.

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

instanceIdOptional 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/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 (,).

instanceIdsOptional 

public readonly instanceIds: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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 (,).

instanceNameOptional 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: The name of the instance.

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

instanceNetworkTypeOptional 

public readonly instanceNetworkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceNetworkType: The network type of the instance.

Valid values: classic: classic network vpc: VPC

instanceTypeOptional 

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceType: The instance type of the instance.

instanceTypeFamilyOptional 

public readonly instanceTypeFamily: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceTypeFamily: The instance family of the instance.

internetChargeTypeOptional 

public readonly internetChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property internetChargeType: The billing method for network usage.

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

ioOptimizedOptional 

public readonly ioOptimized: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

ipv6AddressOptional 

public readonly ipv6Address: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.

keyPairNameOptional 

public readonly keyPairName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

privateIpAddressesOptional 

public readonly privateIpAddresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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 (,).

publicIpAddressesOptional 

public readonly publicIpAddresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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 (,).

rdmaIpAddressesOptional 

public readonly rdmaIpAddresses: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

refreshOptionsOptional 

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/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.

securityGroupIdOptional 

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

statusOptional 

public readonly status: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property status: The state of the instance.

Valid values: Pending Running Starting Stopping Stopped

tagsOptional 

public readonly tags: TagsProperty[];
  • Type: @alicloud/ros-cdk-ecs.datasource.RosInstances.TagsProperty[]

Property tags: Tags of instance.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the vSwitch.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID of the instance.