Модуль community.aws.config_rule — управление ресурсами правил AWS Config

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.config_rule.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Модуль управляет правилами AWS Config.
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_config_rule. Способ использования не изменился.

Псевдонимы: aws_config_rule

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Описание
access_key псевдонимы: aws_access_key_id, aws_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_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры приведены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных за плейбук. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Описание, которое вы задаете для правила AWS Config.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
execution_frequency строка	Максимальная частота, с которой AWS Config выполняет проверки правила. Варианты: `"One_Hour"` `"Three_Hours"` `"Six_Hours"` `"Twelve_Hours"` `"TwentyFour_Hours"`
input_parameters строка	Строка в формате JSON, передаваемая функции Lambda правила AWS Config.
name строка / обязательный	Имя ресурса AWS Config.
profile псевдонимы: aws_profile строка	Именованный профиль AWS, используемый для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
scope словарь	Определяет, какие ресурсы могут инициировать проверку правила.
compliance_id строка	Идентификатор единственного ресурса AWS, который должен инициировать проверку правила. Если указан идентификатор ресурса, для compliance_types необходимо указать один тип ресурса.
compliance_types строка	Типы ресурсов только тех ресурсов AWS, которые должны инициировать проверку правила. Если также указан идентификатор ресурса для compliance_id, можно указать только один тип.
tag_key строка	Ключ тега, применяемого только к тем ресурсам AWS, которые должны инициировать проверку правила.
tag_value строка	Значение тега, применяемого только к тем ресурсам AWS, которые должны инициировать проверку правила. Если указано значение для tag_value, также необходимо указать значение для tag_key.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
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 строка	Определяет, должно ли правило Config присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать параметр aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста узла Ansible, а не из контекста контроллера. Поэтому файлы может потребоваться явно скопировать на узел. Для подключаемых модулей поиска и подключения переменные окружения и файлы конфигурации считываются из контекста контроллера Ansible, а не из контекста узла.
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте узла Ansible (обычно ~/.aws/credentials). Дополнительную информацию см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: Create Config Rule for AWS Config
  community.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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/config_rule_module.html