community.aws.aws_config_recorder – Управление записывателями AWS Config

Примечание

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

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

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

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

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

Обзор

Модуль управляет настройками записывателя конфигурации AWS Config.

Требования

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

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 Bundle читается со стороны модуля и может потребоваться явное копирование с контроллера, если модуль не запускается локально.
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
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
name строка / обязательно			Имя ресурса AWS Config.
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
recording_group словарь			Указывает типы ресурсов AWS, для которых AWS Config записывает изменения конфигурации. Обязательно, когда state=present
	all_supported строка		Указывает, записывает ли AWS Config изменения конфигурации для каждого поддерживаемого типа региональных ресурсов. Если all_supported=true, при добавлении AWS Config поддержки нового типа регионального ресурса, он автоматически начинает записывать ресурсы этого типа. Если all_supported=true, вы не можете перечислить список resource_types.
	include_global_types строка		Указывает, включает ли AWS Config все поддерживаемые типы глобальных ресурсов (например, ресурсы IAM) в записываемые ресурсы. Подробные сведения о глобальных ресурсах одинаковы во всех регионах. Для предотвращения дублирования элементов конфигурации следует настроить AWS Config только в одном регионе для записи глобальных ресурсов. Если вы установите include_global_types=true, вы также должны установить all_supported=true. Если вы установите include_global_types=true, при добавлении AWS Config поддержки нового типа глобального ресурса, он автоматически начнет записывать ресурсы этого типа.
	resource_types строка		Список, определяющий типы ресурсов AWS, для которых AWS Config записывает изменения конфигурации (например, `AWS::EC2::Instance` или `AWS::CloudTrail::Trail`). Прежде чем вы сможете задать этот параметр, вы должны установить all_supported=false.
region строка			AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если оно есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
role_arn строка			Amazon Resource Name (ARN) IAM роли, используемой для описания ресурсов AWS, связанных с учетной записью. Обязательно, когда state=present.
security_token строка			AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и станет взаимоисключающей после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка		Варианты: present ← absent	Присутствует ли правило 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 Configuration Recorder for AWS Config
  community.aws.aws_config_recorder:
    name: test_configuration_recorder
    state: present
    role_arn: 'arn:aws:iam::123456789012:role/AwsConfigRecorder'
    recording_group:
        all_supported: true
        include_global_types: true

Авторы

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_recorder_module.html