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 CPU options for Amazon EC2 instances in the Amazon EC2 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 Enable stop protection for your EC2 instances in the Amazon EC2 User Guide.

Type: Boolean

Required: No

DisableApiTermination

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

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

Deprecated.

Note

Amazon Elastic Graphics reached end of life on January 8, 2024.

Type: Array of ElasticGpuSpecification objects

Required: No

ElasticInferenceAccelerators

Note

Amazon Elastic Inference is no longer available.

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.

Type: Array of LaunchTemplateElasticInferenceAccelerator objects

Required: No

EnclaveOptions

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is 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 Amazon EC2 instance in the Amazon EC2 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 in the format ami-0ac394d6a3example.

Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.

To reference a public parameter:

resolve:ssm:public-parameter

To reference a parameter stored in the same account:

resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label

To reference a parameter shared from another AWS account:

resolve:ssm:parameter-ARN
resolve:ssm:parameter-ARN:version-number
resolve:ssm:parameter-ARN:label

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

Note

If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:

Only EC2 Fleets of type instant support specifying a Systems Manager parameter.
For EC2 Fleets of type maintain or request, or for Spot Fleets, you must specify the AMI ID.

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 Specify attributes for instance type selection for EC2 Fleet or 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 Amazon EC2 instance types in the Amazon EC2 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 Linux 2 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 Configure the Instance Metadata Service options in the Amazon EC2 User Guide.

Type: LaunchTemplateInstanceMetadataOptionsRequest object

Required: No

Monitoring

The monitoring for the instance.

Type: LaunchTemplatesMonitoringRequest object

Required: No

NetworkInterfaces

The network interfaces for the instance.

Type: Array of LaunchTemplateInstanceNetworkInterfaceSpecificationRequest objects

Required: No

NetworkPerformanceOptions

Contains launch template settings to boost network performance for the type of workload that runs on your instance.

Type: LaunchTemplateNetworkPerformanceOptionsRequest object

Required: No

Operator

The entity that manages the launch template.

Type: OperatorRequest object

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 EC2 User Guide.

Type: String

Required: No

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.

Type: Array of strings

Required: No

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.

Type: Array of strings

Required: No

TagSpecifications

The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

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 when you launch an EC2 instance with user data input in the Amazon EC2 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

Note

Important

Important

Important

See Also