ec2_launch_template – Manage EC2 launch templates

New in version 2.8.

Synopsis

  • Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups.
  • The ec2_instance and ec2_asg 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.

  • boto
  • boto3 >= 1.6.0
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
block_device_mappings
-
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.
device_name
-
The device name (for example, /dev/sdh or xvdh).
ebs
-
Parameters used to automatically set up EBS volumes when the instance is launched.
delete_on_termination
boolean
    Choices:
  • no
  • yes
Indicates whether the EBS volume is deleted on instance termination.
encrypted
-
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.
iops
-
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.
kms_key_id
-
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
snapshot_id
-
The ID of the snapshot to create the volume from
volume_size
-
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.
volume_type
-
The volume type
no_device
-
Suppresses the specified device included in the block device mapping of the AMI.
virtual_name
-
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.
cpu_options
-
Choose CPU settings for the EC2 instances that will be created with this template.
core_count
-
The number of CPU cores for the instance.
threads_per_core
-
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.
credit_specification
-
The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
cpu_credits
-
    Choices:
  • standard
  • unlimited
The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.
debug_botocore_endpoint_logs
boolean
added in 2.8
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
default_version
-
Default:
"latest"
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.
disable_api_termination
boolean
    Choices:
  • no
  • yes
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.
ebs_optimized
boolean
    Choices:
  • no
  • yes
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.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
elastic_gpu_specifications
-
Settings for Elastic GPU attachments. See https://aws.amazon.com/ec2/elastic-gpus/ for details.
type
-
The type of Elastic GPU to attach
iam_instance_profile
-
The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed.
image_id
-
The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources.
instance_initiated_shutdown_behavior
-
    Choices:
  • stop
  • terminate
Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system shutdown command.
instance_market_options
dictionary
Options for alternative instance markets, currently only the spot market is supported.
market_type
-
The market type. This should always be 'spot'.
spot_options
-
Spot-market specific settings
block_duration_minutes
-
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).
instance_interruption_behavior
-
    Choices:
  • hibernate
  • stop
  • terminate
The behavior when a Spot Instance is interrupted. The default is terminate
max_price
-
The highest hourly price you're willing to pay for this Spot Instance.
spot_instance_type
-
    Choices:
  • one-time
  • persistent
The request type to send.
instance_type
-
The instance type, such as c5.2xlarge. For a full list of instance types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
kernel_id
-
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
key_name
-
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
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.
monitoring
-
Settings for instance monitoring
enabled
boolean
    Choices:
  • no
  • yes
Whether to turn on detailed monitoring for new instances. This will incur extra charges.
network_interfaces
-
One or more network interfaces.
associate_public_ip_address
boolean
    Choices:
  • no
  • yes
Associates a public IPv4 address with eth0 for a new network interface.
delete_on_termination
boolean
    Choices:
  • no
  • yes
Indicates whether the network interface is deleted when the instance is terminated.
description
-
A description for the network interface.
device_index
-
The device index for the network interface attachment.
groups
-
List of security group IDs to include on this instance
ipv6_address_count
-
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.
ipv6_addresses
-
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.
network_interface_id
-
The eni ID of a network interface to attach.
private_ip_address
-
The primary private IPv4 address of the network interface.
private_ip_addresses
-
One or more private IPv4 addresses.
primary
-
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
private_ip_address
-
The primary private IPv4 address of the network interface.
secondary_private_ip_address_count
-
The number of secondary private IPv4 addresses to assign to a network interface.
subnet_id
-
The ID of the subnet for the network interface.
placement
-
The placement group settings for the instance.
affinity
-
The affinity setting for an instance on a Dedicated Host.
availability_zone
-
The Availability Zone for the instance.
group_name
-
The name of the placement group for the instance.
host_id
-
The ID of the Dedicated Host for the instance.
tenancy
-
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.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
ram_disk_id
-
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
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_group_ids
list
A list of security group IDs (VPC or EC2-Classic) that the new instances will be added to.
security_groups
list
A list of security group names (VPC or EC2-Classic) that the new instances will be added to.
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
state
-
    Choices:
  • present ←
  • absent
Whether the launch template should exist or not.
Deleting specific versions of a launch template is not supported at this time.
tags
dictionary
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.
template_id
-
The ID for the launch template, can be used for all cases except creating a new Launch Template.

aliases: id
template_name
-
The template name. This must be unique in the region-account combination you are using.

aliases: name
user_data
-
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.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: Create an ec2 launch template
  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
  ec2_launch_template:
    name: "my_template"
    default_version: 1
    instance_type: c5.4xlarge

- name: Delete an ec2 launch template
  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 Returned Description
default_version
integer
when state=present
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.
latest_version
integer
when state=present
Latest available version of the launch template


Status

Authors

  • Ryan Scott Brown (@ryansb)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.