community.aws.aws_config_aggregator – Управление агрегациями AWS Config в нескольких учетных записях
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.aws_config_aggregator.
Введено в версии 1.0.0: коллекции community.aws
Обзор
- Модуль управляет ресурсами AWS Config
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| account_sources список / элементы=словарь / обязательный | Предоставляет список учетных записей источника и регионов для агрегации. | ||
| account_ids список / элементы=строка | Список 12-значных идентификаторов учетных записей, которые агрегируются. | ||
| all_aws_regions логическое |
| Если true, агрегирует существующие регионы AWS Config и будущие регионы. | |
| aws_regions список / элементы=строка | Список регионов источника, которые агрегируются. | ||
| 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 путь | Местоположение файла с корневым сертификатом для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл с корневым сертификатом читается на стороне модуля и может потребоваться его явно скопировать с контроллера, если он не запущен локально. | ||
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Более подробную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 | ||
| debug_botocore_endpoint_logs логическое |
| Используйте logger 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 | ||
| name строка / обязательный | Имя ресурса AWS Config. | ||
| organization_source словарь / обязательный | Регион, уполномоченный собирать агрегированные данные. | ||
| all_aws_regions логическое |
| Если true, агрегирует существующие регионы AWS Config и будущие регионы. | |
| aws_regions список / элементы=строка | Регионы источника, которые агрегируются. | ||
| role_arn строка | ARN роли IAM, используемой для получения данных AWS Organization, связанных с учетной записью агрегатора. | ||
| 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 | ||
| region строка | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если оно есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и после 2022-06-01 параметры будут взаимоисключающими. псевдонимы: aws_security_token, access_token | ||
| state строка |
| Необходимо ли наличие правила Config или его отсутствие. | |
| validate_certs логическое |
| При значении "нет" SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. | |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
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: Create cross-account aggregator
community.aws.aws_config_aggregator:
name: test_config_rule
state: present
account_sources:
account_ids:
- 1234567890
- 0123456789
- 9012345678
all_aws_regions: yes
Авторы
- Aaron Smith (@slapula)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/aws_config_aggregator_module.html