amazon.aws.ec2_ami_facts – Gather information about ec2 AMIs

From Get docs
Ansible/docs/2.10/collections/amazon/aws/ec2 ami facts module


amazon.aws.ec2_ami_facts – Gather information about ec2 AMIs

Note

This plugin is part of the amazon.aws collection (version 1.3.0).

To install it use: ansible-galaxy collection install amazon.aws.

To use it in a playbook, specify: amazon.aws.ec2_ami_facts.


New in version 1.0.0: of amazon.aws


Synopsis

  • Gather information about ec2 AMIs
  • This module was called amazon.aws.ec2_ami_facts before Ansible 2.9. The usage did not change.

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • 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.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_access_key, access_key

aws_ca_bundle

path

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

Only used for boto3 based modules.

Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

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.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_secret_key, secret_key

debug_botocore_endpoint_logs

boolean

  • 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.

describe_image_attributes

boolean

  • no

  • yes

Describe attributes (like launchPermission) of the images found.

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.


aliases: aws_endpoint_url, endpoint_url

executable_users

list / elements=string

Filter images by users with explicit launch permissions. Valid options are an AWS account ID, self, or all (public AMIs).


aliases: executable_user

filters

dictionary

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

Filter names and values are case sensitive.

image_ids

list / elements=string

One or more image IDs.


aliases: image_id

owners

list / elements=string

Filter the images by the owner. Valid options are an AWS account ID, self, or an AWS owner alias ( amazon | aws-marketplace | microsoft ).


aliases: owner

profile

string

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.


aliases: aws_profile

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_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.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: aws_security_token, access_token

validate_certs

boolean

  • 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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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

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

- name: gather information about an AMI using ami-id
  amazon.aws.ec2_ami_info:
    image_ids: ami-5b488823

- name: gather information about all AMIs with tag key Name and value webapp
  amazon.aws.ec2_ami_info:
    filters:
      "tag:Name": webapp

- name: gather information about an AMI with 'AMI Name' equal to foobar
  amazon.aws.ec2_ami_info:
    filters:
      name: foobar

- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
  amazon.aws.ec2_ami_info:
    owners: 099720109477
    filters:
      name: "ubuntu/images/ubuntu-zesty-17.04-*"

Return Values

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

Key Returned Description

images

list / elements=dictionary

always

A list of images.


architecture

string

always

The architecture of the image.


Sample:

x86_64

block_device_mappings

list / elements=dictionary

always

Any block device mapping entries.


device_name

string

always

The device name exposed to the instance.


Sample:

/dev/sda1

ebs

complex

always

EBS volumes


creation_date

string

always

The date and time the image was created.


Sample:

2017-10-16T19:22:13.000Z

description

string

always

The description of the AMI.


ena_support

boolean

always

Whether enhanced networking with ENA is enabled.


Sample:

True

hypervisor

string

always

The hypervisor type of the image.


Sample:

xen

image_id

string

always

The ID of the AMI.


Sample:

ami-5b466623

image_location

string

always

The location of the AMI.


Sample:

408466080000/Webapp

image_type

string

always

The type of image.


Sample:

machine

launch_permissions

list / elements=dictionary

When image is owned by calling account and describe_image_attributes is yes.

A List of AWS accounts may launch the AMI.


Sample:

[{'group': 'all'}, {'user_id': '408466080000'}]

group

string

success

A value of 'all' means the AMI is public.


user_id

string

success

An AWS account ID with permissions to launch the AMI.


name

string

always

The name of the AMI that was provided during image creation.


Sample:

Webapp

owner_id

string

always

The AWS account ID of the image owner.


Sample:

408466080000

public

boolean

always

Whether the image has public launch permissions.


Sample:

True

root_device_name

string

always

The device name of the root device.


Sample:

/dev/sda1

root_device_type

string

always

The type of root device used by the AMI.


Sample:

ebs

sriov_net_support

string

always

Whether enhanced networking is enabled.


Sample:

simple

state

string

always

The current state of the AMI.


Sample:

available

tags

dictionary

always

Any tags assigned to the image.


virtualization_type

string

always

The type of virtualization of the AMI.


Sample:

hvm




Authors

  • Prasad Katti (@prasadkatti)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/ec2_ami_facts_module.html