Skip to content

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 

import com.aliyun.ros.cdk.ecs.datasource.Instances;
Instances.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .additionalAttributes(IResolvable)
//  .additionalAttributes(java.util.List<java.lang.String)
//  .additionalAttributes(IResolvable>)
//  .eipAddresses(IResolvable)
//  .eipAddresses(java.util.List<java.lang.String)
//  .eipAddresses(IResolvable>)
//  .filters(IResolvable)
//  .filters(java.util.List<FiltersProperty)
//  .filters(IResolvable>)
//  .hpcClusterId(java.lang.String)
//  .hpcClusterId(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .innerIpAddresses(IResolvable)
//  .innerIpAddresses(java.util.List<java.lang.String)
//  .innerIpAddresses(IResolvable>)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .instanceIds(IResolvable)
//  .instanceIds(java.util.List<java.lang.String)
//  .instanceIds(IResolvable>)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .instanceNetworkType(java.lang.String)
//  .instanceNetworkType(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .instanceTypeFamily(java.lang.String)
//  .instanceTypeFamily(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .ioOptimized(java.lang.Boolean)
//  .ioOptimized(IResolvable)
//  .ipv6Address(IResolvable)
//  .ipv6Address(java.util.List<java.lang.String)
//  .ipv6Address(IResolvable>)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .privateIpAddresses(IResolvable)
//  .privateIpAddresses(java.util.List<java.lang.String)
//  .privateIpAddresses(IResolvable>)
//  .publicIpAddresses(IResolvable)
//  .publicIpAddresses(java.util.List<java.lang.String)
//  .publicIpAddresses(IResolvable>)
//  .rdmaIpAddresses(java.lang.String)
//  .rdmaIpAddresses(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
additionalAttributes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property additionalAttributes: The value of attribute N.
eipAddresses com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property eipAddresses: The elastic IP addresses (EIPs) of instances.
filters com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property filters: Filter value when querying resources.
hpcClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hpcClusterId: The ID of the High Performance Computing (HPC) cluster to which the instance belongs.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: The ID of the image.
innerIpAddresses com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property innerIpAddresses: The internal IP addresses of instances located in the classic network.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The billing method of the instance.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The IDs of instances.
instanceIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property instanceIds: The IDs of instances.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the instance.
instanceNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceNetworkType: The network type of the instance.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The instance type of the instance.
instanceTypeFamily java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceTypeFamily: The instance family of the instance.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: The billing method for network usage.
ioOptimized java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property ioOptimized: Specifies whether the instance is I\/O optimized.
ipv6Address com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property ipv6Address: IPv6 address N of the elastic network interface (ENI).
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPairName: The name of the SSH key pair bound to the instance.
privateIpAddresses com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property privateIpAddresses: The private IP addresses of instances located in VPCs.
publicIpAddresses com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property publicIpAddresses: The public IP addresses of instances.
rdmaIpAddresses java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rdmaIpAddresses: The Remote Direct Memory Access (RDMA) IP addresses of HPC instances.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the instance belongs.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: The ID of the security group to which the instance belongs.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The state of the instance.
tags java.util.List Property tags: Tags of instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC).
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the instance.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

additionalAttributesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property filters: Filter value when querying resources.

hpcClusterIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

imageIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: The ID of the image.

innerIpAddressesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: The billing method of the instance.

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

instanceIdOptional

  • Type: java.lang.String OR com.aliyun.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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The name of the instance.

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

instanceNetworkTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceNetworkType: The network type of the instance.

Valid values: classic: classic network vpc: VPC

instanceTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: The instance type of the instance.

instanceTypeFamilyOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceTypeFamily: The instance family of the instance.

internetChargeTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property internetChargeType: The billing method for network usage.

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

ioOptimizedOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

ipv6AddressOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

privateIpAddressesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

statusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: The state of the instance.

Valid values: Pending Running Starting Stopping Stopped

tagsOptional

  • Type: java.util.List

Property tags: Tags of instance.

vpcIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the vSwitch.

zoneIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone ID of the instance.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecs.datasource.Instances;
Instances.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrInstanceIds com.aliyun.ros.cdk.core.IResolvable Attribute InstanceIds: The list of InstanceIds.
attrInstances com.aliyun.ros.cdk.core.IResolvable Attribute Instances: The list of Instances.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrInstanceIdsRequired 

public IResolvable getAttrInstanceIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceIds: The list of InstanceIds.

attrInstancesRequired 

public IResolvable getAttrInstances();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Instances: The list of Instances.