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

Примечание

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

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

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

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

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

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

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

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

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.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 botocore SDK.
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.
cluster_name строка / обязательный	Имя кластера, ресурсы которого помечаются тегами.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключе resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдоним: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
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.
purge_tags логическое значение	Следует ли удалять с ресурса неуказанные теги. Обратите внимание: если этот параметр используется вместе с state=absent, указанные теги с несовпадающими значениями не удаляются. Варианты: `false` ← (по умолчанию) `true`
region псевдоним: aws_region строка	Регион AWS, который следует использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
resource строка	Имя ресурса ECS. Обязательный параметр, если resource_type=cluster не задан.
resource_type строка	Тип ресурса. Варианты: `"cluster"` ← (по умолчанию) `"task"` `"service"` `"task_definition"` `"container"`
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 botocore SDK.
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 являются взаимоисключающими.
state строка	Должны ли теги присутствовать на ресурсе или отсутствовать на нём. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдоним: resource_tags словарь	Словарь тегов, которые нужно добавить к ресурсу или удалить с него. Если для тега указано значение null и задано state=absent, тег будет удалён независимо от его текущего значения.
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.

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/ecs_tag_module.html