Instance

• Implements: com.aliyun.ros.cdk.ecs.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Instance.

Initializers

import com.aliyun.ros.cdk.ecs.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceId^Required

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

Property instanceId: Instance ID.

refreshOptions^Optional

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

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrActionOnMaintenance^Required

public java.lang.Object getAttrActionOnMaintenance();

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

Attribute ActionOnMaintenance: The O&M action attribute of the instance.

attrAutoRebootTime^Required

public java.lang.Object getAttrAutoRebootTime();

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

Attribute AutoRebootTime: Automatic reboot time after instance configuration change.

attrAutoReleaseTime^Required

public java.lang.Object getAttrAutoReleaseTime();

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

Attribute AutoReleaseTime: The time when to automatically release the pay-as-you-go instance.

attrAutoRenewEnabled^Required

public java.lang.Object getAttrAutoRenewEnabled();

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

Attribute AutoRenewEnabled: Whether automatic renewal has been set.

attrClusterId^Required

public java.lang.Object getAttrClusterId();

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

Attribute ClusterId: The ID of the cluster to which the instance belongs.

attrCpu^Required

public java.lang.Object getAttrCpu();

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

Attribute Cpu: The number of vCPUs.

attrCpuOptions^Required

public java.lang.Object getAttrCpuOptions();

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

Attribute CpuOptions: Details about the CPU options.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The create time.

attrCreditSpecification^Required

public java.lang.Object getAttrCreditSpecification();

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

Attribute CreditSpecification: The performance mode of the burstable instance.

attrDedicatedHostAttribute^Required

public java.lang.Object getAttrDedicatedHostAttribute();

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

Attribute DedicatedHostAttribute: Details about the dedicated host.

It is an array that consists of the DedicatedHostClusterId, DedicatedHostId, and DedicatedHostName parameters.

attrDedicatedInstanceAttribute^Required

public java.lang.Object getAttrDedicatedInstanceAttribute();

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

Attribute DedicatedInstanceAttribute: The attributes of the instance on the dedicated host.

attrDeletionProtection^Required

public java.lang.Object getAttrDeletionProtection();

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

Attribute DeletionProtection: The release protection attribute of the instance.

This parameter indicates whether you can use the ECS console or call the DeleteInstance operation to release the instance.

attrDeploymentSetGroupNo^Required

public java.lang.Object getAttrDeploymentSetGroupNo();

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

Attribute DeploymentSetGroupNo: The number of the deployment set group to which the instance belongs in a deployment set.

attrDeploymentSetId^Required

public java.lang.Object getAttrDeploymentSetId();

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

Attribute DeploymentSetId: The ID of the deployment set in which the instance is deployed.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The description of the instance.

attrDeviceAvailable^Required

public java.lang.Object getAttrDeviceAvailable();

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

Attribute DeviceAvailable: Indicates whether data disks can be attached to the instance.

attrDuration^Required

public java.lang.Object getAttrDuration();

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

Attribute Duration: The duration of automatic renewal.

attrEcsCapacityReservationAttr^Required

public java.lang.Object getAttrEcsCapacityReservationAttr();

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

Attribute EcsCapacityReservationAttr: Details about the capacity reservation related to the instance.

attrEipAddress^Required

public java.lang.Object getAttrEipAddress();

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

Attribute EipAddress: Details about the EIP associated with the instance.

attrExpiredTime^Required

public java.lang.Object getAttrExpiredTime();

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

Attribute ExpiredTime: The time when the instance expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attrGpuAmount^Required

public java.lang.Object getAttrGpuAmount();

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

Attribute GpuAmount: The number of GPUs for the instance type.

attrGpuSpec^Required

public java.lang.Object getAttrGpuSpec();

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

Attribute GpuSpec: The category of GPUs for the instance type.

attrHostName^Required

public java.lang.Object getAttrHostName();

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

Attribute HostName: The hostname of the instance.

attrHpcClusterId^Required

public java.lang.Object getAttrHpcClusterId();

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

Attribute HpcClusterId: ID of the HPC cluster to which the instance belongs.

attrImageId^Required

public java.lang.Object getAttrImageId();

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

Attribute ImageId: The ID of the image.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: The name of the instance.

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

attrInstanceNetworkType^Required

public java.lang.Object getAttrInstanceNetworkType();

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

Attribute InstanceNetworkType: The network type of the instance.

attrInstanceType^Required

public java.lang.Object getAttrInstanceType();

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

Attribute InstanceType: The instance type of the instance.

attrInstanceTypeFamily^Required

public java.lang.Object getAttrInstanceTypeFamily();

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

Attribute InstanceTypeFamily: The instance family of the instance.

attrInternetChargeType^Required

public java.lang.Object getAttrInternetChargeType();

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

Attribute InternetChargeType: The billing method for network usage.

attrInternetMaxBandwidthIn^Required

public java.lang.Object getAttrInternetMaxBandwidthIn();

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

Attribute InternetMaxBandwidthIn: The maximum inbound public bandwidth.

Unit: Mbit/s.

attrInternetMaxBandwidthOut^Required

public java.lang.Object getAttrInternetMaxBandwidthOut();

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

Attribute InternetMaxBandwidthOut: The maximum outbound public bandwidth.

Unit: Mbit/s.

attrIoOptimized^Required

public java.lang.Object getAttrIoOptimized();

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

Attribute IoOptimized: Specifies whether the instance is I/O optimized.

attrKeyPairName^Required

public java.lang.Object getAttrKeyPairName();

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

Attribute KeyPairName: The name of the SSH key pair bound to the instance.

attrLocalStorageAmount^Required

public java.lang.Object getAttrLocalStorageAmount();

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

Attribute LocalStorageAmount: The number of local disks attached to the instance.

attrLocalStorageCapacity^Required

public java.lang.Object getAttrLocalStorageCapacity();

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

Attribute LocalStorageCapacity: The capacity of local disks attached to the instance.

attrMaintenanceWindows^Required

public java.lang.Object getAttrMaintenanceWindows();

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

Attribute MaintenanceWindows: The list of operations window instances.

attrMemory^Required

public java.lang.Object getAttrMemory();

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

Attribute Memory: The memory size of the instance.

Unit: MiB.

attrMetadataOptions^Required

public java.lang.Object getAttrMetadataOptions();

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

Attribute MetadataOptions: Details about the metadata options.

attrNetworkInterfaces^Required

public java.lang.Object getAttrNetworkInterfaces();

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

Attribute NetworkInterfaces: Details about the ENIs bound to the instance.

attrNotifyOnMaintenance^Required

public java.lang.Object getAttrNotifyOnMaintenance();

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

Attribute NotifyOnMaintenance: Whether to send an event notification before the instance goes down.

attrOperationLocks^Required

public java.lang.Object getAttrOperationLocks();

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

Attribute OperationLocks: The reasons why the instance was locked.

attrOsName^Required

public java.lang.Object getAttrOsName();

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

Attribute OsName: The name of the operating system of the instance.

attrOsNameEn^Required

public java.lang.Object getAttrOsNameEn();

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

Attribute OsNameEn: The English name of the operating system of the instance.

attrOsType^Required

public java.lang.Object getAttrOsType();

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

Attribute OsType: The type of the operating system of the instance.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: The billing method of the instance.

attrPeriodUnit^Required

public java.lang.Object getAttrPeriodUnit();

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

Attribute PeriodUnit: Renewal unit.

attrPrivatePoolOptionsId^Required

public java.lang.Object getAttrPrivatePoolOptionsId();

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

Attribute PrivatePoolOptionsId: Private pool ID.

When the return value is open, the private pool ID is the private pool ID assigned when the system automatically matches.

attrPrivatePoolOptionsMatchCriteria^Required

public java.lang.Object getAttrPrivatePoolOptionsMatchCriteria();

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

Attribute PrivatePoolOptionsMatchCriteria: The private pool matching pattern of the instance.

attrPublicIpAddress^Required

public java.lang.Object getAttrPublicIpAddress();

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

Attribute PublicIpAddress: The public IP addresses of the instance.

attrRdmaIpAddress^Required

public java.lang.Object getAttrRdmaIpAddress();

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

Attribute RdmaIpAddress: The RDMA network IP of the HPC instance.

attrRecyclable^Required

public java.lang.Object getAttrRecyclable();

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

Attribute Recyclable: Indicates whether the instance can be recycled.

attrRenewalStatus^Required

public java.lang.Object getAttrRenewalStatus();

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

Attribute RenewalStatus: The automatic renewal status of the instance.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

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

attrSaleCycle^Required

public java.lang.Object getAttrSaleCycle();

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

Attribute SaleCycle: Instance billing cycles.

attrSecurityGroupIds^Required

public java.lang.Object getAttrSecurityGroupIds();

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

Attribute SecurityGroupIds: The IDs of the security groups to which the instance belongs.

attrSerialNumber^Required

public java.lang.Object getAttrSerialNumber();

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

Attribute SerialNumber: The serial number of the instance.

attrSpotDuration^Required

public java.lang.Object getAttrSpotDuration();

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

Attribute SpotDuration: The protection period of the preemptible instance.

Unit: hours.

attrSpotPriceLimit^Required

public java.lang.Object getAttrSpotPriceLimit();

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

Attribute SpotPriceLimit: The maximum hourly price of the instance.

It can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

attrSpotStrategy^Required

public java.lang.Object getAttrSpotStrategy();

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

Attribute SpotStrategy: The bidding policy for the pay-as-you-go instance.

attrStartTime^Required

public java.lang.Object getAttrStartTime();

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

Attribute StartTime: The time when the instance was last started.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attrStoppedMode^Required

public java.lang.Object getAttrStoppedMode();

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

Attribute StoppedMode: Indicates whether the instance continues to be billed after it is stopped.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: The tags of the instance.

attrUserData^Required

public java.lang.Object getAttrUserData();

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

Attribute UserData: The custom data of the instance.

attrVpcAttributes^Required

public java.lang.Object getAttrVpcAttributes();

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

Attribute VpcAttributes: The VPC attributes of the instance.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

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

Attribute ZoneId: The zone ID of the instance.

props^Required

public InstanceProps getProps();

• Type: InstanceProps