AWS::EC2::LaunchTemplate LaunchTemplateData
The information to include in the launch template.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BlockDeviceMappings" :
[ BlockDeviceMapping, ... ]
, "CapacityReservationSpecification" :CapacityReservationSpecification
, "CpuOptions" :CpuOptions
, "CreditSpecification" :CreditSpecification
, "DisableApiTermination" :Boolean
, "EbsOptimized" :Boolean
, "ElasticGpuSpecifications" :[ ElasticGpuSpecification, ... ]
, "ElasticInferenceAccelerators" :[ LaunchTemplateElasticInferenceAccelerator, ... ]
, "EnclaveOptions" :EnclaveOptions
, "HibernationOptions" :HibernationOptions
, "IamInstanceProfile" :IamInstanceProfile
, "ImageId" :String
, "InstanceInitiatedShutdownBehavior" :String
, "InstanceMarketOptions" :InstanceMarketOptions
, "InstanceType" :String
, "KernelId" :String
, "KeyName" :String
, "LicenseSpecifications" :[ LicenseSpecification, ... ]
, "MetadataOptions" :MetadataOptions
, "Monitoring" :Monitoring
, "NetworkInterfaces" :[ NetworkInterface, ... ]
, "Placement" :Placement
, "RamDiskId" :String
, "SecurityGroupIds" :[ String, ... ]
, "SecurityGroups" :[ String, ... ]
, "TagSpecifications" :[ TagSpecification, ... ]
, "UserData" :String
}
YAML
BlockDeviceMappings:
- BlockDeviceMapping
CapacityReservationSpecification:CapacityReservationSpecification
CpuOptions:CpuOptions
CreditSpecification:CreditSpecification
DisableApiTermination:Boolean
EbsOptimized:Boolean
ElasticGpuSpecifications:- ElasticGpuSpecification
ElasticInferenceAccelerators:- LaunchTemplateElasticInferenceAccelerator
EnclaveOptions:EnclaveOptions
HibernationOptions:HibernationOptions
IamInstanceProfile:IamInstanceProfile
ImageId:String
InstanceInitiatedShutdownBehavior:String
InstanceMarketOptions:InstanceMarketOptions
InstanceType:String
KernelId:String
KeyName:String
LicenseSpecifications:- LicenseSpecification
MetadataOptions:MetadataOptions
Monitoring:Monitoring
NetworkInterfaces:- NetworkInterface
Placement:Placement
RamDiskId:String
SecurityGroupIds:- String
SecurityGroups:- String
TagSpecifications:- TagSpecification
UserData:String
Properties
BlockDeviceMappings
-
The block device mapping.
Required: No
Type: List 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 Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
Required: No
Type: CpuOptions
Update requires: No interruption
CreditSpecification
-
The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
Required: No
Type: CreditSpecification
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 setInstanceInitiatedShutdownBehavior
toterminate
, 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
-
An elastic GPU to associate with the instance.
Required: No
Type: List of ElasticGpuSpecification
Update requires: No interruption
ElasticInferenceAccelerators
-
The elastic inference accelerator for the instance.
Required: No
Type: List of LaunchTemplateElasticInferenceAccelerator
Update requires: No interruption
EnclaveOptions
-
Not currently supported by AWS CloudFormation.
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 Instance in the Amazon Elastic Compute Cloud User Guide.
Required: No
Type: HibernationOptions
Update requires: No interruption
IamInstanceProfile
-
The IAM instance profile.
Required: No
Type: IamInstanceProfile
Update requires: No interruption
ImageId
-
The ID of the AMI.
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
InstanceType
-
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Required: No
Type: String
Allowed values:
a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.metal | c6gn.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.metal | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.large | d3en.metal | d3en.xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc5a.48xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | u-6tb1.metal | u-9tb1.metal | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge
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 Elastic Compute Cloud 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: List of LicenseSpecification
Update requires: No interruption
MetadataOptions
-
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud 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
-
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.
Required: No
Type: List of NetworkInterface
Update requires: No interruption
Placement
-
The placement for the instance.
Required: No
Type: Placement
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 Elastic Compute Cloud User Guide.
Required: No
Type: String
Update requires: No interruption
SecurityGroupIds
-
One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
Required: No
Type: List of String
Update requires: No interruption
SecurityGroups
-
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
Required: No
Type: List of String
Update requires: No interruption
TagSpecifications
-
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch.
Required: No
Type: List of TagSpecification
Update requires: No interruption
UserData
-
The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
Required: No
Type: String
Update requires: No interruption
See also
-
RequestLaunchTemplateData in the Amazon Elastic Compute Cloud API Reference