AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
public class RequestLaunchTemplateData
The RequestLaunchTemplateData type exposes the following members
Name | Description | |
---|---|---|
RequestLaunchTemplateData() |
Name | Type | Description | |
---|---|---|---|
BlockDeviceMappings | System.Collections.Generic.List<Amazon.EC2.Model.LaunchTemplateBlockDeviceMappingRequest> |
Gets and sets the property BlockDeviceMappings. The block device mapping. |
|
CapacityReservationSpecification | Amazon.EC2.Model.LaunchTemplateCapacityReservationSpecificationRequest |
Gets and sets the property CapacityReservationSpecification.
The Capacity Reservation targeting option. If you do not specify this parameter, the
instance's Capacity Reservation preference defaults to |
|
CpuOptions | Amazon.EC2.Model.LaunchTemplateCpuOptionsRequest |
Gets and sets the property CpuOptions. The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide. |
|
CreditSpecification | Amazon.EC2.Model.CreditSpecificationRequest |
Gets and sets the property CreditSpecification. The credit option for CPU usage of the instance. Valid only for T instances. |
|
DisableApiStop | System.Boolean |
Gets and sets the property DisableApiStop. Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide. |
|
DisableApiTermination | System.Boolean |
Gets and sets the property DisableApiTermination.
If you set this parameter to |
|
EbsOptimized | System.Boolean |
Gets and sets the property EbsOptimized. Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. |
|
ElasticGpuSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.ElasticGpuSpecification> |
Gets and sets the property ElasticGpuSpecifications. Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. |
|
ElasticInferenceAccelerators | System.Collections.Generic.List<Amazon.EC2.Model.LaunchTemplateElasticInferenceAccelerator> |
Gets and sets the property ElasticInferenceAccelerators. An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. |
|
EnclaveOptions | Amazon.EC2.Model.LaunchTemplateEnclaveOptionsRequest |
Gets and sets the property EnclaveOptions. Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance. |
|
HibernationOptions | Amazon.EC2.Model.LaunchTemplateHibernationOptionsRequest |
Gets and sets the property HibernationOptions. Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide. |
|
IamInstanceProfile | Amazon.EC2.Model.LaunchTemplateIamInstanceProfileSpecificationRequest |
Gets and sets the property IamInstanceProfile. The name or Amazon Resource Name (ARN) of an IAM instance profile. |
|
ImageId | System.String |
Gets and sets the property ImageId. The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch. Valid formats:
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID. For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide. |
|
InstanceInitiatedShutdownBehavior | Amazon.EC2.ShutdownBehavior |
Gets and sets the property InstanceInitiatedShutdownBehavior. Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: |
|
InstanceMarketOptions | Amazon.EC2.Model.LaunchTemplateInstanceMarketOptionsRequest |
Gets and sets the property InstanceMarketOptions. The market (purchasing) option for the instances. |
|
InstanceRequirements | Amazon.EC2.Model.InstanceRequirementsRequest |
Gets and sets the property InstanceRequirements. The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
If you specify
Attribute-based instance type selection is only supported when using Auto Scaling
groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch
template in the launch
instance wizard, or with the RunInstances
API or AWS::EC2::Instance
Amazon Web Services CloudFormation resource, you can't specify For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide. |
|
InstanceType | Amazon.EC2.InstanceType |
Gets and sets the property InstanceType. The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify |
|
KernelId | System.String |
Gets and sets the property KernelId. The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide. |
|
KeyName | System.String |
Gets and sets the property KeyName. The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. |
|
LicenseSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.LaunchTemplateLicenseConfigurationRequest> |
Gets and sets the property LicenseSpecifications. The license configurations. |
|
MaintenanceOptions | Amazon.EC2.Model.LaunchTemplateInstanceMaintenanceOptionsRequest |
Gets and sets the property MaintenanceOptions. The maintenance options for the instance. |
|
MetadataOptions | Amazon.EC2.Model.LaunchTemplateInstanceMetadataOptionsRequest |
Gets and sets the property MetadataOptions. The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide. |
|
Monitoring | Amazon.EC2.Model.LaunchTemplatesMonitoringRequest |
Gets and sets the property Monitoring. The monitoring for the instance. |
|
NetworkInterfaces | System.Collections.Generic.List<Amazon.EC2.Model.LaunchTemplateInstanceNetworkInterfaceSpecificationRequest> |
Gets and sets the property NetworkInterfaces. The network interfaces for the instance. |
|
Placement | Amazon.EC2.Model.LaunchTemplatePlacementRequest |
Gets and sets the property Placement. The placement for the instance. |
|
PrivateDnsNameOptions | Amazon.EC2.Model.LaunchTemplatePrivateDnsNameOptionsRequest |
Gets and sets the property PrivateDnsNameOptions. The options for the instance hostname. The default values are inherited from the subnet. |
|
RamDiskId | System.String |
Gets and sets the property RamDiskId. The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide. |
|
SecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property SecurityGroupIds. The IDs of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. |
|
SecurityGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property SecurityGroups. The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. |
|
TagSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.LaunchTemplateTagSpecificationRequest> |
Gets and sets the property TagSpecifications. The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template. |
|
UserData | System.String |
Gets and sets the property UserData. The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide. If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5