Skip to content

LaunchTemplateProps

Properties for defining a LaunchTemplate.

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

Initializer 

import com.aliyun.ros.cdk.ecs.LaunchTemplateProps;
LaunchTemplateProps.builder()
    .launchTemplateName(java.lang.String)
    .launchTemplateName(IResolvable)
//  .autoReleaseTime(java.lang.String)
//  .autoReleaseTime(IResolvable)
//  .deploymentSetId(java.lang.String)
//  .deploymentSetId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskMappings(IResolvable)
//  .diskMappings(java.util.List<IResolvable)
//  .diskMappings(DiskMappingsProperty>)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .imageOwnerAlias(java.lang.String)
//  .imageOwnerAlias(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .ioOptimized(java.lang.String)
//  .ioOptimized(IResolvable)
//  .ipv6AddressCount(java.lang.Number)
//  .ipv6AddressCount(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .networkInterfaces(IResolvable)
//  .networkInterfaces(java.util.List<IResolvable)
//  .networkInterfaces(NetworkInterfacesProperty>)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityEnhancementStrategy(java.lang.String)
//  .securityEnhancementStrategy(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .spotDuration(java.lang.Number)
//  .spotDuration(IResolvable)
//  .spotPriceLimit(java.lang.String)
//  .spotPriceLimit(IResolvable)
//  .spotStrategy(java.lang.String)
//  .spotStrategy(IResolvable)
//  .systemDiskCategory(java.lang.String)
//  .systemDiskCategory(IResolvable)
//  .systemDiskDeleteWithInstance(java.lang.Boolean)
//  .systemDiskDeleteWithInstance(IResolvable)
//  .systemDiskDescription(java.lang.String)
//  .systemDiskDescription(IResolvable)
//  .systemDiskDiskName(java.lang.String)
//  .systemDiskDiskName(IResolvable)
//  .systemDiskPerformanceLevel(java.lang.String)
//  .systemDiskPerformanceLevel(IResolvable)
//  .systemDiskSize(java.lang.Number)
//  .systemDiskSize(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .templateResourceGroupId(java.lang.String)
//  .templateResourceGroupId(IResolvable)
//  .templateTags(IResolvable)
//  .templateTags(java.util.List<IResolvable)
//  .templateTags(TemplateTagsProperty>)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .versionDescription(java.lang.String)
//  .versionDescription(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
launchTemplateName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateName: The name of launch template.
autoReleaseTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
deploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property deploymentSetId: The ID of the deployment set.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the instance, [2, 256] characters.
diskMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty> Property diskMappings: Disk mappings to attach to instance.
hostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hostName: Host name of created ecs instance.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: Image ID to create ecs instance.
imageOwnerAlias java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageOwnerAlias: The source of the image.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The billing method of the instance.
instanceName java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: Ecs instance supported instance type, make sure it should be correct.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property internetMaxBandwidthOut: Max internet out bandwidth in Mbps(Mega bit per second).
ioOptimized java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ioOptimized: The 'optimized' instance can provide better IO performance.
ipv6AddressCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ipv6AddressCount: The number of IPv6 addresses to be randomly generated for the primary ENI.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPairName: SSH key pair name.
networkInterfaces com.aliyun.ros.cdk.core.IResolvable OR java.util.ListNetworkInterfacesProperty> Property networkInterfaces: Elastic network interfaces to be attached to instance.
networkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkType: Instance network type.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property passwordInherit: Specifies whether to use the password preset in the image.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the instance.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: The private IP address of the instance.
ramRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ramRoleName: Instance RAM role name.
resourceGroupId java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityEnhancementStrategy: Activate or deactivate security enhancement,Value range: "Active" and "Deactive".
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: Security group to create ecs instance.
securityGroupIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityGroupIds: The ID of security group list to which to assign the instance.
spotDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property spotDuration: The protection period of the preemptible instance.
spotPriceLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
spotStrategy java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskCategory: Category of system disk.
systemDiskDeleteWithInstance java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskDeleteWithInstance: Specifies whether to release the system disk when the instance is released.
systemDiskDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskDescription: Description of created system disk.
systemDiskDiskName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskDiskName: Name of created system disk.
systemDiskPerformanceLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskPerformanceLevel: The performance level of the ESSD that is used as the system disk.
systemDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance, security group, disk and network interface.
templateResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateResourceGroupId: The ID of the resource group to which to assign the launch template.
templateTags com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTemplateTagsProperty> Property templateTags: Template tags to attach to launch template.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userData: User data to pass to instance.
versionDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property versionDescription: Description for version 1 of launch template.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch Id to create ecs instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: Current zone to create the instance.

launchTemplateNameRequired 

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

Property launchTemplateName: The name of launch template.

autoReleaseTimeOptional 

public java.lang.Object getAutoReleaseTime();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDeploymentSetId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property deploymentSetId: The ID of the deployment set.

descriptionOptional 

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

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

diskMappingsOptional 

public java.lang.Object getDiskMappings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty>

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks.

hostNameOptional 

public java.lang.Object getHostName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getImageId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: Image ID to create ecs instance.

imageOwnerAliasOptional 

public java.lang.Object getImageOwnerAlias();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInstanceName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInstanceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

internetChargeTypeOptional 

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

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

internetMaxBandwidthOutOptional 

public java.lang.Object getInternetMaxBandwidthOut();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getIoOptimized();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Support 'none' and 'optimized' only.

ipv6AddressCountOptional 

public java.lang.Object getIpv6AddressCount();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getKeyPairName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property keyPairName: SSH key pair name.

networkInterfacesOptional 

public java.lang.Object getNetworkInterfaces();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListNetworkInterfacesProperty>

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

networkTypeOptional 

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

Property networkType: Instance network type.

Support 'vpc' and 'classic'

passwordInheritOptional 

public java.lang.Object getPasswordInherit();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPrivateIpAddress();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRamRoleName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityEnhancementStrategy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

securityGroupIdOptional 

public java.lang.Object getSecurityGroupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityGroupIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

spotDurationOptional 

public java.lang.Object getSpotDuration();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getSpotPriceLimit();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSpotStrategy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSystemDiskCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskCategory: Category of system disk.

support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd

systemDiskDeleteWithInstanceOptional 

public java.lang.Object getSystemDiskDeleteWithInstance();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getSystemDiskDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskDescription: Description of created system disk.

systemDiskDiskNameOptional 

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

Property systemDiskDiskName: Name of created system disk.

systemDiskPerformanceLevelOptional 

public java.lang.Object getSystemDiskPerformanceLevel();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSystemDiskSize();
  • Type: java.lang.Number OR com.aliyun.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 java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to instance, security group, disk and network interface.

templateResourceGroupIdOptional 

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

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

templateTagsOptional 

public java.lang.Object getTemplateTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTemplateTagsProperty>

Property templateTags: Template tags to attach to launch template.

userDataOptional 

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

Property userData: User data to pass to instance.

[1, 16KB] characters.

versionDescriptionOptional 

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

Property versionDescription: Description for version 1 of launch template.

vSwitchIdOptional 

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

Property vSwitchId: The vSwitch Id to create ecs instance.

zoneIdOptional 

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

Property zoneId: Current zone to create the instance.