aws_config_rule - Управление ресурсами AWS Config
Новое в версии 2.6.
Обзор
- Модуль управляет правилами AWS Config
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aws_access_key | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| description | Описание, которое вы предоставляете для правила AWS Config. | ||
| ec2_url | URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | ||
| execution_frequency |
| Максимальная частота, с которой AWS Config выполняет оценки для правила. | |
| input_parameters | Строка в формате JSON, которая передаётся в Lambda-функцию правила AWS Config. | ||
| name обязательно | Название ресурса AWS Config. | ||
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| scope | Определяет, какие ресурсы могут вызывать оценку для правила. | ||
| compliance_types | Типы ресурсов AWS, для которых вы хотите вызвать оценку правила. Вы можете указать только один тип, если также указан идентификатор ресурса для `compliance_id`. | ||
| compliance_id | Идентификатор единственного ресурса AWS, для которого вы хотите вызвать оценку правила. Если вы указали идентификатор ресурса, вы должны указать один тип ресурса для `compliance_types`. | ||
| tag_key | Ключ тега, который применяется только к тем ресурсам AWS, для которых вы хотите вызвать оценку правила. | ||
| tag_value | Значение тега, которое применяется только к тем ресурсам AWS, для которых вы хотите вызвать оценку правила. Если вы указали значение для `tag_value`, вы также должны указать значение для `tag_key`. | ||
| security_token (добавлено в 1.6) | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| source | Предоставляет владельца правила (AWS или пользователь), идентификатор правила и уведомления, которые заставляют функцию оценивать ваши ресурсы AWS. | ||
| owner | Типы ресурсов AWS, для которых вы хотите вызвать оценку правила. Вы можете указать только один тип, если также указан идентификатор ресурса для `compliance_id`. | ||
| identifier | Идентификатор единственного ресурса AWS, для которого вы хотите вызвать оценку правила. Если вы указали идентификатор ресурса, вы должны указать один тип ресурса для `compliance_types`. | ||
| details | Предоставляет источник и тип события, которые заставляют AWS Config оценивать ваши ресурсы AWS. Этот параметр ожидает список словарей. Каждый словарь ожидает следующие пары ключ/значение. Ключ `EventSource` Источник события, например, AWS сервис, который запускает AWS Config для оценки ваших ресурсов AWS. Ключ `MessageType` Тип уведомления, который запускает AWS Config для выполнения оценки для правила. Ключ `MaximumExecutionFrequency` Частота, с которой вы хотите, чтобы AWS Config выполнял оценки для пользовательского правила с периодическим триггером. | ||
| state |
| Должно ли правило Config быть присутствующим или отсутствовать. | |
| validate_certs bool (добавлено в 1.5) |
| При значении "no" сертификаты SSL не будут проверены для версий boto >= 2.6.0. | |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные среды могут использоваться в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS региона, если требуется, но это также можно настроить в конфигурационном файле boto
Примеры
- name: Create Config Rule for AWS Config
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'
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/aws_config_rule_module.html