community.aws.ecs_tag модуль — создание и удаление тегов для ресурсов Amazon ECS
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | ID ключа доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение пакета CA для проверки SSL-сертификатов. Также может быть использована переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
cluster_name строка / обязательно | Имя кластера, ресурсы которого мы маркируем. |
debug_botocore_endpoint_logs логический тип | Использовать логгер Также может использоваться переменная среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Несмотря на то, что это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут использоваться переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый профиль AWS для аутентификации. Дополнительную информацию о именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token. |
purge_tags логический тип | Удалить не указанные теги из ресурса. Обратите внимание, что при сочетании с state=absent несоответствующие значения указанных тегов не удаляются. Варианты:
|
region псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также могут использоваться переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
resource строка | Имя ресурса ECS. Необходимо, если не указано resource_type=cluster. |
resource_type строка | Тип ресурса. Варианты:
|
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. Также могут использоваться переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | AWS STS сессионный токен для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
state string | Указывает, должны ли метки присутствовать или отсутствовать на ресурсе. Варианты:
|
tags aliases: resource_tags dictionary | Словарь меток для добавления или удаления с ресурса. Если значение, предоставленное для метки, равно null и state=absent, метка будет удалена независимо от ее текущего значения. |
validate_certs boolean | При установке в Установка validate_certs=false категорически не рекомендуется, в качестве альтернативы можно установить aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible ‘host’, а не ‘controller’. Поэтому файлы может потребоваться скопировать в ‘host’. Для плагинов lookup и connection переменные среды и конфигурационные файлы считываются из контекста Ansible ‘controller’, а не ‘host’.
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из конфигурационных файлов в контексте Ansible ‘host’ (обычно
~/.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 dictionary | Словарь меток, которые были добавлены к ресурсу Возвращается: Если метки были добавлены |
removed_tags dictionary | Словарь меток, которые были удалены с ресурса Возвращается: Если метки были удалены |
tags dictionary | Словарь, содержащий метки на ресурсе Возвращается: всегда |
Авторы
- Michael Pechner (@mpechner)
Ссылки на коллекции
© 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/community/aws/ecs_tag_module.html