community.aws.ecs_tag – создание и удаление тегов для ресурсов Amazon ECS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ecs_tag.

Новое в версии 1.0.0: из community.aws

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Создает и удаляет теги для ресурсов Amazon ECS.
Ресурсы ссылаются по имени кластера.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела, и эти параметры будут взаимно исключающими после 2022-06-01. алиасы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл сертификата CA читается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела, и эти параметры будут взаимно исключающими после 2022-06-01. алиасы: ec2_secret_key, secret_key
cluster_name строка / обязательно		Имя кластера, ресурсы которого будут помечены тегами.
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте логирования botocore.endpoint для обработки уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в полный список, созданный во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задано, используется значение переменной среды EC2_URL, если таковая имеется. алиасы: aws_endpoint_url, endpoint_url
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, а поддержка их одновременной передачи с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимно исключать profile после 2022-06-01. алиасы: aws_profile
purge_tags логический	Варианты: нет ← да	Указывает, следует ли удалять неопределенные теги из ресурса. Обратите внимание, что при сочетании с 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 строка		Имя ресурса ECS. Обязательно, если resource_type=cluster не указан.
resource_type строка	Варианты: cluster ← task service task_definition container	Тип ресурса.
security_token строка		AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела, и эти параметры будут взаимно исключающими после 2022-06-01. алиасы: aws_security_token, access_token
state строка	Варианты: present ← absent	Указывает, должны ли теги присутствовать или отсутствовать на ресурсе.
tags словарь		Словарь тегов для добавления или удаления из ресурса. Если предоставленное значение для тега равно null и state=absent, тег будет удален независимо от его текущего значения.
validate_certs логический	Варианты: нет да ←	В случае установки значения «нет» для boto-версий >= 2.6.0 проверка SSL-сертификатов не будет выполняться.

Примечания

Примечание

нет
Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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
  community.aws.ecs_tag:
    cluster_name: mycluster
    resource_type: cluster
    state: present
    tags:
      Name: ubervol
      env: prod

- name: Remove the Env tag
  community.aws.ecs_tag:
    cluster_name: mycluster
    resource_type: cluster
    tags:
      Env:
    state: absent

- name: Remove the Env tag if it's currently 'development'
  community.aws.ecs_tag:
    cluster_name: mycluster
    resource_type: cluster
    tags:
      Env: development
    state: absent

- name: Remove all tags except for Name from a cluster
  community.aws.ecs_tag:
    cluster_name: mycluster
    resource_type: cluster
    tags:
        Name: foo
    state: absent
    purge_tags: true

Значения возврата

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

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

Авторы

Michael Pechner (@mpechner)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ecs_tag_module.html