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.13
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.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
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:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
image_ids:
aliases:
- image_id
description: One or more image IDs.
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
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: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(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