Try SpotterGather information about ec2 AMIs
| "added in version" 2.5 of ansible.builtin"
Authors: Prasad Katti (@prasadkatti)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Gather information about ec2 AMIs
This module was called C(ec2_ami_facts) before Ansible 2.9. The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: gather information about an AMI using ami-id
ec2_ami_info:
image_ids: ami-5b488823
- name: gather information about all AMIs with tag key Name and value webapp
ec2_ami_info:
filters:
"tag:Name": webapp
- name: gather information about an AMI with 'AMI Name' equal to foobar
ec2_ami_info:
filters:
name: foobar
- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
ec2_ami_info:
owners: 099720109477
filters:
name: "ubuntu/images/ubuntu-zesty-17.04-*"
owners:
aliases:
- owner
description:
- Filter the images by the owner. Valid options are an AWS account ID, self,
- or an AWS owner alias ( amazon | aws-marketplace | microsoft ).
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
filters:
description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter
value.
- See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html)
for possible filters.
- Filter names and values are case sensitive.
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_ids:
aliases:
- image_id
description: One or more image IDs.
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
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
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
executable_users:
aliases:
- executable_user
description:
- Filter images by users with explicit launch permissions. Valid options are an AWS
account ID, self, or all (public AMIs).
describe_image_attributes:
default: false
description:
- Describe attributes (like launchPermission) of the images found.
type: bool
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
images:
contains:
architecture:
description: The architecture of the image
returned: always
sample: x86_64
type: str
block_device_mappings:
contains:
device_name:
description: The device name exposed to the instance
returned: always
sample: /dev/sda1
type: str
ebs:
description: EBS volumes
returned: always
type: complex
description: Any block device mapping entries
returned: always
type: complex
creation_date:
description: The date and time the image was created
returned: always
sample: '2017-10-16T19:22:13.000Z'
type: str
description:
description: The description of the AMI
returned: always
sample: ''
type: str
ena_support:
description: whether enhanced networking with ENA is enabled
returned: always
sample: true
type: bool
hypervisor:
description: The hypervisor type of the image
returned: always
sample: xen
type: str
image_id:
description: The ID of the AMI
returned: always
sample: ami-5b466623
type: str
image_location:
description: The location of the AMI
returned: always
sample: 408466080000/Webapp
type: str
image_type:
description: The type of image
returned: always
sample: machine
type: str
launch_permissions:
description: launch permissions of the ami
returned: when image is owned by calling account and describe_image_attributes
is yes
sample:
- group: all
- user_id: '408466080000'
type: complex
name:
description: The name of the AMI that was provided during image creation
returned: always
sample: Webapp
type: str
owner_id:
description: The AWS account ID of the image owner
returned: always
sample: '408466080000'
type: str
public:
description: whether the image has public launch permissions
returned: always
sample: true
type: bool
root_device_name:
description: The device name of the root device
returned: always
sample: /dev/sda1
type: str
root_device_type:
description: The type of root device used by the AMI
returned: always
sample: ebs
type: str
sriov_net_support:
description: whether enhanced networking is enabled
returned: always
sample: simple
type: str
state:
description: The current state of the AMI
returned: always
sample: available
type: str
tags:
description: Any tags assigned to the image
returned: always
type: complex
virtualization_type:
description: The type of virtualization of the AMI
returned: always
sample: hvm
type: str
description: a list of images
returned: always
type: complex