community.aws.ec2_launch_template module – Manage EC2 launch templates
Note
This module is part of the community.aws collection (version 7.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 community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.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.26.0
botocore >= 1.29.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, /dev/sdh or xvdh). |
|
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 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 1. Otherwise, specify the default value of 2. |
|
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 true, you can’t terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute. 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’. |
|
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 60 (60, 120, 180, 240, 300, or 360). |
|
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:
|
|
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:
|
|
Wether 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 ipv6_addresses option. |
|
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 ipv6_address_count option. |
|
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. |
|
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 security_group_ids. |
|
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 block device mapping are ignored when creating a new version unless they are explicitly included. Default: |
|
Whether the launch template should exist or not. Deleting specific versions of a launch template is not supported at this time. Choices:
|
|
A set of key-value pairs to be applied to resources when this Launch Template is used. 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. |
|
The ID for the launch template, can be used for all cases except creating a new Launch Template. |
|
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. |
|
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: |
Notes
Note
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
community.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
community.aws.ec2_launch_template:
name: "my_template"
default_version: 1
instance_type: c5.4xlarge
- name: Delete an ec2 launch template
community.aws.ec2_launch_template:
name: "my_template"
state: absent
# This module does not yet allow deletion of specific versions of launch templates
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
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 state=present |
|
Latest available version of the launch template Returned: when state=present |