amazon.aws.ec2_launch_template module – Manage EC2 launch templates
Note
This module is part of the amazon.aws collection (version 9.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.ec2_launch_template.
New in community.aws 1.0.0
Synopsis
Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups.
The amazon.aws.ec2_instance and community.aws.autoscaling_group modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action. |
|
The device name (for example, |
|
Parameters used to automatically set up EBS volumes when the instance is launched. |
|
Indicates whether the EBS volume is deleted on instance termination. Choices:
|
|
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. Choices:
|
|
The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. |
|
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. |
|
The ID of the snapshot to create the volume from. |
|
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Valid Range - Minimum value of |
|
The size of the volume, in GiB. Default: If you’re creating the volume from a snapshot and don’t specify a volume size, the default is the snapshot size. |
|
The volume type |
|
Suppresses the specified device included in the block device mapping of the AMI. |
|
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. |
|
Choose CPU settings for the EC2 instances that will be created with this template. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html |
|
The number of CPU cores for the instance. |
|
The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of |
|
The credit option for CPU usage of the instance. Valid for T2 or T3 instances only. |
|
The credit option for CPU usage of a T2 or T3 instance. Valid values are |
|
Use a The Choices:
|
|
Which version should be the default when users spin up new instances based on this template? By default, the latest version will be made the default. Default: |
|
This helps protect instances from accidental termination. If set to Choices:
|
|
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. Choices:
|
|
Settings for Elastic GPU attachments. See https://aws.amazon.com/ec2/elastic-gpus/ for details. |
|
The type of Elastic GPU to attach |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed. |
|
The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources. |
|
Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system shutdown command. Choices:
|
|
Options for alternative instance markets, currently only the spot market is supported. |
|
The market type. This should always be |
|
Spot-market specific settings. |
|
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of |
|
The behavior when a Spot Instance is interrupted. The default is Choices:
|
|
The highest hourly price you’re willing to pay for this Spot Instance. |
|
The request type to send. Choices:
|
|
The instance type, such as |
|
The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html |
|
The name of the key pair. You can create a key pair using amazon.aws.ec2_key. 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. |
|
Configure EC2 Metadata options. For more information see the IMDS documentation https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html. |
|
This parameter enables or disables the HTTP metadata endpoint on your instances. Choices:
|
|
Whether the instance metadata endpoint is available via IPv6. Choices:
|
|
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Default: |
|
The state of token usage for your instance metadata requests. Choices:
|
|
Whether the instance tags are availble ( Choices:
|
|
Settings for instance monitoring. |
|
Whether to turn on detailed monitoring for new instances. This will incur extra charges. Choices:
|
|
One or more network interfaces. |
|
Associates a public IPv4 address with eth0 for a new network interface. Choices:
|
|
Indicates whether the network interface is deleted when the instance is terminated. Choices:
|
|
A description for the network interface. |
|
The device index for the network interface attachment. |
|
List of security group IDs to include on this instance. |
|
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 the |
|
A list of 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 the |
|
The eni ID of a network interface to attach. |
|
The primary private IPv4 address of the network interface. |
|
The ID of the subnet for the network interface. |
|
The placement group settings for the instance. |
|
The affinity setting for an instance on a Dedicated Host. |
|
The Availability Zone for the instance. |
|
The name of the placement group for the instance. |
|
The ID of the Dedicated Host for the instance. |
|
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If If the Tag keys beginning with Choices:
|
|
The ID of the RAM disk to launch the instance with. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A list of security group IDs (VPC or EC2-Classic) that the new instances will be added to. |
|
A list of security group names (Default VPC or EC2-Classic) that the new instances will be added to. For any VPC other than Default, you must use |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you explicity specify. Snapshots applied to the Default: |
|
Whether the launch template should exist or not. Deleting specific versions of a launch template is not supported at this time. Choices:
|
|
The tags to apply to the resources when this Launch template is used. |
|
The type of resource to tag. If the instance does not include the resource type that you specify, the instance launch fails. Choices:
|
|
A set of key-value pairs to be applied to the resource type. Tag key constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. |
|
A dictionary representing the tags to be applied to the resource. If the |
|
The ID for the launch template, can be used for all cases except creating a new Launch Template. At least one of |
|
The template name. This must be unique in the region-account combination you are using. If no launch template exists with the specified name, a new launch template is created. If a launch template with the specified name already exists and the configuration has not changed, nothing happens. If a launch template with the specified name already exists and the configuration has changed, a new version of the launch template is created. At least one of |
|
The Base64-encoded user data to make available to the instance. For more information, see the Linux http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html and Windows http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data documentation on user-data. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
The description of a launch template version. Default: |
|
The version numbers of a launch template versions to delete. Use By default, the latest version will be made the default. Ignored when |
Notes
Note
The
tagsoption used has been in release 9.0.0 to be applied to the launch template resource instead of launch template resource.Use
tag_specificationsto define tags to be applied to resources when this Launch Template is used.Support for
purge_tagswas added in release 9.0.0.Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: Create an ec2 launch template
amazon.aws.ec2_launch_template:
name: "my_template"
image_id: "ami-04b762b4289fba92b"
key_name: my_ssh_key
instance_type: t2.micro
iam_instance_profile: myTestProfile
disable_api_termination: true
- name: >
Create a new version of an existing ec2 launch template with a different instance type,
while leaving an older version as the default version
amazon.aws.ec2_launch_template:
name: "my_template"
default_version: 1
instance_type: c5.4xlarge
- name: Delete an ec2 launch template
amazon.aws.ec2_launch_template:
name: "my_template"
state: absent
- name: Delete a specific version of an ec2 launch template
amazon.aws.ec2_launch_template:
name: "my_template"
versions_to_delete:
- 2
state: absent
- name: Delete a specific version of an ec2 launch template and change the default version
amazon.aws.ec2_launch_template:
name: "my_template"
versions_to_delete:
- 1
default_version: 2
state: absent
- name: Create an ec2 launch template with specific tags
amazon.aws.ec2_launch_template:
name: "my_template"
image_id: "ami-04b762b4289fba92b"
instance_type: t2.micro
disable_api_termination: true
tags:
Some: tag
Another: tag
- name: Create an ec2 launch template with different tag for volume and instance
amazon.aws.ec2_launch_template:
name: "my_template"
image_id: "ami-04b762b4289fba92b"
instance_type: t2.micro
block_device_mappings:
- device_name: /dev/sdb
ebs:
volume_size: 20
delete_on_termination: true
volume_type: standard
tag_specifications:
- resource_type: instance
tags:
OsType: Linux
- resource_type: volume
tags:
foo: bar
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The launch template version that will be used if only the template name is specified. Often this is the same as the latest version, but not always. Returned: when |
|
The time launch template was created. Returned: always |
|
The principal that created the launch template. Returned: always |
|
The version number of the default version of the launch template. Returned: always |
|
The version number of the latest version of the launch template. Returned: always |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
A dictionary of tags assigned to image. Returned: when AMI is created or already exists Sample: |
|
The version that will be used if only the template name is specified. Often this is the same as the latest version, but not always. Returned: when |
|
information about a launch template deleted. Returned: when |
|
The time launch template was created. Returned: always |
|
The principal that created the launch template. Returned: always |
|
The version number of the default version of the launch template. Returned: always |
|
The version number of the latest version of the launch template. Returned: always |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
A dictionary of tags assigned to image. Returned: when AMI is created or already exists Sample: |
|
Information about deleted launch template versions. Returned: when |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
The version number of the launch template. Returned: always |
|
The latest available version of the launch template. Returned: when |
|
The time launch template was created. Returned: always |
|
The principal that created the launch template. Returned: always |
|
The version number of the default version of the launch template. Returned: always |
|
The version number of the latest version of the launch template. Returned: always |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
A dictionary of tags assigned to image. Returned: when AMI is created or already exists Sample: |
|
The latest available version number of the launch template. Returned: when |
|
Latest available version of the launch template. Returned: when |
|
The time launch template was created. Returned: always |
|
The principal that created the launch template. Returned: always |
|
The version number of the default version of the launch template. Returned: always |
|
The version number of the latest version of the launch template. Returned: always |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
A dictionary of tags assigned to image. Returned: when AMI is created or already exists Sample: |
|
All available versions of the launch template. Returned: when |
|
The time the version was created. Returned: always |
|
The principal that created the version. Returned: always |
|
Indicates whether the version is the default version. Returned: always |
|
Information about the launch template. Returned: always Sample: |
|
The block device mappings. Returned: if applicable |
|
The device name. Returned: always |
|
Information about the block device for an EBS volume. Returned: if applicable |
|
Indicates whether the EBS volume is deleted on instance termination. Returned: always |
|
Indicates whether the EBS volume is encrypted. Returned: always |
|
The number of I/O operations per second (IOPS) that the volume supports. Returned: always |
|
The ARN of the Key Management Service (KMS) CMK used for encryption. Returned: always |
|
The ID of the snapshot. Returned: always |
|
The throughput that the volume supports, in MiB/s. Returned: always |
|
The size of the volume, in GiB. Returned: always |
|
The volume type. Returned: always |
|
To omit the device from the block device mapping, specify an empty string. Returned: success |
|
The virtual device name. Returned: always |
|
The CPU options for the instance. Returned: if applicable |
|
Indicates whether the instance is enabled for AMD SEV-SNP. Returned: if applicable |
|
The number of CPU cores for the instance. Returned: if applicable |
|
The number of threads per CPU core. Returned: if applicable |
|
If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API. Returned: if applicable |
|
Indicates whether the instance is optimized for Amazon EBS I/O. Returned: always |
|
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. Returned: if applicable |
|
If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves. Returned: always |
|
The IAM instance profile. Returned: if application |
|
The Amazon Resource Name (ARN) of the instance profile. Returned: always |
|
The name of the instance profile. Returned: always |
|
The ID of the AMI or a Systems Manager parameter. Returned: if applicable |
|
Indicates whether an instance stops or terminates when you initiate shutdown from the instance. Returned: if applicable |
|
The instance type. Returned: if applicable |
|
The ID of the kernel. Returned: if applicable |
|
The name of the key pair. Returned: if applicable |
|
The metadata options for the instance. Returned: if applicable |
|
Enables or disables the HTTP metadata endpoint on your instances. Returned: if applicable |
|
Enables or disables the IPv6 endpoint for the instance metadata service. Returned: if applicable |
|
The desired HTTP PUT response hop limit for instance metadata requests. Returned: if applicable |
|
Indicates whether IMDSv2 is required. Returned: if applicable |
|
Set to enabled to allow access to instance tags from the instance metadata. Returned: if applicable |
|
The state of the metadata option changes. Returned: if applicable |
|
The monitoring for the instance. Returned: if applicable |
|
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Returned: always |
|
The network interfaces. Returned: if applicable |
|
Indicates whether to associate a Carrier IP address with eth0 for a new network interface. Returned: always |
|
Indicates whether to associate a public IPv4 address with eth0 for a new network interface. Returned: always |
|
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. Returned: if applicable |
|
Timeout (in seconds) for idle TCP connections in an established state. Returned: always |
|
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Returned: always |
|
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Returned: always |
|
Indicates whether the network interface is deleted when the instance is terminated. Returned: always |
|
A description for the network interface. Returned: always |
|
The device index for the network interface attachment. Returned: always |
|
Contains the ENA Express settings for instances launched from your launch template. Returned: if applicable |
|
Indicates whether ENA Express is enabled for the network interface. Returned: always |
|
Configures ENA Express for UDP network traffic. Returned: always |
|
Indicates whether UDP traffic to and from the instance uses ENA Express. Returned: always |
|
The IDs of one or more security groups. Returned: if applicable |
|
The type of network interface. Returned: always |
|
The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. Returned: if applicable |
|
A list of IPv4 prefixes assigned to the network interface. Returned: if applicable |
|
The IPv4 delegated prefixes assigned to the network interface. Returned: always |
|
The number of IPv6 addresses for the network interface. Returned: if applicable |
|
The IPv6 addresses for the network interface. Returned: if applicable |
|
The IPv6 address. Returned: always |
|
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. Returned: always |
|
The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. Returned: if applicable |
|
A list of IPv6 prefixes assigned to the network interface. Returned: if applicable |
|
The IPv6 delegated prefixes assigned to the network interface. Returned: always |
|
The index of the network card. Returned: if applicable |
|
The ID of the network interface. Returned: always |
|
The primary IPv6 address of the network interface. Returned: if applicable |
|
The primary private IPv4 address of the network interface. Returned: if applicable |
|
A list of private IPv4 addresses. Returned: if applicable |
|
Indicates whether the private IPv4 address is the primary private IPv4 address. Returned: always |
|
The private IPv4 address. Returned: always |
|
The number of secondary private IPv4 addresses for the network interface. Returned: if applicable |
|
The ID of the subnet for the network interface. Returned: always |
|
The placement of the instance. Returned: if applicable |
|
The affinity setting for the instance on the Dedicated Host. Returned: if applicable |
|
The Availability Zone of the instance. Returned: if applicable |
|
The Group ID of the placement group. Returned: if applicable |
|
The name of the placement group for the instance. Returned: if applicable |
|
The ID of the Dedicated Host for the instance. Returned: if applicable |
|
The ARN of the host resource group in which to launch the instances. Returned: if applicable |
|
The number of the partition the instance should launch in. Returned: if applicable |
|
The tenancy of the instance. Returned: if applicable |
|
The ID of the RAM disk, if applicable. Returned: if applicable |
|
The security group IDs. Returned: if applicable |
|
The security group names. Returned: if applicable |
|
The tags that are applied to the resources that are created during instance launch. Returned: if applicable |
|
The type of resource to tag. Returned: always |
|
The tags for the resource. Returned: success |
|
The key of the tag. Returned: always |
|
The value of the tag. Returned: always |
|
The user data for the instance. Returned: if applicable |
|
The ID of the launch template. Returned: always |
|
The name of the launch template. Returned: always |
|
The description for the version. Returned: always |
|
The version number. Returned: always |