Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_spot_instance_info – Сбор информации о запросах на экземпляры EC2 Spot

Примечание

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

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

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

Для использования в плейбуке укажите: amazon.aws.ec2_spot_instance_info.

Новая функция в amazon.aws 2.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Описывает указанные запросы на экземпляры Spot Instance.

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания предпочтения.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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 логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода общего списка, выполненного во время выполнения книги задач.

Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также могут быть использованы переменные среды AWS_URL или EC2_URL в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

filters

словарь

Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра.

Названия и значения фильтров чувствительны к регистру.

Возможные фильтры см. в https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSpotInstanceRequests.html.

По умолчанию: {}

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 и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Регион AWS для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут быть использованы переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания предпочтения.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

END_OF_DOCUMENT_MARKER

spot_instance_request_ids

список / элементы=строка

Один или несколько идентификаторов запросов на экземпляры Spot Instance.

По умолчанию: []

validate_certs

логическое

При установке в значение false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false категорически не рекомендуется. Вместо этого рекомендуется установить aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Следовательно, файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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: describe the Spot Instance requests based on request IDs
  amazon.aws.ec2_spot_instance_info:
    spot_instance_request_ids:
      - sir-12345678

- name: describe the Spot Instance requests and filter results based on instance type
  amazon.aws.ec2_spot_instance_info:
    spot_instance_request_ids:
      - sir-12345678
      - sir-13579246
      - sir-87654321
    filters:
      launch.instance-type: t3.medium

- name: describe the Spot requests filtered using multiple filters
  amazon.aws.ec2_spot_instance_info:
    filters:
      state: active
      launch.block-device-mapping.device-name: /dev/sdb

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

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

Ключ

Описание

spot_request

list / elements=dictionary

Собранная информация о запрошенных экземплярах Spot.

Возвращается: при успехе

Пример: {"create_time": "2021-09-01T21:05:57+00:00", "instance_id": "i-08877936b801ac475", "instance_interruption_behavior": "terminate", "launch_specification": {"ebs_optimized": false, "image_id": "ami-0443305dabd4be2bc", "instance_type": "t2.medium", "key_name": "zuul", "monitoring": {"enabled": false}, "placement": {"availability_zone": "us-east-2b"}, "security_groups": [{"group_id": "sg-01f9833207d53b937", "group_name": "default"}], "subnet_id": "subnet-07d906b8358869bda"}, "launched_availability_zone": "us-east-2b", "product_description": "Linux/UNIX", "spot_instance_request_id": "sir-c3cp9jsk", "spot_price": "0.046400", "state": "active", "status": {"code": "fulfilled", "message": "Your spot request is fulfilled.", "update_time": "2021-09-01T21:05:59+00:00"}, "tags": {}, "type": "one-time", "valid_until": "2021-09-08T21:05:57+00:00"}

create_time

string

Дата и время создания запроса на экземпляр Spot.

Возвращается: всегда

instance_id

string

ID экземпляра, если экземпляр был запущен для выполнения запроса на экземпляр Spot.

Возвращается: если экземпляр существует

instance_interruption_behavior

string

Поведение при прерывании экземпляра Spot.

Возвращается: всегда

launch_specification

dictionary

Дополнительная информация для запуска экземпляров.

Возвращается: всегда

ebs_optimized

boolean

Указывает, оптимизирован ли экземпляр для ввода-вывода EBS.

Возвращается: всегда

image_id

string

ID AMI.

Возвращается: всегда

instance_type

string

Тип экземпляра.

Возвращается: всегда

key_name

string

Имя пары ключей.

Возвращается: всегда

monitoring

dictionary

Описание мониторинга экземпляра.

Возвращается: всегда

enabled

boolean

Указывает, включен ли подробный мониторинг.

Возвращается: всегда

placement

dictionary

Информация о размещении экземпляра.

Возвращается: всегда

availability_zone

string

Название зоны доступности.

Возвращается: всегда

security_groups

list / elements=dictionary

Список групп безопасности.

Возвращается: всегда

group_id

string

ID группы безопасности.

Возвращается: всегда

group_name

string

Название группы безопасности.

Возвращается: всегда

subnet_id

string

ID подсети.

Возвращается: при создании сетевого интерфейса при запуске экземпляра

launched_availability_zone

string

Зона доступности, в которой запущен запрос.

Возвращается: всегда

product_description

string

Описание продукта, связанное с экземпляром Spot.

Возвращается: всегда

spot_instance_request_id

string

ID запроса на экземпляр Spot.

Возвращается: всегда

spot_price

string

Максимальная цена за час, которую вы готовы заплатить за Spot-инстанс.

Возвращаемое значение: всегда

state

string

Состояние запроса на Spot-инстанс.

Возвращаемое значение: всегда

status

dictionary

Дополнительная информация о состоянии запроса на Spot-инстанс.

Возвращаемое значение: всегда

code

string

Код состояния.

См. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand для кодов.

Возвращаемое значение: всегда

message

string

Описание кода состояния.

Возвращаемое значение: всегда

update_time

string

Дата и время последнего обновления состояния в формате UTC.

Возвращаемое значение: всегда

tags

list / elements=dictionary

Список тегов, связанных с ресурсом.

Возвращаемое значение: всегда

key

string

Ключ тега.

Возвращаемое значение: всегда

value

string

Значение тега.

Возвращаемое значение: всегда

type

string

Тип запроса на Spot-инстанс.

Возвращаемое значение: всегда

valid_until

string

Конечная дата запроса в формате UTC.

Возвращаемое значение: всегда

Авторы

  • Mandar Vijay Kulkarni (@mandar242)

Ссылки на сборки

  • Отслеживание проблем
  • Репозиторий (источники)
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API