RequestLaunchTemplateData

The information to include in the launch template.

Note

You must specify at least one parameter for the launch template data.

BlockDeviceMappings

The block device mapping.

Type: Array of LaunchTemplateBlockDeviceMappingRequest objects

Required: No

CapacityReservationSpecification

The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

Type: LaunchTemplateCapacityReservationSpecificationRequest object

Required: No

CpuOptions

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Type: LaunchTemplateCpuOptionsRequest object

Required: No

CreditSpecification

The credit option for CPU usage of the instance. Valid only for T instances.

Type: CreditSpecificationRequest object

Required: No

DisableApiStop

Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.

Type: Boolean

Required: No

DisableApiTermination

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Type: Boolean

Required: No

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.

Type: Boolean

Required: No

ElasticGpuSpecifications

An elastic GPU to associate with the instance.

Type: Array of ElasticGpuSpecification objects

Required: No

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.

Note

Starting April 15, 2023, AWS 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.

Type: Array of LaunchTemplateElasticInferenceAccelerator objects

Required: No

EnclaveOptions

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.

You can't enable AWS Nitro Enclaves and hibernation on the same instance.

Type: LaunchTemplateEnclaveOptionsRequest object

Required: No

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.

Type: LaunchTemplateHibernationOptionsRequest object

Required: No

IamInstanceProfile

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Type: LaunchTemplateIamInstanceProfileSpecificationRequest object

Required: No

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:

ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter

Note

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.

Type: String

Required: No

InstanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

Type: String

Valid Values: stop | terminate

Required: No

InstanceMarketOptions

The market (purchasing) option for the instances.

Type: LaunchTemplateInstanceMarketOptionsRequest object

Required: No

InstanceRequirements

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

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:

AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

Note

If you specify InstanceRequirements, you can't specify InstanceType.

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 AWS CloudFormation resource, you can't specify InstanceRequirements.

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.

Type: InstanceRequirementsRequest object

Required: No

InstanceType

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

If you specify InstanceType, you can't specify InstanceRequirements.

Type: String

Required: No

KernelId

The ID of the kernel.

Important

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.

Type: String

Required: No

KeyName

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

Important

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.

Type: String

Required: No

LicenseSpecifications

The license configurations.

Type: Array of LaunchTemplateLicenseConfigurationRequest objects

Required: No

MaintenanceOptions

The maintenance options for the instance.

Type: LaunchTemplateInstanceMaintenanceOptionsRequest object

Required: No

MetadataOptions

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

Type: LaunchTemplateInstanceMetadataOptionsRequest object

Required: No

Monitoring

The monitoring for the instance.

Type: LaunchTemplatesMonitoringRequest object

Required: No

NetworkInterfaces

One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Type: Array of LaunchTemplateInstanceNetworkInterfaceSpecificationRequest objects

Required: No

Placement

The placement for the instance.

Type: LaunchTemplatePlacementRequest object

Required: No

PrivateDnsNameOptions

The options for the instance hostname. The default values are inherited from the subnet.

Type: LaunchTemplatePrivateDnsNameOptionsRequest object

Required: No

RamDiskId

The ID of the RAM disk.

Important

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.

Type: String

Required: No

SecurityGroups

One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Type: Array of strings

Required: No

SecurityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Type: Array of strings

Required: No

TagSpecifications

The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces

To tag a resource after it has been created, see CreateTags.

Note

To tag the launch template itself, you must use the TagSpecification parameter.

Type: Array of LaunchTemplateTagSpecificationRequest objects

Required: No

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 AWS 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 AWS Batch User Guide.

Type: String

Required: No

RequestLaunchTemplateData

Note

Contents

Note

Note

Note

Important

Important

Important

Note

See Also