Try SpotterManage EC2 launch templates
| "added in version" 2.8 of ansible.builtin"
Authors: Ryan Scott Brown (@ryansb)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups.
The I(ec2_instance) and I(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.
- 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
tags:
description:
- 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 I(aws:)'
- 'Tag value constraints: Tag values are case-sensitive and accept a maximum of 255
Unicode characters.'
type: dict
state:
choices:
- present
- absent
default: present
description:
- Whether the launch template should exist or not.
- Deleting specific versions of a launch template is not supported at this time.
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
image_id:
description: 'The AMI ID to use for new instances launched with this template. This
value is region-dependent since AMIs are not global resources.
'
key_name:
description:
- The name of the key pair. You can create a key pair using I(CreateKeyPair) or I(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.
kernel_id:
description: 'The ID of the kernel. We recommend that you use PV-GRUB instead of kernels
and RAM disks. For more information, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)
'
placement:
description: The placement group settings for the instance.
suboptions:
affinity:
description: The affinity setting for an instance on a Dedicated Host.
availability_zone:
description: The Availability Zone for the instance.
group_name:
description: The name of the placement group for the instance.
host_id:
description: The ID of the Dedicated Host for the instance.
tenancy:
description: '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.
'
user_data:
description: 'The Base64-encoded user data to make available to the instance. For
more information, see the Linux U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html)
and Windows U(http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data)
documentation on user-data.
'
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
monitoring:
description: Settings for instance monitoring
suboptions:
enabled:
description: Whether to turn on detailed monitoring for new instances. This will
incur extra charges.
type: bool
cpu_options:
description:
- Choose CPU settings for the EC2 instances that will be created with this template.
- For more information, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html)
suboptions:
core_count:
description: The number of CPU cores for the instance.
threads_per_core:
description: '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.
'
ram_disk_id:
description: '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 U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)
'
template_id:
aliases:
- id
description:
- The ID for the launch template, can be used for all cases except creating a new
Launch Template.
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
ebs_optimized:
description: '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.
'
type: bool
instance_type:
description: 'The instance type, such as I(c5.2xlarge). For a full list of instance
types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
'
template_name:
aliases:
- name
description:
- The template name. This must be unique in the region-account combination you are
using.
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
default_version:
default: latest
description:
- 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.
security_groups:
description: A list of security group names (VPC or EC2-Classic) that the new instances
will be added to.
type: list
network_interfaces:
description: One or more network interfaces.
suboptions:
associate_public_ip_address:
description: Associates a public IPv4 address with eth0 for a new network interface.
type: bool
delete_on_termination:
description: Indicates whether the network interface is deleted when the instance
is terminated.
type: bool
description:
description: A description for the network interface.
device_index:
description: The device index for the network interface attachment.
groups:
description: List of security group IDs to include on this instance
ipv6_address_count:
description: '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 I(ipv6_addresses) option.
'
ipv6_addresses:
description: '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 I(ipv6_address_count) option.
'
network_interface_id:
description: The eni ID of a network interface to attach.
private_ip_address:
description: The primary private IPv4 address of the network interface.
private_ip_addresses:
description: One or more private IPv4 addresses.
suboptions:
primary:
description: 'Indicates whether the private IPv4 address is the primary private
IPv4 address. Only one IPv4 address can be designated as primary.
'
private_ip_address:
description: The primary private IPv4 address of the network interface.
secondary_private_ip_address_count:
description: The number of secondary private IPv4 addresses to assign to a network
interface.
subnet_id:
description: The ID of the subnet for the network interface.
security_group_ids:
description: A list of security group IDs (VPC or EC2-Classic) that the new instances
will be added to.
type: list
credit_specification:
description: The credit option for CPU usage of the instance. Valid for T2 or T3 instances
only.
suboptions:
cpu_credits:
choices:
- standard
- unlimited
description: 'The credit option for CPU usage of a T2 or T3 instance. Valid values
are I(standard) and I(unlimited).
'
iam_instance_profile:
description: 'The name or ARN of an IAM instance profile. Requires permissions to
describe existing instance roles to confirm ARN is properly formed.
'
block_device_mappings:
description:
- 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.
suboptions:
device_name:
description: The device name (for example, /dev/sdh or xvdh).
ebs:
description: Parameters used to automatically set up EBS volumes when the instance
is launched.
suboptions:
delete_on_termination:
description: Indicates whether the EBS volume is deleted on instance termination.
type: bool
encrypted:
description: '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:
description:
- 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:
description: The ARN of the AWS Key Management Service (AWS KMS) CMK used
for encryption.
snapshot_id:
description: The ID of the snapshot to create the volume from
volume_size:
description:
- 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:
description: The volume type
no_device:
description: Suppresses the specified device included in the block device mapping
of the AMI.
virtual_name:
description: '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.
'
disable_api_termination:
description: '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 I(ModifyInstanceAttribute).
'
type: bool
instance_market_options:
description: Options for alternative instance markets, currently only the spot market
is supported.
suboptions:
market_type:
description: The market type. This should always be 'spot'.
spot_options:
description: Spot-market specific settings
suboptions:
block_duration_minutes:
description: '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
description: The behavior when a Spot Instance is interrupted. The default
is I(terminate)
max_price:
description: The highest hourly price you're willing to pay for this Spot
Instance.
spot_instance_type:
choices:
- one-time
- persistent
description: The request type to send.
type: dict
elastic_gpu_specifications:
description: Settings for Elastic GPU attachments. See U(https://aws.amazon.com/ec2/elastic-gpus/)
for details.
suboptions:
type:
description: The type of Elastic GPU to attach
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
instance_initiated_shutdown_behavior:
choices:
- stop
- terminate
description: 'Indicates whether an instance stops or terminates when you initiate
shutdown from the instance using the operating system shutdown command.
'
default_version:
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
type: int
latest_version:
description: Latest available version of the launch template
returned: when state=present
type: int