public class CreateLaunchTemplateVersionRequest extends AbstractModel
header, skipSign| Constructor and Description |
|---|
CreateLaunchTemplateVersionRequest() |
CreateLaunchTemplateVersionRequest(CreateLaunchTemplateVersionRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
| Modifier and Type | Method and Description |
|---|---|
ActionTimer |
getActionTimer()
Get Scheduled tasks.
|
String |
getCamRoleName()
Get CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1) API.
|
String |
getClientToken()
Get A unique string supplied by the client to ensure that the request is idempotent.
|
DataDisk[] |
getDataDisks()
Get The configuration information of instance data disks.
|
Boolean |
getDisableApiTermination()
Get Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API.
|
String[] |
getDisasterRecoverGroupIds()
Get Placement group ID.
|
Boolean |
getDryRun()
Get Whether the request is a dry run only.
|
EnhancedService |
getEnhancedService()
Get Enhanced service.
|
String |
getHostName()
Get Hostname of Cloud Virtual Machine.
Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively. Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits. Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section. |
String |
getHpcClusterId()
Get HPC cluster ID.
|
String |
getImageId()
Get Assign an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format like `img-xxx`.
|
InstanceChargePrepaid |
getInstanceChargePrepaid()
Get Details of the monthly subscription, including the purchase period, auto-renewal.
|
String |
getInstanceChargeType()
Get Instance [billing mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).
PREPAID: prepaid, that is, monthly subscription.POSTPAID_BY_HOUR: pay-as-you-go by hour.CDHPAID: CDH instance (created based on CDH; the resources of the host are free of charge).SPOTPAID: spot payment.Default value: POSTPAID_BY_HOUR. |
Long |
getInstanceCount()
Get Number of instances to be purchased.
|
InstanceMarketOptionsRequest |
getInstanceMarketOptions()
Get Market options of the instance, such as parameters related to spot instances.
|
String |
getInstanceName()
Get Instance display name.
|
String |
getInstanceType()
Get Instance model.
|
InternetAccessible |
getInternetAccessible()
Get Configuration of public network bandwidth.
|
String |
getLaunchTemplateId()
Get Instance launch template ID.
|
Long |
getLaunchTemplateVersion()
Get This parameter, when specified, is used to create instance launch templates.
|
String |
getLaunchTemplateVersionDescription()
Get Description of instance launch template versions.
|
LoginSettings |
getLoginSettings()
Get Instance login settings.
|
Metadata |
getMetadata()
Get Custom metadata.
|
Placement |
getPlacement()
Get Location of the instance.
|
String[] |
getSecurityGroupIds()
Get Security groups to which the instance belongs.
|
SystemDisk |
getSystemDisk()
Get System disk configuration of the instance.
|
TagSpecification[] |
getTagSpecification()
Get The tag description list.
|
String |
getTemplateDataModifyAction()
Get Specifies that only the Update and Replace parameters are allowed.
|
String |
getUserData()
Get User data provided to the instance.
|
VirtualPrivateCloud |
getVirtualPrivateCloud()
Get Configuration information of VPC.
|
void |
setActionTimer(ActionTimer ActionTimer)
Set Scheduled tasks.
|
void |
setCamRoleName(String CamRoleName)
Set CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1) API.
|
void |
setClientToken(String ClientToken)
Set A unique string supplied by the client to ensure that the request is idempotent.
|
void |
setDataDisks(DataDisk[] DataDisks)
Set The configuration information of instance data disks.
|
void |
setDisableApiTermination(Boolean DisableApiTermination)
Set Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API.
|
void |
setDisasterRecoverGroupIds(String[] DisasterRecoverGroupIds)
Set Placement group ID.
|
void |
setDryRun(Boolean DryRun)
Set Whether the request is a dry run only.
|
void |
setEnhancedService(EnhancedService EnhancedService)
Set Enhanced service.
|
void |
setHostName(String HostName)
Set Hostname of Cloud Virtual Machine.
Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively. Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits. Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section. |
void |
setHpcClusterId(String HpcClusterId)
Set HPC cluster ID.
|
void |
setImageId(String ImageId)
Set Assign an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format like `img-xxx`.
|
void |
setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)
Set Details of the monthly subscription, including the purchase period, auto-renewal.
|
void |
setInstanceChargeType(String InstanceChargeType)
Set Instance [billing mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).
PREPAID: prepaid, that is, monthly subscription.POSTPAID_BY_HOUR: pay-as-you-go by hour.CDHPAID: CDH instance (created based on CDH; the resources of the host are free of charge).SPOTPAID: spot payment.Default value: POSTPAID_BY_HOUR. |
void |
setInstanceCount(Long InstanceCount)
Set Number of instances to be purchased.
|
void |
setInstanceMarketOptions(InstanceMarketOptionsRequest InstanceMarketOptions)
Set Market options of the instance, such as parameters related to spot instances.
|
void |
setInstanceName(String InstanceName)
Set Instance display name.
|
void |
setInstanceType(String InstanceType)
Set Instance model.
|
void |
setInternetAccessible(InternetAccessible InternetAccessible)
Set Configuration of public network bandwidth.
|
void |
setLaunchTemplateId(String LaunchTemplateId)
Set Instance launch template ID.
|
void |
setLaunchTemplateVersion(Long LaunchTemplateVersion)
Set This parameter, when specified, is used to create instance launch templates.
|
void |
setLaunchTemplateVersionDescription(String LaunchTemplateVersionDescription)
Set Description of instance launch template versions.
|
void |
setLoginSettings(LoginSettings LoginSettings)
Set Instance login settings.
|
void |
setMetadata(Metadata Metadata)
Set Custom metadata.
|
void |
setPlacement(Placement Placement)
Set Location of the instance.
|
void |
setSecurityGroupIds(String[] SecurityGroupIds)
Set Security groups to which the instance belongs.
|
void |
setSystemDisk(SystemDisk SystemDisk)
Set System disk configuration of the instance.
|
void |
setTagSpecification(TagSpecification[] TagSpecification)
Set The tag description list.
|
void |
setTemplateDataModifyAction(String TemplateDataModifyAction)
Set Specifies that only the Update and Replace parameters are allowed.
|
void |
setUserData(String UserData)
Set User data provided to the instance.
|
void |
setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
Set Configuration information of VPC.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic CreateLaunchTemplateVersionRequest()
public CreateLaunchTemplateVersionRequest(CreateLaunchTemplateVersionRequest source)
public Placement getPlacement()
public void setPlacement(Placement Placement)
Placement - Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH (for dedicated CVMs)public String getLaunchTemplateId()
public void setLaunchTemplateId(String LaunchTemplateId)
LaunchTemplateId - Instance launch template ID. This parameter is used as a basis for creating new template versions.public Long getLaunchTemplateVersion()
public void setLaunchTemplateVersion(Long LaunchTemplateVersion)
LaunchTemplateVersion - This parameter, when specified, is used to create instance launch templates. If this parameter is not specified, the default version will be used.public String getLaunchTemplateVersionDescription()
public void setLaunchTemplateVersionDescription(String LaunchTemplateVersionDescription)
LaunchTemplateVersionDescription - Description of instance launch template versions. This parameter can contain 2-256 characters.public String getInstanceType()
public void setInstanceType(String InstanceType)
InstanceType - Instance model. Different instance models specify different resource specifications.
public String getImageId()
public void setImageId(String ImageId)
ImageId - Assign an effective [mirror](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format like `img-xxx`. there are four image types: public SystemDisk getSystemDisk()
public void setSystemDisk(SystemDisk SystemDisk)
SystemDisk - System disk configuration of the instance. If this parameter is not specified, the default value will be used.public DataDisk[] getDataDisks()
public void setDataDisks(DataDisk[] DataDisks)
DataDisks - The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD data disks.public VirtualPrivateCloud getVirtualPrivateCloud()
public void setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
VirtualPrivateCloud - Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20.public InternetAccessible getInternetAccessible()
public void setInternetAccessible(InternetAccessible InternetAccessible)
InternetAccessible - Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default.public Long getInstanceCount()
public void setInstanceCount(Long InstanceCount)
InstanceCount - Number of instances to be purchased. Value range for monthly-subscribed instances: [1, 300]. Value range for pay-as-you-go instances: [1, 100]. Default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on quota, see CVM instance [Purchase Limits](https://intl.cloud.tencent.com/document/product/213/2664).public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName - Instance display name. public LoginSettings getLoginSettings()
public void setLoginSettings(LoginSettings LoginSettings)
LoginSettings - Instance login settings. you can use this parameter to set the instance's login method to key or keep the original login settings of the image.public String[] getSecurityGroupIds()
public void setSecurityGroupIds(String[] SecurityGroupIds)
SecurityGroupIds - Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response. If this parameter is not specified, the instance will be associated with default security groups.public EnhancedService getEnhancedService()
public void setEnhancedService(EnhancedService EnhancedService)
EnhancedService - Enhanced service. this parameter can be used to specify whether to enable services such as cloud security and cloud monitoring. if this parameter is not specified, cloud monitor and cloud security services are enabled for public images by default; for custom images and marketplace images, cloud monitor and cloud security services are not enabled by default, and the services retained in the image will be used.public String getClientToken()
public void setClientToken(String ClientToken)
ClientToken - A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.public String getHostName()
public void setHostName(String HostName)
HostName - Hostname of Cloud Virtual Machine.public ActionTimer getActionTimer()
public void setActionTimer(ActionTimer ActionTimer)
ActionTimer - Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.public String[] getDisasterRecoverGroupIds()
public void setDisasterRecoverGroupIds(String[] DisasterRecoverGroupIds)
DisasterRecoverGroupIds - Placement group ID. You can only specify one.public TagSpecification[] getTagSpecification()
public void setTagSpecification(TagSpecification[] TagSpecification)
TagSpecification - The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances.public InstanceMarketOptionsRequest getInstanceMarketOptions()
public void setInstanceMarketOptions(InstanceMarketOptionsRequest InstanceMarketOptions)
InstanceMarketOptions - Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances.public String getUserData()
public void setUserData(String UserData)
UserData - User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for [Windows](https://intl.cloud.tencent.com/document/product/213/17526) or [Linux](https://intl.cloud.tencent.com/document/product/213/17525).public Boolean getDryRun()
public void setDryRun(Boolean DryRun)
DryRun - Whether the request is a dry run only.
`true`: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
If the dry run fails, the corresponding error code will be returned.
If the dry run succeeds, the RequestId will be returned.
`false` (default value): send a normal request and create instance(s) if all the requirements are met.public String getCamRoleName()
public void setCamRoleName(String CamRoleName)
CamRoleName - CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/36223?from_cn_redirect=1) API.public String getHpcClusterId()
public void setHpcClusterId(String HpcClusterId)
HpcClusterId - HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance.public String getInstanceChargeType()
public void setInstanceChargeType(String InstanceChargeType)
InstanceChargeType - Instance [billing mode](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).public InstanceChargePrepaid getInstanceChargePrepaid()
public void setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)
InstanceChargePrepaid - Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the `InstanceChargeType` is `PREPAID`.public Boolean getDisableApiTermination()
public void setDisableApiTermination(Boolean DisableApiTermination)
DisableApiTermination - Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values:public Metadata getMetadata()
public void setMetadata(Metadata Metadata)
Metadata - Custom metadata. specifies that custom metadata key-value pairs can be added when creating a CVM.
Note: this field is in beta test.public String getTemplateDataModifyAction()
public void setTemplateDataModifyAction(String TemplateDataModifyAction)
TemplateDataModifyAction - Specifies that only the Update and Replace parameters are allowed. this parameter is valid only when custom Metadata is used in the template and Metadata is also transmitted in RunInstances. defaults to Replace.
-Update: if template t contains this parameter with a value of Update and metadata=[k1:v1, k2:v2], then RunInstances (with metadata=[k2:v3]) + t creates a cvm using metadata=[k1:v1, k2:v3].
-Replace: if the template t contains this parameter with a value of Replace and metadata=[k1:v1, k2:v2], then when creating a cvm using RunInstances (with metadata=[k2:v3]) + t, the created cvm will use metadata=[k2:v3].
Note: this field is in beta test.Copyright © 2025. All rights reserved.