AWS::EC2::LaunchTemplate LaunchTemplateData

The information to include in the launch template.

Note

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "BlockDeviceMappings" : [ BlockDeviceMapping, ... ],
  "CapacityReservationSpecification" : CapacityReservationSpecification,
  "CpuOptions" : CpuOptions,
  "CreditSpecification" : CreditSpecification,
  "DisableApiStop" : Boolean,
  "DisableApiTermination" : Boolean,
  "EbsOptimized" : Boolean,
  "ElasticGpuSpecifications" : [ ElasticGpuSpecification, ... ],
  "ElasticInferenceAccelerators" : [ LaunchTemplateElasticInferenceAccelerator, ... ],
  "EnclaveOptions" : EnclaveOptions,
  "HibernationOptions" : HibernationOptions,
  "IamInstanceProfile" : IamInstanceProfile,
  "ImageId" : String,
  "InstanceInitiatedShutdownBehavior" : String,
  "InstanceMarketOptions" : InstanceMarketOptions,
  "InstanceRequirements" : InstanceRequirements,
  "InstanceType" : String,
  "KernelId" : String,
  "KeyName" : String,
  "LicenseSpecifications" : [ LicenseSpecification, ... ],
  "MaintenanceOptions" : MaintenanceOptions,
  "MetadataOptions" : MetadataOptions,
  "Monitoring" : Monitoring,
  "NetworkInterfaces" : [ NetworkInterface, ... ],
  "Placement" : Placement,
  "PrivateDnsNameOptions" : PrivateDnsNameOptions,
  "RamDiskId" : String,
  "SecurityGroupIds" : [ String, ... ],
  "SecurityGroups" : [ String, ... ],
  "TagSpecifications" : [ TagSpecification, ... ],
  "UserData" : String
}

YAML


  BlockDeviceMappings: 
    - BlockDeviceMapping
  CapacityReservationSpecification: 
    CapacityReservationSpecification
  CpuOptions: 
    CpuOptions
  CreditSpecification: 
    CreditSpecification
  DisableApiStop: Boolean
  DisableApiTermination: Boolean
  EbsOptimized: Boolean
  ElasticGpuSpecifications: 
    - ElasticGpuSpecification
  ElasticInferenceAccelerators: 
    - LaunchTemplateElasticInferenceAccelerator
  EnclaveOptions: 
    EnclaveOptions
  HibernationOptions: 
    HibernationOptions
  IamInstanceProfile: 
    IamInstanceProfile
  ImageId: String
  InstanceInitiatedShutdownBehavior: String
  InstanceMarketOptions: 
    InstanceMarketOptions
  InstanceRequirements: 
    InstanceRequirements
  InstanceType: String
  KernelId: String
  KeyName: String
  LicenseSpecifications: 
    - LicenseSpecification
  MaintenanceOptions: 
    MaintenanceOptions
  MetadataOptions: 
    MetadataOptions
  Monitoring: 
    Monitoring
  NetworkInterfaces: 
    - NetworkInterface
  Placement: 
    Placement
  PrivateDnsNameOptions: 
    PrivateDnsNameOptions
  RamDiskId: String
  SecurityGroupIds: 
    - String
  SecurityGroups: 
    - String
  TagSpecifications: 
    - TagSpecification
  UserData: String

Properties

BlockDeviceMappings

The block device mapping.

Required: No

Type: Array of BlockDeviceMapping

Update requires: No interruption

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).

Required: No

Type: CapacityReservationSpecification

Update requires: No interruption

CpuOptions

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

Required: No

Type: CpuOptions

Update requires: No interruption

CreditSpecification

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

Required: No

Type: CreditSpecification

Update requires: No interruption

DisableApiStop

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

ElasticGpuSpecifications

Deprecated.

Note

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.

Required: No

Type: Array of ElasticGpuSpecification

Update requires: No interruption

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.

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.

Required: No

Type: Array of LaunchTemplateElasticInferenceAccelerator

Update requires: No interruption

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.

Required: No

Type: EnclaveOptions

Update requires: No interruption

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.

Required: No

Type: HibernationOptions

Update requires: No interruption

IamInstanceProfile

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

Required: No

Type: IamInstanceProfile

Update requires: No interruption

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-0ac394d6a3example
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label

For more information, see Use a Systems Manager parameter to find an AMI in the Amazon Elastic Compute Cloud User Guide.

Required: No

Type: String

Update requires: No interruption

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

Required: No

Type: String

Allowed values: stop | terminate

Update requires: No interruption

InstanceMarketOptions

The market (purchasing) option for the instances.

Required: No

Type: InstanceMarketOptions

Update requires: No interruption

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.

Required: No

Type: InstanceRequirements

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

LicenseSpecifications

The license configurations.

Required: No

Type: Array of LicenseSpecification

Update requires: No interruption

MaintenanceOptions

The maintenance options of your instance.

Required: No

Type: MaintenanceOptions

Update requires: No interruption

MetadataOptions

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

Required: No

Type: MetadataOptions

Update requires: No interruption

Monitoring

The monitoring for the instance.

Required: No

Type: Monitoring

Update requires: No interruption

NetworkInterfaces

The network interfaces for the instance.

Required: No

Type: Array of NetworkInterface

Update requires: No interruption

Placement

The placement for the instance.

Required: No

Type: Placement

Update requires: No interruption

PrivateDnsNameOptions

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

Required: No

Type: PrivateDnsNameOptions

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

SecurityGroupIds

The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.

If you specify a network interface, you must specify any security groups as part of the network interface instead.

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: Array of String

Update requires: No interruption

TagSpecifications

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

To tag the launch template itself, use TagSpecifications.

Required: No

Type: Array of TagSpecification

Update requires: No interruption

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 Amazon EC2 instance at launch 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.

Required: No

Type: String

Update requires: No interruption

AWS::EC2::LaunchTemplate LaunchTemplateData

Note

Syntax

JSON

YAML

Properties

Note

Note

Note

Note

Important

Important

See also