ec2_tag – создание и удаление тегов для ресурсов ec2.

Новое в версии 1.3.

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

Описание

Создает, удаляет и перечисляет теги для любого ресурса EC2. Ресурс ссылается по его идентификатору (например, экземпляр, являющийся i-XXXXXXX). Он предназначен для использования с комплексными аргументами (тегами), см. примеры.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key -		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key
aws_secret_key -		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
ec2_url -		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
profile - добавлен в 1.6		Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags boolean добавлен в 2.7	Варианты: нет ← да	Удалить теги, не указанные явно, из ресурса. Обратите внимание, что при комбинировании с `state: absent`, указанные теги с несовпадающими значениями не удаляются.
region -		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
resource - / обязательно		Идентификатор ресурса EC2.
security_token - добавлен в 1.6		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state -	Варианты: present ← absent list	Указать, должны ли теги присутствовать или отсутствовать на ресурсе. Используйте list для запроса тегов экземпляра.
tags - / обязательно		Хэш/словарь тегов для добавления к ресурсу; '{"key":"value"}' и '{"key":"value","key":"value"}'
validate_certs boolean добавлен в 1.5	Варианты: нет да ←	Если установлено «нет», сертификаты SSL для boto версий >= 2.6.0 не будут проверятся.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: Ensure tags are present on a resource
  ec2_tag:
    region: eu-west-1
    resource: vol-XXXXXX
    state: present
    tags:
      Name: ubervol
      env: prod

- name: Ensure all volumes are tagged
  ec2_tag:
    region:  eu-west-1
    resource: '{{ item.id }}'
    state: present
    tags:
      Name: dbserver
      Env: production
  with_items: '{{ ec2_vol.volumes }}'

- name: Retrieve all tags on an instance
  ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    state: list
  register: ec2_tags

- name: Remove all tags except for Name from an instance
  ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
        Name: ''
    state: absent
    purge_tags: true

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

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

Ключ	Возвращаемое значение	Описание
added_tags словарь	Если теги были добавлены	Словарь тегов, которые были добавлены к ресурсу
removed_tags словарь	Если теги были удалены	Словарь тегов, которые были удалены из ресурса
tags словарь	всегда	Словарь, содержащий теги на ресурсе

Статус

Для этого модуля гарантируется отсутствие изменений в обратной совместимости в будущем. [stableinterface]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

Lester Wade (@lwade)
Paul Arthur (@flowerysong)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_tag_module.html