Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Instance, which is used to create Edge Node Service (ENS) instances.

Initializers

import com.aliyun.ros.cdk.ens.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dataDiskSize(java.lang.Number)
    .dataDiskSize(IResolvable)
    .ensRegionId(java.lang.String)
    .ensRegionId(IResolvable)
    .imageId(java.lang.String)
    .imageId(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .period(java.lang.Number)
    .period(IResolvable)
    .quantity(java.lang.Number)
    .quantity(IResolvable)
    .systemDiskSize(java.lang.Number)
    .systemDiskSize(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .ipType(java.lang.String)
//  .ipType(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .uniqueSuffix(java.lang.Boolean)
//  .uniqueSuffix(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dataDiskSize^Required

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

Property dataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

ensRegionId^Required

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

Property ensRegionId: ENS Region Id.

imageId^Required

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

Property imageId: Image ID to create ens instance.

instanceType^Required

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

Property instanceType: ENS instance supported instance type, make sure it should be correct.

period^Required

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

Property period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.

quantity^Required

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

Property quantity: number of instances to create.

systemDiskSize^Required

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

Property systemDiskSize: Disk size of the system disk.

autoRenew^Optional

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

Property autoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

autoRenewPeriod^Optional

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

Property autoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

hostName^Optional

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

Property hostName: The hostname of the instance.

instanceName^Optional

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

Property instanceName: Instance name.

internetChargeType^Optional

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

Property internetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

ipType^Optional

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

Property ipType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

keyPairName^Optional

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

Property keyPairName: SSH key pair name.

password^Optional

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

Property password: Password of created ens instance.

Must contain at least 3 types of special character, lower character, upper character, number.

paymentType^Optional

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

Property paymentType: Payment Type.only support value Subscription.

privateIpAddress^Optional

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

Property privateIpAddress: Private IP for the instance created.

uniqueSuffix^Optional

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

Property uniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

userData^Optional

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

Property userData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

vSwitchId^Optional

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

Property vSwitchId: The vSwitch Id to create ens instance.

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

attrAutoRenew^Required

public java.lang.Object getAttrAutoRenew();

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

Attribute AutoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

attrAutoRenewPeriod^Required

public java.lang.Object getAttrAutoRenewPeriod();

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

Attribute AutoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

attrDataDiskSize^Required

public java.lang.Object getAttrDataDiskSize();

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

Attribute DataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

attrEnsRegionId^Required

public java.lang.Object getAttrEnsRegionId();

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

Attribute EnsRegionId: ENS Region Id.

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.

attrImageId^Required

public java.lang.Object getAttrImageId();

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

Attribute ImageId: Image ID to create ens instance.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: InstanceId.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: Instance name.

attrInstanceType^Required

public java.lang.Object getAttrInstanceType();

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

Attribute InstanceType: ENS instance supported instance type, make sure it should be correct.

attrInternetChargeType^Required

public java.lang.Object getAttrInternetChargeType();

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

Attribute InternetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

attrIpType^Required

public java.lang.Object getAttrIpType();

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

Attribute IpType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

attrKeyPairName^Required

public java.lang.Object getAttrKeyPairName();

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

Attribute KeyPairName: SSH key pair name.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: Payment Type.only support value Subscription.

attrPeriod^Required

public java.lang.Object getAttrPeriod();

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

Attribute Period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.

attrPrivateIpAddress^Required

public java.lang.Object getAttrPrivateIpAddress();

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

Attribute PrivateIpAddress: Private IP for the instance created.

attrPrivateIps^Required

public java.lang.Object getAttrPrivateIps();

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

Attribute PrivateIps: Private IP.

attrPublicIps^Required

public java.lang.Object getAttrPublicIps();

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

Attribute PublicIps: Public IP.

attrQuantity^Required

public java.lang.Object getAttrQuantity();

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

Attribute Quantity: number of instances to create.

attrSystemDiskSize^Required

public java.lang.Object getAttrSystemDiskSize();

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

Attribute SystemDiskSize: Disk size of the system disk.

attrUniqueSuffix^Required

public java.lang.Object getAttrUniqueSuffix();

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

Attribute UniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

attrUserData^Required

public java.lang.Object getAttrUserData();

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

Attribute UserData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

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

Attribute VSwitchId: The vSwitch Id to create ens instance.

props^Required

public InstanceProps getProps();

• Type: InstanceProps