Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ens-instance

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-ens'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
dataDiskSize number | @alicloud/ros-cdk-core.IResolvable Property dataDiskSize: Disk size of the system disk, range from 20 to 500 GB.
ensRegionId string | @alicloud/ros-cdk-core.IResolvable Property ensRegionId: ENS Region Id.
imageId string | @alicloud/ros-cdk-core.IResolvable Property imageId: Image ID to create ens instance.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: ENS instance supported instance type, make sure it should be correct.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.
quantity number | @alicloud/ros-cdk-core.IResolvable Property quantity: number of instances to create.
systemDiskSize number | @alicloud/ros-cdk-core.IResolvable Property systemDiskSize: Disk size of the system disk.
autoRenew string | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.
autoRenewPeriod number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: The time period of auto renew.
hostName string | @alicloud/ros-cdk-core.IResolvable Property hostName: The hostname of the instance.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: Instance name.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.
ipType string | @alicloud/ros-cdk-core.IResolvable Property ipType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.
keyPairName string | @alicloud/ros-cdk-core.IResolvable Property keyPairName: SSH key pair name.
password string | @alicloud/ros-cdk-core.IResolvable Property password: Password of created ens instance.
paymentType string | @alicloud/ros-cdk-core.IResolvable Property paymentType: Payment Type.only support value Subscription.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: Private IP for the instance created.
uniqueSuffix boolean | @alicloud/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.
userData string | @alicloud/ros-cdk-core.IResolvable Property userData: User data to pass to instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch Id to create ens instance.

dataDiskSizeRequired 

public readonly dataDiskSize: number | IResolvable;
  • Type: number | @alicloud/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.

ensRegionIdRequired 

public readonly ensRegionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ensRegionId: ENS Region Id.

imageIdRequired 

public readonly imageId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property imageId: Image ID to create ens instance.

instanceTypeRequired 

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

periodRequired 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/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.

quantityRequired 

public readonly quantity: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property quantity: number of instances to create.

systemDiskSizeRequired 

public readonly systemDiskSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property systemDiskSize: Disk size of the system disk.

autoRenewOptional 

public readonly autoRenew: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

autoRenewPeriodOptional 

public readonly autoRenewPeriod: number | IResolvable;
  • Type: number | @alicloud/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.

hostNameOptional 

public readonly hostName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property hostName: The hostname of the instance.

instanceNameOptional 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: Instance name.

internetChargeTypeOptional 

public readonly internetChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

ipTypeOptional 

public readonly ipType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

keyPairNameOptional 

public readonly keyPairName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keyPairName: SSH key pair name.

passwordOptional 

public readonly password: string | IResolvable;
  • Type: string | @alicloud/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.

paymentTypeOptional 

public readonly paymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property paymentType: Payment Type.only support value Subscription.

privateIpAddressOptional 

public readonly privateIpAddress: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property privateIpAddress: Private IP for the instance created.

uniqueSuffixOptional 

public readonly uniqueSuffix: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

userDataOptional 

public readonly userData: string | IResolvable;
  • Type: string | @alicloud/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.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch Id to create ens instance.