Skip to content

LaunchTemplateProps

Properties for defining a LaunchTemplate.

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

Initializer 

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

Properties

Name Type Description
launchTemplateName string | @alicloud/ros-cdk-core.IResolvable Property launchTemplateName: The name of launch template.
autoReleaseTime string | @alicloud/ros-cdk-core.IResolvable Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
deploymentSetId string | @alicloud/ros-cdk-core.IResolvable Property deploymentSetId: The ID of the deployment set.
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.
imageId string | @alicloud/ros-cdk-core.IResolvable Property imageId: Image ID to create ecs instance.
imageOwnerAlias string | @alicloud/ros-cdk-core.IResolvable Property imageOwnerAlias: The source of the image.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: The billing method of the instance.
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 '.', '-'.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: Ecs instance supported instance type, make sure it should be correct.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only.
internetMaxBandwidthOut number | @alicloud/ros-cdk-core.IResolvable Property internetMaxBandwidthOut: Max internet out bandwidth in Mbps(Mega bit per second).
ioOptimized string | @alicloud/ros-cdk-core.IResolvable Property ioOptimized: The 'optimized' instance can provide better IO performance.
ipv6AddressCount number | @alicloud/ros-cdk-core.IResolvable Property ipv6AddressCount: The number of IPv6 addresses to be randomly generated for the primary ENI.
keyPairName string | @alicloud/ros-cdk-core.IResolvable Property keyPairName: SSH key pair name.
networkInterfaces @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | NetworkInterfacesProperty[] Property networkInterfaces: Elastic network interfaces to be attached to instance.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: Instance network type.
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: The subscription period of the instance.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: The private IP address of the instance.
ramRoleName string | @alicloud/ros-cdk-core.IResolvable Property ramRoleName: Instance RAM role name.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which to assign the instance, Elastic Block Storage (EBS) device, and elastic network interface (ENI).
securityEnhancementStrategy string | @alicloud/ros-cdk-core.IResolvable Property securityEnhancementStrategy: Activate or deactivate security enhancement,Value range: "Active" and "Deactive".
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 of security group list to which to assign the instance.
spotDuration number | @alicloud/ros-cdk-core.IResolvable Property spotDuration: The protection period 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.
systemDiskCategory string | @alicloud/ros-cdk-core.IResolvable Property systemDiskCategory: Category of system disk.
systemDiskDeleteWithInstance boolean | @alicloud/ros-cdk-core.IResolvable Property systemDiskDeleteWithInstance: Specifies whether to release the system disk when the instance is released.
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 ESSD that is used as the system disk.
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, security group, disk and network interface.
templateResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property templateResourceGroupId: The ID of the resource group to which to assign the launch template.
templateTags @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TemplateTagsProperty[] Property templateTags: Template tags to attach to launch template.
userData string | @alicloud/ros-cdk-core.IResolvable Property userData: User data to pass to instance.
versionDescription string | @alicloud/ros-cdk-core.IResolvable Property versionDescription: Description for version 1 of launch template.
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: Current zone to create the instance.

launchTemplateNameRequired 

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

Property launchTemplateName: The name of launch template.

autoReleaseTimeOptional 

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

Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.

format is 'yyyy-MM-ddTHH:mm:ssZ'. Not bigger than 3 years from this day onwards

deploymentSetIdOptional 

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

Property deploymentSetId: The ID of the deployment set.

descriptionOptional 

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

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

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.

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 30 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components.

imageIdOptional 

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

Property imageId: Image ID to create ecs instance.

imageOwnerAliasOptional 

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

Property imageOwnerAlias: The source of the image.

Valid values: system: public images provided by Alibaba Cloud. self: your custom images. others: shared images from other Alibaba Cloud accounts. marketplace: Alibaba Cloud Marketplace images. If Alibaba Cloud Marketplace images are found, you can use these images without prior subscription. You must pay attention to the billing details of Alibaba Cloud Marketplace images.

instanceChargeTypeOptional 

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

Property instanceChargeType: The billing method of the instance.

Valid values: PrePaid: subscription. If you set this parameter to PrePaid, make sure that your account supports payment by credit. Otherwise, an InvalidPayMethod error is returned. PostPaid: pay-as-you-go.

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 '.', '-'.

instanceTypeOptional 

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.

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.

internetMaxBandwidthOutOptional 

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

Property internetMaxBandwidthOut: Max internet out bandwidth in Mbps(Mega bit per second).

Range is [0,200].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.

ipv6AddressCountOptional 

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

Property ipv6AddressCount: The number of IPv6 addresses to be randomly generated for the primary ENI.

Valid values: 1 to 10.

keyPairNameOptional 

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

Property keyPairName: SSH key pair name.

networkInterfacesOptional 

public readonly networkInterfaces: IResolvable | IResolvable | NetworkInterfacesProperty[];

Property networkInterfaces: Elastic network interfaces to be attached to instance.

networkTypeOptional 

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

Property networkType: Instance network type.

Support 'vpc' and 'classic'

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.

Note When you use this parameter, leave Password empty and make sure that the selected image has a password preset.

periodOptional 

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

Property period: The subscription period of the instance.

Unit: months. This parameter is valid and required only when InstanceChargeType is set to PrePaid. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.

privateIpAddressOptional 

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

Property privateIpAddress: The private IP address of the instance.

To assign a private IP address to an instance of the VPC type, make sure that the IP address is an idle IP address within the CIDR block of the vSwitch specified by the VSwitchId parameter.

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: The ID of the resource group to which to assign the instance, Elastic Block Storage (EBS) device, and elastic network interface (ENI).

securityEnhancementStrategyOptional 

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

Property securityEnhancementStrategy: Activate or deactivate security enhancement,Value range: "Active" and "Deactive".

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 of security group list to which to assign the instance.

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.

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

systemDiskCategoryOptional 

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

Property systemDiskCategory: Category of system disk.

support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd

systemDiskDeleteWithInstanceOptional 

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

Property systemDiskDeleteWithInstance: Specifies whether to release the system disk when the instance is released.

Valid values: true: releases the system disk when the instance is released. false: does not release the system disk when the instance is released. Default value: true.

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 ESSD that is used as the system disk.

Valid values: PL0: A single ESSD can deliver up to 10,000 random read\/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read\/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read\/write IOPS. PL3: A single ESSD can deliver 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, security group, disk and network interface.

templateResourceGroupIdOptional 

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

Property templateResourceGroupId: The ID of the resource group to which to assign the launch template.

templateTagsOptional 

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

Property templateTags: Template tags to attach to launch template.

userDataOptional 

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

Property userData: User data to pass to instance.

[1, 16KB] characters.

versionDescriptionOptional 

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

Property versionDescription: Description for version 1 of launch template.

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: Current zone to create the instance.