amazon.aws.ec2_launch_template_info module – Gather information about launch templates and versions

Note

This module is part of the amazon.aws collection (version 9.0.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_info.

New in amazon.aws 9.0.0

Synopsis

  • Gather information about launch templates.

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

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and a filter value.

See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html for possible filters.

Filter names and values are case sensitive.

Default: {}

launch_template_ids

list / elements=string

The IDs of the launch templates.

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (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

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Gather information about a launch template
  amazon.aws.ec2_launch_template_info:
    launch_template_ids:
      - 'lt-01238c059e3466abc'

- name: Gather information launch template using name
  amazon.aws.ec2_launch_template_info:
    filters:
      launch-template-name: my-test-launch-template

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

launch_templates

list / elements=dictionary

A list of launch templates.

Returned: always

create_time

string

The time launch template was created.

Returned: always

created_by

string

The principal that created the launch template.

Returned: always

default_version_number

integer

The version number of the default version of the launch template.

Returned: always

latest_version_number

integer

The version number of the latest version of the launch template.

Returned: always

launch_template_id

string

The ID of the launch template.

Returned: always

launch_template_name

string

The name of the launch template.

Returned: always

tags

dictionary

A dictionary of tags assigned to image.

Returned: when AMI is created or already exists

Sample: {"Env": "devel", "Name": "nat-server"}

versions

list / elements=dictionary

All available versions of the launch template.

Returned: always

create_time

string

The time the version was created.

Returned: always

created_by

string

The principal that created the version.

Returned: always

default_version

boolean

Indicates whether the version is the default version.

Returned: always

launch_template_data

dictionary

Information about the launch template.

Returned: always

block_device_mappings

list / elements=dictionary

The block device mappings.

Returned: if applicable

device_name

string

The device name.

Returned: always

ebs

string

Information about the block device for an EBS volume.

Returned: if applicable

delete_on_termination

boolean

Indicates whether the EBS volume is deleted on instance termination.

Returned: always

encrypted

boolean

Indicates whether the EBS volume is encrypted.

Returned: always

iops

integer

The number of I/O operations per second (IOPS) that the volume supports.

Returned: always

kms_key_id

integer

The ARN of the Key Management Service (KMS) CMK used for encryption.

Returned: always

snapshot_id

string

The ID of the snapshot.

Returned: always

throughput

integer

The throughput that the volume supports, in MiB/s.

Returned: always

volume_size

integer

The size of the volume, in GiB.

Returned: always

volume_type

string

The volume type.

Returned: always

no_device

string

To omit the device from the block device mapping, specify an empty string.

Returned: success

virtual_name

string

The virtual device name.

Returned: always

cpu_options

dictionary

The CPU options for the instance.

Returned: if applicable

amd_sev_snp

integer

Indicates whether the instance is enabled for AMD SEV-SNP.

Returned: if applicable

core_count

integer

The number of CPU cores for the instance.

Returned: if applicable

threads_per_core

integer

The number of threads per CPU core.

Returned: if applicable

disable_api_termination

boolean

If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

Returned: if applicable

ebs_optimized

boolean

Indicates whether the instance is optimized for Amazon EBS I/O.

Returned: always

enclave_options

dictionary

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

Returned: if applicable

enabled

boolean

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.

Returned: always

iam_instance_profile

dictionary

The IAM instance profile.

Returned: if application

arn

string

The Amazon Resource Name (ARN) of the instance profile.

Returned: always

name

string

The name of the instance profile.

Returned: always

image_id

string

The ID of the AMI or a Systems Manager parameter.

Returned: if applicable

instance_initiated_shutdown_behavior

string

Indicates whether an instance stops or terminates when you initiate shutdown from the instance.

Returned: if applicable

instance_type

string

The instance type.

Returned: if applicable

kernel_id

string

The ID of the kernel.

Returned: if applicable

key_name

string

The name of the key pair.

Returned: if applicable

metadata_options

dictionary

The metadata options for the instance.

Returned: if applicable

http_endpoint

string

Enables or disables the HTTP metadata endpoint on your instances.

Returned: if applicable

http_protocol_ipv6

string

Enables or disables the IPv6 endpoint for the instance metadata service.

Returned: if applicable

http_put_response_hop_limit

integer

The desired HTTP PUT response hop limit for instance metadata requests.

Returned: if applicable

http_tokens

string

Indicates whether IMDSv2 is required.

Returned: if applicable

instance_metadata_tags

string

Set to enabled to allow access to instance tags from the instance metadata.

Returned: if applicable

state

string

The state of the metadata option changes.

Returned: if applicable

monitoring

dictionary

The monitoring for the instance.

Returned: if applicable

enabled

boolean

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

Returned: always

network_interfaces

list / elements=dictionary

The network interfaces.

Returned: if applicable

associate_carrier_ip_address

boolean

Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

Returned: always

associate_public_ip_address

boolean

Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

Returned: always

connection_tracking_specification

dictionary

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface.

Returned: if applicable

tcp_established_timeout

integer

Timeout (in seconds) for idle TCP connections in an established state.

Returned: always

udp_stream_timeout

integer

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.

Returned: always

udp_timeout

integer

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.

Returned: always

delete_on_termination

boolean

Indicates whether the network interface is deleted when the instance is terminated.

Returned: always

description

string

A description for the network interface.

Returned: always

device_index

integer

The device index for the network interface attachment.

Returned: always

ena_srd_specification

dictionary

Contains the ENA Express settings for instances launched from your launch template.

Returned: if applicable

ena_srd_enabled

boolean

Indicates whether ENA Express is enabled for the network interface.

Returned: always

ena_srd_udp_specification

dictionary

Configures ENA Express for UDP network traffic.

Returned: always

ena_srd_udp_enabled

boolean

Indicates whether UDP traffic to and from the instance uses ENA Express.

Returned: always

groups

list / elements=string

The IDs of one or more security groups.

Returned: if applicable

interface_type

string

The type of network interface.

Returned: always

ipv4_prefix_count

integer

The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.

Returned: if applicable

ipv4_prefixes

list / elements=dictionary

A list of IPv4 prefixes assigned to the network interface.

Returned: if applicable

ipv4_prefix

string

The IPv4 delegated prefixes assigned to the network interface.

Returned: always

ipv6_address_count

integer

The number of IPv6 addresses for the network interface.

Returned: if applicable

ipv6_addresses

list / elements=dictionary

The IPv6 addresses for the network interface.

Returned: if applicable

ipv6_address

string

The IPv6 address.

Returned: always

is_primary_ipv6

boolean

Determines if an IPv6 address associated with a network interface is the primary IPv6 address.

Returned: always

ipv6_prefix_count

integer

The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.

Returned: if applicable

ipv6_prefixes

list / elements=dictionary

A list of IPv6 prefixes assigned to the network interface.

Returned: if applicable

ipv6_prefix

string

The IPv6 delegated prefixes assigned to the network interface.

Returned: always

network_card_index

integer

The index of the network card.

Returned: if applicable

network_interface_id

string

The ID of the network interface.

Returned: always

primary_ipv6

string

The primary IPv6 address of the network interface.

Returned: if applicable

private_ip_address

string

The primary private IPv4 address of the network interface.

Returned: if applicable

private_ip_addresses

list / elements=string

A list of private IPv4 addresses.

Returned: if applicable

primary

boolean

Indicates whether the private IPv4 address is the primary private IPv4 address.

Returned: always

private_ip_address

boolean

The private IPv4 address.

Returned: always

secondary_private_ip_address_count

integer

The number of secondary private IPv4 addresses for the network interface.

Returned: if applicable

subnet_id

string

The ID of the subnet for the network interface.

Returned: always

placement

dictionary

The placement of the instance.

Returned: if applicable

affinity

string

The affinity setting for the instance on the Dedicated Host.

Returned: if applicable

availability_zone

string

The Availability Zone of the instance.

Returned: if applicable

group_id

string

The Group ID of the placement group.

Returned: if applicable

group_name

string

The name of the placement group for the instance.

Returned: if applicable

host_id

string

The ID of the Dedicated Host for the instance.

Returned: if applicable

host_resource_group_arn

string

The ARN of the host resource group in which to launch the instances.

Returned: if applicable

partition_number

integer

The number of the partition the instance should launch in.

Returned: if applicable

tenancy

string

The tenancy of the instance.

Returned: if applicable

ram_disk_id

string

The ID of the RAM disk, if applicable.

Returned: if applicable

security_group_ids

list / elements=string

The security group IDs.

Returned: if applicable

security_groups

list / elements=string

The security group names.

Returned: if applicable

tag_specifications

list / elements=dictionary

The tags that are applied to the resources that are created during instance launch.

Returned: if applicable

resource_type

string

The type of resource to tag.

Returned: always

tags

list / elements=dictionary

The tags for the resource.

Returned: success

key

string

The key of the tag.

Returned: always

value

string

The value of the tag.

Returned: always

user_data

string

The user data for the instance.

Returned: if applicable

launch_template_id

string

The ID of the launch template.

Returned: always

launch_template_name

string

The name of the launch template.

Returned: always

version_description

string

The description for the version.

Returned: always

version_number

integer

The version number.

Returned: always

Authors

  • Aubin Bikouo (@abikouo)