Skip to content

InstancesProps

Properties for defining a Instances.

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

Initializer 

import com.aliyun.ros.cdk.ecs.datasource.InstancesProps;
InstancesProps.builder()
//  .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();

Properties

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

additionalAttributesOptional 

public java.lang.Object getAdditionalAttributes();
  • 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 

public java.lang.Object getEipAddresses();
  • 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 

public java.lang.Object getFilters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property filters: Filter value when querying resources.

hpcClusterIdOptional 

public java.lang.Object getHpcClusterId();
  • 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 

public java.lang.Object getImageId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: The ID of the image.

innerIpAddressesOptional 

public java.lang.Object getInnerIpAddresses();
  • 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 

public java.lang.Object getInstanceChargeType();
  • 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 

public java.lang.Object getInstanceId();
  • 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 

public java.lang.Object getInstanceIds();
  • 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 

public java.lang.Object getInstanceName();
  • 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 

public java.lang.Object getInstanceNetworkType();
  • 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 

public java.lang.Object getInstanceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: The instance type of the instance.

instanceTypeFamilyOptional 

public java.lang.Object getInstanceTypeFamily();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceTypeFamily: The instance family of the instance.

internetChargeTypeOptional 

public java.lang.Object getInternetChargeType();
  • 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 

public java.lang.Object getIoOptimized();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

ipv6AddressOptional 

public java.lang.Object getIpv6Address();
  • 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 

public java.lang.Object getKeyPairName();
  • 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 

public java.lang.Object getPrivateIpAddresses();
  • 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 

public java.lang.Object getPublicIpAddresses();
  • 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 

public java.lang.Object getRdmaIpAddresses();
  • 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 

public java.lang.Object getRefreshOptions();
  • 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 

public java.lang.Object getResourceGroupId();
  • 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 

public java.lang.Object getSecurityGroupId();
  • 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 

public java.lang.Object getStatus();
  • 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 

public java.util.List<TagsProperty> getTags();
  • Type: java.util.List

Property tags: Tags of instance.

vpcIdOptional 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the vSwitch.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone ID of the instance.