Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

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

Properties

Name Type Description
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: Ecs instance supported instance type, make sure it should be correct.
affinity string | @alicloud/ros-cdk-core.IResolvable Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.
allocatePublicIp boolean | @alicloud/ros-cdk-core.IResolvable Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.
autoRenew string | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Whether renew the fee automatically?
autoRenewPeriod number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: The time period of auto renew.
creditSpecification string | @alicloud/ros-cdk-core.IResolvable Property creditSpecification: The performance mode of the burstable instance.
dedicatedHostId string | @alicloud/ros-cdk-core.IResolvable Property dedicatedHostId: which dedicated host will be deployed.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
deploymentSetGroupNo number | @alicloud/ros-cdk-core.IResolvable Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.
deploymentSetId string | @alicloud/ros-cdk-core.IResolvable Property deploymentSetId: Deployment set ID.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the instance, [2, 256] characters.
diskMappings @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DiskMappingsProperty[] Property diskMappings: Disk mappings to attach to instance.
hostName string | @alicloud/ros-cdk-core.IResolvable Property hostName: Host name of created ecs instance.
hpcClusterId string | @alicloud/ros-cdk-core.IResolvable Property hpcClusterId: The HPC cluster ID to which the instance belongs.
httpEndpoint string | @alicloud/ros-cdk-core.IResolvable Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.
httpTokens string | @alicloud/ros-cdk-core.IResolvable Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
imageFamily string | @alicloud/ros-cdk-core.IResolvable Property imageFamily: The name of the image family.
imageId string | @alicloud/ros-cdk-core.IResolvable Property imageId: Image ID to create ecs instance.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.
internetMaxBandwidthOut number | @alicloud/ros-cdk-core.IResolvable Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
ioOptimized string | @alicloud/ros-cdk-core.IResolvable Property ioOptimized: The 'optimized' instance can provide better IO performance.
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 ecs instance.
passwordInherit boolean | @alicloud/ros-cdk-core.IResolvable Property passwordInherit: Specifies whether to use the password preset in the image.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: Private IP for the instance created.
privatePoolOptions @alicloud/ros-cdk-core.IResolvable | PrivatePoolOptionsProperty Property privatePoolOptions: The options of the private pool.
ramRoleName string | @alicloud/ros-cdk-core.IResolvable Property ramRoleName: Instance RAM role name.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
securityEnhancementStrategy string | @alicloud/ros-cdk-core.IResolvable Property securityEnhancementStrategy:.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: Security group to create ecs instance.
securityGroupIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property securityGroupIds: The ID list of security group to which to assign the instance.
spotDuration number | @alicloud/ros-cdk-core.IResolvable Property spotDuration: The protection period of the preemptible instance.
spotInterruptionBehavior string | @alicloud/ros-cdk-core.IResolvable Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
spotPriceLimit string | @alicloud/ros-cdk-core.IResolvable Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
spotStrategy string | @alicloud/ros-cdk-core.IResolvable Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
storageSetId string | @alicloud/ros-cdk-core.IResolvable Property storageSetId: The storage set ID.
storageSetPartitionNumber number | @alicloud/ros-cdk-core.IResolvable Property storageSetPartitionNumber: The maximum number of partitions in the storage set.
systemDiskCategory string | @alicloud/ros-cdk-core.IResolvable Property systemDiskCategory: Category of system disk.
systemDiskDescription string | @alicloud/ros-cdk-core.IResolvable Property systemDiskDescription: Description of created system disk.
systemDiskDiskName string | @alicloud/ros-cdk-core.IResolvable Property systemDiskDiskName: Name of created system disk.
systemDiskPerformanceLevel string | @alicloud/ros-cdk-core.IResolvable Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.
systemDiskSize number | @alicloud/ros-cdk-core.IResolvable Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
tags TagsProperty[] Property tags: Tags to attach to instance.
tenancy string | @alicloud/ros-cdk-core.IResolvable Property tenancy: Specifies whether to create the instance on a dedicated host.
useAdditionalService boolean | @alicloud/ros-cdk-core.IResolvable Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.
userData string | @alicloud/ros-cdk-core.IResolvable Property userData: User data to pass to instance.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC id to create ecs instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch Id to create ecs instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone to which the instance belongs.
zoneIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property zoneIds: Zone ids for query parameters.

instanceTypeRequired

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

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


affinityOptional

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

Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.

Valid values: - default: does not associate the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient. - host: associates the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot start. Default value: default.


allocatePublicIpOptional

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

Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.

If property InternetMaxBandwidthOut set to 0, it will not assign public ip.


autoRenewOptional

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

Property autoRenew: Whether renew the fee automatically?

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal.False: no automatic renewal. Default value is False.


autoRenewPeriodOptional

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

Property autoRenewPeriod: The time period of auto renew.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.


creditSpecificationOptional

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

Property creditSpecification: The performance mode of the burstable instance.

Valid values: - Standard: the standard mode. - Unlimited: the unlimited mode.


dedicatedHostIdOptional

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

Property dedicatedHostId: which dedicated host will be deployed.


deletionProtectionOptional

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

Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.


deploymentSetGroupNoOptional

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

Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.

If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. Valid values: 1 to 7.


deploymentSetIdOptional

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

Property deploymentSetId: Deployment set ID.


descriptionOptional

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

Property description: Description of the instance, [2, 256] characters.

Do not fill or empty, the default is empty.


diskMappingsOptional

public readonly diskMappings: IResolvable | IResolvable | DiskMappingsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DiskMappingsProperty[]

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks. If the image contains a data disk, you can specify other parameters of the data disk via the same value of parameter "Device". If parameter "Category" is not specified, it will be cloud_efficiency instead of "Category" of data disk in the image.


hostNameOptional

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

Property hostName: Host name of created ecs instance.

at least 2 characters, and '.' '-' Is not the first and last characters as hostname, not continuous use. Windows platform can be up to 15 characters, allowing letters (without limiting case), numbers and '-', and does not support the number of points, not all is digital ('.').Other (Linux, etc.) platform up to 64 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components.


hpcClusterIdOptional

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

Property hpcClusterId: The HPC cluster ID to which the instance belongs.


httpEndpointOptional

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

Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.

Valid values: - enabled - disabled Default value: enabled.


httpTokensOptional

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

Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.

Valid values: - optional: does not forcefully use the security-enhanced mode (IMDSv2). - required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode. Default value: optional.


imageFamilyOptional

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

Property imageFamily: The name of the image family.

You can set this parameter to obtain the latest available custom image from the specified image family to create the instance. - ImageFamily must be empty if ImageId is specified. - ImageFamily can be specified if ImageId is not specified.


imageIdOptional

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

Property imageId: Image ID to create ecs instance.


instanceChargeTypeOptional

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

Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.

If specified Prepaid, please ensure you have sufficient balance in your account. Or instance creation will be failure. Default value is Postpaid.


instanceNameOptional

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

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.


internetChargeTypeOptional

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

Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.


internetMaxBandwidthOutOptional

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

Property internetMaxBandwidthOut: Set internet output bandwidth of instance.

Unit is Mbps(Mega bit per second). Range is [0,200]. Default is 1.While the property is not 0, public ip will be assigned for instance.


ioOptimizedOptional

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

Property ioOptimized: The 'optimized' instance can provide better IO performance.

Support 'none' and 'optimized' only, default is 'optimized'.


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 ecs instance.

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


passwordInheritOptional

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

Property passwordInherit: Specifies whether to use the password preset in the image.

To use the PasswordInherit parameter, the Password parameter must be empty and you must make sure that the selected image has a password configured.


periodOptional

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, 24, 36, 48, 60. Default value is 1.


periodUnitOptional

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

Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.

Default value is Month.


privateIpAddressOptional

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

Property privateIpAddress: Private IP for the instance created.

Only works for VPC instance and cannot duplicated with existing instance.


privatePoolOptionsOptional

public readonly privatePoolOptions: IResolvable | PrivatePoolOptionsProperty;

Property privatePoolOptions: The options of the private pool.


ramRoleNameOptional

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

Property ramRoleName: Instance RAM role name.

The name is provided and maintained by Resource Access Management (RAM) and can be queried using ListRoles. For more information, see RAM API CreateRole and ListRoles.


resourceGroupIdOptional

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

Property resourceGroupId: Resource group id.


securityEnhancementStrategyOptional

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

Property securityEnhancementStrategy:.


securityGroupIdOptional

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

Property securityGroupId: Security group to create ecs instance.

For classic instance need the security group not belong to VPC, for VPC instance, please make sure the security group belong to specified VPC.


securityGroupIdsOptional

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

Property securityGroupIds: The ID list of security group to which to assign the instance.

The max length is based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in Limits.


spotDurationOptional

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

Property spotDuration: The protection period of the preemptible instance.

Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6. Protection periods of 2, 3, 4, 5, and 6 hours are in invitational preview. If you want to set this parameter to one of these values, submit a ticket. If this parameter is set to 0, no protection period is configured for the preemptible instance. Default value: 1.


spotInterruptionBehaviorOptional

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

Property spotInterruptionBehavior: The interruption mode of the preemptible instance.

Default value: Terminate. Set the value to Terminate, which specifies to release the instance.


spotPriceLimitOptional

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

Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Three decimals is allowed at most.


spotStrategyOptional

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

Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Value range: "NoSpot: A regular Pay-As-You-Go instance", "SpotWithPriceLimit: A price threshold for a spot instance, ""SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance. "Default value: NoSpot.


storageSetIdOptional

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

Property storageSetId: The storage set ID.


storageSetPartitionNumberOptional

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

Property storageSetPartitionNumber: The maximum number of partitions in the storage set.

The value must be greater than or equal to 2.


systemDiskCategoryOptional

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

Property systemDiskCategory: Category of system disk.

Default is cloud_efficiency. support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd|cloud_auto|cloud_essd_entry


systemDiskDescriptionOptional

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

Property systemDiskDescription: Description of created system disk.


systemDiskDiskNameOptional

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

Property systemDiskDiskName: Name of created system disk.


systemDiskPerformanceLevelOptional

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

Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.


systemDiskSizeOptional

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

Property systemDiskSize: 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.


tagsOptional

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


tenancyOptional

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

Property tenancy: Specifies whether to create the instance on a dedicated host.

Valid values: - default: creates the instance on a non-dedicated host. - host: creates the instance on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud selects a dedicated host for the instance. Default value: default.


useAdditionalServiceOptional

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

Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.

System configurations for Windows: NTP and KMS. System configurations for Linux: NTP and YUM.


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.


vpcIdOptional

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

Property vpcId: The VPC id to create ecs instance.


vSwitchIdOptional

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

Property vSwitchId: The vSwitch Id to create ecs instance.


zoneIdOptional

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

Property zoneId: The ID of the zone to which the instance belongs.

For more information, call the DescribeZones operation to query the most recent zone list. Default value is empty, which means random selection.


zoneIdsOptional

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

Property zoneIds: Zone ids for query parameters.