community.aws.aws_config_rule – Управление ресурсами AWS Config

Примечание

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

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

Для использования в плейбуке укажите: community.aws.aws_config_rule.

Новое в версии 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'. Дополнительную информацию о конфигурации 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 логический тип		Варианты: нет ← да	Использование логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время плейбука. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description строка			Описание правила AWS Config.
ec2_url строка			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она присутствует. Псевдонимы: aws_endpoint_url, endpoint_url
execution_frequency строка		Варианты: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours	Максимальная частота выполнения оценок правил AWS Config.
input_parameters строка			Строка в формате JSON, передаваемая в функцию AWS Config Lambda.
name строка / обязательно			Имя ресурса AWS Config.
profile строка			Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token. Поддержка одновременного использования устарела. 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
scope словарь			Определяет, какие ресурсы могут вызывать оценку для правила.
	compliance_id строка		Идентификатор единственного ресурса AWS, для которого вы хотите запустить оценку правила. Если указан идентификатор ресурса, необходимо указать один тип ресурса для compliance_types.
	compliance_types строка		Типы ресурсов AWS, для которых вы хотите запустить оценку правила. Можно указать только один тип, если также указан идентификатор ресурса для compliance_id.
	tag_key строка		Ключ тега, применяемый только к ресурсам AWS, для которых вы хотите запустить оценку правила.
	tag_value строка		Значение тега, применяемое только к ресурсам AWS, для которых вы хотите запустить оценку правила. Если вы указали значение для tag_value, вы также должны указать значение для tag_key.
security_token строка			Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. Псевдонимы: aws_security_token, access_token
source словарь / обязательно			Указывает владельца правила (AWS или пользователь), идентификатор правила и уведомления, вызывающие оценку ваших ресурсов AWS.
	details строка		Предоставляет исходный тип события, вызывающего оценку ваших ресурсов AWS службой AWS Config. Этот параметр ожидает список словарей. Каждый словарь должен содержать следующие пары ключ/значение: Ключ `EventSource` - Источник события, например, служба AWS, вызывающая оценку ваших ресурсов AWS службой AWS Config. Ключ `MessageType` - Тип уведомления, вызывающего оценку правила AWS Config. Ключ `MaximumExecutionFrequency` - Частота, с которой вы хотите, чтобы AWS Config выполняла оценки для пользовательского правила с периодическим триггером.
	identifier строка		Идентификатор единственного ресурса AWS, для которого вы хотите запустить оценку правила. Если указан идентификатор ресурса, необходимо указать один тип ресурса для compliance_types.
	owner строка		Типы ресурсов AWS, для которых вы хотите запустить оценку правила. Можно указать только один тип, если также указан идентификатор ресурса для compliance_id.
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 Config Rule for AWS Config
  community.aws.aws_config_rule:
    name: test_config_rule
    state: present
    description: 'This AWS Config rule checks for public write access on S3 buckets'
    scope:
        compliance_types:
            - 'AWS::S3::Bucket'
    source:
        owner: AWS
        identifier: 'S3_BUCKET_PUBLIC_WRITE_PROHIBITED'

Авторы

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