Модуль amazon.aws.ec2_ami_info — сбор информации об AMI EC2

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_ami_info.

Добавлено в amazon.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Сбор информации об AMI EC2.

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Описание
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету сертификатов CA, который используется для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их список в ключ resource_actions результатов задачи. Используйте колбэк `aws_resource_action`, чтобы вывести полный список вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
describe_image_attributes логическое значение	Получать сведения об атрибутах (например, launchPermission) найденных образов. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Этот параметр можно использовать для подключения к другим совместимым с AWS службам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
executable_users псевдоним: executable_user список / элементы типа string	Фильтровать образы по пользователям с явными разрешениями на запуск. Допустимые значения: идентификатор учетной записи AWS, self или all (общедоступные AMI). По умолчанию: `[]`
filters словарь	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и его значения. Список доступных фильтров см. в разделе https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html. Имена фильтров и их значения чувствительны к регистру. По умолчанию: `{}`
image_ids псевдоним: image_id список / элементы типа string	Один или несколько идентификаторов образов. По умолчанию: `[]`
owners псевдоним: owner список / элементы типа string	Фильтровать образы по владельцу. Допустимые значения: идентификатор учетной записи AWS, self или псевдоним владельца AWS ( amazon \| aws-marketplace \| microsoft ). По умолчанию: `[]`
profile псевдоним: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдоним: aws_region строка	Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
session_token псевдоним: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile взаимоисключающие.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# 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-*"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
images list / elements=dictionary	Список образов. Возвращается: всегда
architecture string	Архитектура образа. Возвращается: всегда Пример: `"x86_64"`
block_device_mappings list / elements=dictionary	Записи сопоставления блочных устройств. Возвращается: всегда
device_name string	Имя устройства, доступное экземпляру. Возвращается: всегда Пример: `"/dev/sda1"`
ebs complex	Тома EBS Возвращается: всегда
creation_date string	Дата и время создания образа. Возвращается: всегда Пример: `"2017-10-16T19:22:13.000Z"`
description string	Описание AMI. Возвращается: при успешном выполнении Пример: `""`
ena_support boolean	Указывает, включена ли улучшенная сетевая поддержка с использованием ENA. Возвращается: всегда Пример: `true`
hypervisor string	Тип гипервизора образа. Возвращается: всегда Пример: `"xen"`
image_id string	Идентификатор AMI. Возвращается: всегда Пример: `"ami-5b466623"`
image_location string	Расположение AMI. Возвращается: всегда Пример: `"123456789012/Webapp"`
image_type string	Тип образа. Возвращается: всегда Пример: `"machine"`
launch_permissions list / elements=dictionary	Список учетных записей AWS, которым разрешено запускать AMI. Возвращается: если образ принадлежит вызывающей учетной записи и `describe_image_attributes=true`. Пример: `[{"group": "all"}, {"user_id": "123456789012"}]`
group string	Значение «all» означает, что AMI является общедоступным. Возвращается: при успешном выполнении
user_id string	Идентификатор учетной записи AWS, которой разрешено запускать AMI. Возвращается: при успешном выполнении
name string	Имя AMI, заданное при создании образа. Возвращается: всегда Пример: `"Webapp"`
owner_id string	Идентификатор учетной записи AWS владельца образа. Возвращается: всегда Пример: `"123456789012"`
platform_details string	Платформа образа. Возвращается: всегда Пример: `"Windows"`
public boolean	Указывает, есть ли у образа общедоступные разрешения на запуск. Возвращается: всегда Пример: `true`
root_device_name string	Имя корневого устройства. Возвращается: всегда Пример: `"/dev/sda1"`
root_device_type string	Тип корневого устройства, используемого AMI. Возвращается: всегда Пример: `"ebs"`
sriov_net_support string	Указывает, включена ли улучшенная сетевая поддержка. Возвращается: при успешном выполнении Пример: `"simple"`
state string	Текущее состояние AMI. Возвращается: всегда Пример: `"available"`
tags dictionary	Теги, назначенные образу. Возвращается: всегда
usage_operation string	Операция экземпляра Amazon EC2 и связанный с AMI код тарификации. Возвращается: всегда Пример: `"RunInstances"`
virtualization_type string	Тип виртуализации AMI. Возвращается: всегда Пример: `"hvm"`

Авторы

Prasad Katti (@prasadkatti)

Ссылки на коллекцию

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