Skip to content

Instance

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

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

Initializers

import com.aliyun.ros.cdk.ens.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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the instance.
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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceIdRequired

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

Property instanceId: The ID of the instance.


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.

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.ens.datasource.Instance;
Instance.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrDataDisk java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DataDisk: Data disk specifications.
attrEnsRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnsRegionId: The node ID.
attrHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HostName: The hostname of the instance.
attrImageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ImageId: The ID of the image.
attrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the instance.
attrInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: The instance name.
attrInstanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: The specification of the instance.
attrInternetMaxBandwidthOut java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.
attrNetworkId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NetworkId: The ID of the network.
attrPaymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: Instance payment method.
attrPrivateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrivateIpAddress: The private IP address.
attrSecurityId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SecurityId: ID of the security group to which the instance belongs.
attrSystemDisk java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SystemDisk: System Disk Specification.
attrVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the instance belongs.
props InstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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

attrDataDiskRequired

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

Attribute DataDisk: Data disk specifications.


attrEnsRegionIdRequired

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

Attribute EnsRegionId: The node ID.

When ScheduleAreaLevel is Region, EnsRegionId is required. When ScheduleAreaLevel is Big,Middle,Small, EnsRegionId is invalid.


attrHostNameRequired

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

Attribute HostName: The hostname of the instance.


attrImageIdRequired

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

Attribute ImageId: The ID of the image.


attrInstanceIdRequired

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

Attribute InstanceId: The ID of the instance.


attrInstanceNameRequired

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

Attribute InstanceName: The instance name.

Example value: test-InstanceName. It must be 2 to 128 characters in length and must start with an uppercase or lowercase letter or a Chinese character. It cannot start with http:// or https. Can contain Chinese, English, numbers, half-width colons (:), underscores (_), periods (.


attrInstanceTypeRequired

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

Attribute InstanceType: The specification of the instance.

Example value: ens.sn1.


attrInternetMaxBandwidthOutRequired

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

Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.

The field type is Long, and the precision may be lost during serialization/deserialization.


attrNetworkIdRequired

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

Attribute NetworkId: The ID of the network.


attrPaymentTypeRequired

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

Attribute PaymentType: Instance payment method.


attrPrivateIpAddressRequired

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

Attribute PrivateIpAddress: The private IP address.

Can only be used for node-level scheduling. If a private IP address is specified, the number of instances can only be one, and both the private IP address and the vSwitch ID are not empty, the private IP address takes effect.


attrSecurityIdRequired

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

Attribute SecurityId: ID of the security group to which the instance belongs.


attrSystemDiskRequired

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

Attribute SystemDisk: System Disk Specification.

SystemDisk is a non-required parameter when InstanceType is x86_pm,x86_bmi,x86_bm,pc_bmi, or arm_bmi. SystemDisk is a required parameter when instanceType is other specification families.


attrVSwitchIdRequired

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

Attribute VSwitchId: The ID of the vSwitch to which the instance belongs.


propsRequired

public InstanceProps getProps();