create-launch-template-version¶
Description¶
Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can’t specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can’t modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon EC2 User Guide .
See also: AWS API Documentation
Synopsis¶
create-launch-template-version
[--dry-run | --no-dry-run]
[--client-token <value>]
[--launch-template-id <value>]
[--launch-template-name <value>]
[--source-version <value>]
[--version-description <value>]
--launch-template-data <value>
[--resolve-alias | --no-resolve-alias]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
Options¶
--dry-run | --no-dry-run (boolean)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it isUnauthorizedOperation.
--client-token (string)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn’t specified, a randomly generated token is used in the request to ensure idempotency.
For more information, see Ensuring idempotency .
Constraint: Maximum 128 ASCII characters.
--launch-template-id (string)
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
--launch-template-name (string)
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
Constraints:
- min:
3- max:
128- pattern:
[a-zA-Z0-9\(\)\.\-/_]+
--source-version (string)
The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.
If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.
--version-description (string)
A description for the version of the launch template.
Constraints:
- min:
0- max:
255
--launch-template-data (structure) [required]
The information for the launch template.
KernelId -> (string)
The ID of the kernel.
Warning
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 .EbsOptimized -> (boolean)
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.IamInstanceProfile -> (structure)
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Arn -> (string)
The Amazon Resource Name (ARN) of the instance profile.Name -> (string)
The name of the instance profile.BlockDeviceMappings -> (list)
The block device mapping.
(structure)
Describes a block device mapping.
DeviceName -> (string)
The device name (for example, /dev/sdh or xvdh).VirtualName -> (string)
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.Ebs -> (structure)
Parameters used to automatically set up EBS volumes when the instance is launched.
Encrypted -> (boolean)
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can’t specify an encryption value.DeleteOnTermination -> (boolean)
Indicates whether the EBS volume is deleted on instance termination.Iops -> (integer)
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:
gp3: 3,000 - 80,000 IOPSio1: 100 - 64,000 IOPSio2: 100 - 256,000 IOPSFor
io2volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.This parameter is supported for
io1,io2, andgp3volumes only.KmsKeyId -> (string)
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.SnapshotId -> (string)
The ID of the snapshot.VolumeSize -> (integer)
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2: 1 - 16,384 GiBgp3: 1 - 65,536 GiBio1: 4 - 16,384 GiBio2: 4 - 65,536 GiBst1andsc1: 125 - 16,384 GiBstandard: 1 - 1024 GiBVolumeType -> (string)
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide .
Possible values:
standardio1io2gp2sc1st1gp3Throughput -> (integer)
The throughput to provision for a
gp3volume, with a maximum of 2,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 2,000.
VolumeInitializationRate -> (integer)
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
- You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
Note
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
- You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide .
Valid range: 100 - 300 MiB/s
EbsCardIndex -> (integer)
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.NoDevice -> (string)
To omit the device from the block device mapping, specify an empty string.NetworkInterfaces -> (list)
The network interfaces for the instance.
(structure)
The parameters for a network interface.
AssociateCarrierIpAddress -> (boolean)
Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .
AssociatePublicIpAddress -> (boolean)
Associates a public IPv4 address with eth0 for a new network interface.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page .
DeleteOnTermination -> (boolean)
Indicates whether the network interface is deleted when the instance is terminated.Description -> (string)
A description for the network interface.DeviceIndex -> (integer)
The device index for the network interface attachment. The primary network interface has a device index of 0. Each network interface is of typeinterface, you must specify a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.Groups -> (list)
The IDs of one or more security groups.
(string)
InterfaceType -> (string)
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify
efaorefa. For more information, see Elastic Fabric Adapter for AI/ML and HPC workloads on Amazon EC2 in the Amazon EC2 User Guide .If you are not creating an EFA, specify
interfaceor omit this parameter.If you specify
efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.Valid values:
interface|efa|efa-onlyIpv6AddressCount -> (integer)
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses.Ipv6Addresses -> (list)
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.
(structure)
Describes an IPv6 address.
Ipv6Address -> (string)
The IPv6 address.NetworkInterfaceId -> (string)
The ID of the network interface.PrivateIpAddress -> (string)
The primary private IPv4 address of the network interface.PrivateIpAddresses -> (list)
One or more private IPv4 addresses.
(structure)
Describes a secondary private IPv4 address for a network interface.
Primary -> (boolean)
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.PrivateIpAddress -> (string)
The private IPv4 address.SecondaryPrivateIpAddressCount -> (integer)
The number of secondary private IPv4 addresses to assign to a network interface.SubnetId -> (string)
The ID of the subnet for the network interface.NetworkCardIndex -> (integer)
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.Ipv4Prefixes -> (list)
One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCountoption.(structure)
Describes the IPv4 prefix option for a network interface.
Ipv4Prefix -> (string)
The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .Ipv4PrefixCount -> (integer)
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv4Prefixoption.Ipv6Prefixes -> (list)
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCountoption.(structure)
Describes the IPv6 prefix option for a network interface.
Ipv6Prefix -> (string)
The IPv6 prefix.Ipv6PrefixCount -> (integer)
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv6Prefixoption.PrimaryIpv6 -> (boolean)
The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances .EnaSrdSpecification -> (structure)
Configure ENA Express settings for your launch template.
EnaSrdEnabled -> (boolean)
Specifies whether ENA Express is enabled for the network interface when you launch an instance.EnaSrdUdpSpecification -> (structure)
Contains ENA Express settings for UDP network traffic for the network interface attached to the instance.
EnaSrdUdpEnabled -> (boolean)
Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set EnaSrdEnabled in the EnaSrdSpecificationRequest totrue.ConnectionTrackingSpecification -> (structure)
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the Amazon EC2 User Guide .
TcpEstablishedTimeout -> (integer)
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 350 seconds for Nitro v6 instance types (excluding P6e-GB200); 432000 seconds for all other instance types (including P6e-GB200). Recommended: Less than 432000 seconds.UdpStreamTimeout -> (integer)
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.UdpTimeout -> (integer)
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.EnaQueueCount -> (integer)
The number of ENA queues to be created with the instance.ImageId -> (string)
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 Amazon Web Services 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
instantsupport specifying a Systems Manager parameter.- For EC2 Fleets of type
maintainorrequest, or for Spot Fleets, you must specify the AMI ID.InstanceType -> (string)
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide .
If you specify
InstanceType, you can’t specifyInstanceRequirements.Possible values:
a1.mediuma1.largea1.xlargea1.2xlargea1.4xlargea1.metalc1.mediumc1.xlargec3.largec3.xlargec3.2xlargec3.4xlargec3.8xlargec4.largec4.xlargec4.2xlargec4.4xlargec4.8xlargec5.largec5.xlargec5.2xlargec5.4xlargec5.9xlargec5.12xlargec5.18xlargec5.24xlargec5.metalc5a.largec5a.xlargec5a.2xlargec5a.4xlargec5a.8xlargec5a.12xlargec5a.16xlargec5a.24xlargec5ad.largec5ad.xlargec5ad.2xlargec5ad.4xlargec5ad.8xlargec5ad.12xlargec5ad.16xlargec5ad.24xlargec5d.largec5d.xlargec5d.2xlargec5d.4xlargec5d.9xlargec5d.12xlargec5d.18xlargec5d.24xlargec5d.metalc5n.largec5n.xlargec5n.2xlargec5n.4xlargec5n.9xlargec5n.18xlargec5n.metalc6g.mediumc6g.largec6g.xlargec6g.2xlargec6g.4xlargec6g.8xlargec6g.12xlargec6g.16xlargec6g.metalc6gd.mediumc6gd.largec6gd.xlargec6gd.2xlargec6gd.4xlargec6gd.8xlargec6gd.12xlargec6gd.16xlargec6gd.metalc6gn.mediumc6gn.largec6gn.xlargec6gn.2xlargec6gn.4xlargec6gn.8xlargec6gn.12xlargec6gn.16xlargec6i.largec6i.xlargec6i.2xlargec6i.4xlargec6i.8xlargec6i.12xlargec6i.16xlargec6i.24xlargec6i.32xlargec6i.metalcc1.4xlargecc2.8xlargecg1.4xlargecr1.8xlarged2.xlarged2.2xlarged2.4xlarged2.8xlarged3.xlarged3.2xlarged3.4xlarged3.8xlarged3en.xlarged3en.2xlarged3en.4xlarged3en.6xlarged3en.8xlarged3en.12xlargedl1.24xlargef1.2xlargef1.4xlargef1.16xlargeg2.2xlargeg2.8xlargeg3.4xlargeg3.8xlargeg3.16xlargeg3s.xlargeg4ad.xlargeg4ad.2xlargeg4ad.4xlargeg4ad.8xlargeg4ad.16xlargeg4dn.xlargeg4dn.2xlargeg4dn.4xlargeg4dn.8xlargeg4dn.12xlargeg4dn.16xlargeg4dn.metalg5.xlargeg5.2xlargeg5.4xlargeg5.8xlargeg5.12xlargeg5.16xlargeg5.24xlargeg5.48xlargeg5g.xlargeg5g.2xlargeg5g.4xlargeg5g.8xlargeg5g.16xlargeg5g.metalhi1.4xlargehpc6a.48xlargehs1.8xlargeh1.2xlargeh1.4xlargeh1.8xlargeh1.16xlargei2.xlargei2.2xlargei2.4xlargei2.8xlargei3.largei3.xlargei3.2xlargei3.4xlargei3.8xlargei3.16xlargei3.metali3en.largei3en.xlargei3en.2xlargei3en.3xlargei3en.6xlargei3en.12xlargei3en.24xlargei3en.metalim4gn.largeim4gn.xlargeim4gn.2xlargeim4gn.4xlargeim4gn.8xlargeim4gn.16xlargeinf1.xlargeinf1.2xlargeinf1.6xlargeinf1.24xlargeis4gen.mediumis4gen.largeis4gen.xlargeis4gen.2xlargeis4gen.4xlargeis4gen.8xlargem1.smallm1.mediumm1.largem1.xlargem2.xlargem2.2xlargem2.4xlargem3.mediumm3.largem3.xlargem3.2xlargem4.largem4.xlargem4.2xlargem4.4xlargem4.10xlargem4.16xlargem5.largem5.xlargem5.2xlargem5.4xlargem5.8xlargem5.12xlargem5.16xlargem5.24xlargem5.metalm5a.largem5a.xlargem5a.2xlargem5a.4xlargem5a.8xlargem5a.12xlargem5a.16xlargem5a.24xlargem5ad.largem5ad.xlargem5ad.2xlargem5ad.4xlargem5ad.8xlargem5ad.12xlargem5ad.16xlargem5ad.24xlargem5d.largem5d.xlargem5d.2xlargem5d.4xlargem5d.8xlargem5d.12xlargem5d.16xlargem5d.24xlargem5d.metalm5dn.largem5dn.xlargem5dn.2xlargem5dn.4xlargem5dn.8xlargem5dn.12xlargem5dn.16xlargem5dn.24xlargem5dn.metalm5n.largem5n.xlargem5n.2xlargem5n.4xlargem5n.8xlargem5n.12xlargem5n.16xlargem5n.24xlargem5n.metalm5zn.largem5zn.xlargem5zn.2xlargem5zn.3xlargem5zn.6xlargem5zn.12xlargem5zn.metalm6a.largem6a.xlargem6a.2xlargem6a.4xlargem6a.8xlargem6a.12xlargem6a.16xlargem6a.24xlargem6a.32xlargem6a.48xlargem6g.metalm6g.mediumm6g.largem6g.xlargem6g.2xlargem6g.4xlargem6g.8xlargem6g.12xlargem6g.16xlargem6gd.metalm6gd.mediumm6gd.largem6gd.xlargem6gd.2xlargem6gd.4xlargem6gd.8xlargem6gd.12xlargem6gd.16xlargem6i.largem6i.xlargem6i.2xlargem6i.4xlargem6i.8xlargem6i.12xlargem6i.16xlargem6i.24xlargem6i.32xlargem6i.metalmac1.metalp2.xlargep2.8xlargep2.16xlargep3.2xlargep3.8xlargep3.16xlargep3dn.24xlargep4d.24xlarger3.larger3.xlarger3.2xlarger3.4xlarger3.8xlarger4.larger4.xlarger4.2xlarger4.4xlarger4.8xlarger4.16xlarger5.larger5.xlarger5.2xlarger5.4xlarger5.8xlarger5.12xlarger5.16xlarger5.24xlarger5.metalr5a.larger5a.xlarger5a.2xlarger5a.4xlarger5a.8xlarger5a.12xlarger5a.16xlarger5a.24xlarger5ad.larger5ad.xlarger5ad.2xlarger5ad.4xlarger5ad.8xlarger5ad.12xlarger5ad.16xlarger5ad.24xlarger5b.larger5b.xlarger5b.2xlarger5b.4xlarger5b.8xlarger5b.12xlarger5b.16xlarger5b.24xlarger5b.metalr5d.larger5d.xlarger5d.2xlarger5d.4xlarger5d.8xlarger5d.12xlarger5d.16xlarger5d.24xlarger5d.metalr5dn.larger5dn.xlarger5dn.2xlarger5dn.4xlarger5dn.8xlarger5dn.12xlarger5dn.16xlarger5dn.24xlarger5dn.metalr5n.larger5n.xlarger5n.2xlarger5n.4xlarger5n.8xlarger5n.12xlarger5n.16xlarger5n.24xlarger5n.metalr6g.mediumr6g.larger6g.xlarger6g.2xlarger6g.4xlarger6g.8xlarger6g.12xlarger6g.16xlarger6g.metalr6gd.mediumr6gd.larger6gd.xlarger6gd.2xlarger6gd.4xlarger6gd.8xlarger6gd.12xlarger6gd.16xlarger6gd.metalr6i.larger6i.xlarger6i.2xlarger6i.4xlarger6i.8xlarger6i.12xlarger6i.16xlarger6i.24xlarger6i.32xlarger6i.metalt1.microt2.nanot2.microt2.smallt2.mediumt2.larget2.xlarget2.2xlarget3.nanot3.microt3.smallt3.mediumt3.larget3.xlarget3.2xlarge