community.aws.efs_tag модуль — создание и удаление тегов для ресурсов Amazon EFS
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в плейбуке, укажите: community.aws.efs_tag.
Новая функция в community.aws 2.0.0
Описание
- Создаёт и удаляет теги для ресурсов Amazon EFS.
- Ресурсы ссылаются по их идентификатору (файловая система или точка доступа к файловой системе).
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 и 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. |
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 строка / обязательный | Идентификатор файловой системы EFS или идентификатор точки доступа файловой системы EFS. |
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 «хост» и не из контекста «контроллер». В связи с этим файлы, возможно, потребуется скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
- name: Ensure tags are present on a resource
community.aws.efs_tag:
resource: fs-123456ab
state: present
tags:
Name: MyEFS
Env: Production
- name: Remove the Env tag if it's currently 'development'
community.aws.efs_tag:
resource: fsap-78945ff
state: absent
tags:
Env: development
- name: Remove all tags except for Name
community.aws.efs_tag:
resource: fsap-78945ff
state: absent
tags:
Name: foo
purge_tags: true
- name: Remove all tags
community.aws.efs_tag:
resource: fsap-78945ff
state: absent
tags: {}
purge_tags: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
added_tags dictionary | Словарь меток, которые были добавлены к ресурсу Возвращается: если метки были добавлены |
removed_tags dictionary | Словарь меток, которые были удалены с ресурса Возвращается: если метки были удалены |
tags dictionary | Словарь, содержащий метки на ресурсе Возвращается: всегда |
Авторы
- Milan Zink (@zeten30)
Ссылки на коллекцию
© 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/efs_tag_module.html