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

Примечание

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

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

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

Для использования в playbook укажите: 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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключают друг друга. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
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`, чтобы проанализировать уникальные (а не общие) `"resource:action"` API-вызовы, выполненные во время задачи, выведя их в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action`, чтобы вывести общий список, выполненный во время выполнения книги задач. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Описание правила AWS Config.
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также можно использовать переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
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 и security_token.
region псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
scope словарь	Определяет, какие ресурсы могут инициировать оценку правила.
compliance_id строка	Идентификатор единственного ресурса AWS, для которого вы хотите инициировать оценку правила. Если вы указываете идентификатор ресурса, вы должны указать один тип ресурса для compliance_types.
compliance_types строка	Типы ресурсов только тех ресурсов AWS, для которых вы хотите инициировать оценку правила. Вы можете указать только один тип, если также указали идентификатор ресурса для compliance_id.
tag_key строка	Ключ тега, который применяется только к тем ресурсам AWS, для которых вы хотите инициировать оценку правила.

tag_value string	Значение тега, применяемое только к тем ресурсам AWS, для которых вы хотите запустить проверку правила. Если вы указываете значение для tag_value, вы также должны указать значение для tag_key.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа к 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сессии 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
source dictionary / required	Предоставляет владельца правила (AWS или пользователь), идентификатор правила и уведомления, которые вызывают выполнение функции для оценки ваших ресурсов AWS.
details string	Предоставляет источник и тип события, вызывающего оценку ваших ресурсов AWS с помощью AWS Config. Этот параметр ожидает список словарей. Каждый словарь ожидает следующие пары ключ/значение. Ключ `EventSource` Источник события, например, служба AWS, вызывающего оценку ваших ресурсов AWS с помощью AWS Config. Ключ `MessageType` Тип уведомления, запускающего оценку правила AWS Config. Ключ `MaximumExecutionFrequency` Частота запуска оценок для настраиваемого правила с периодическим триггером.
identifier string	Идентификатор единственного ресурса AWS, для которого вы хотите запустить проверку правила. Если вы указываете идентификатор ресурса, вы должны указать один тип ресурса для compliance_types.
owner string	Типы ресурсов AWS, для которых вы хотите запустить проверку правила. Вы можете указать только один тип, если также указываете идентификатор ресурса для compliance_id.
state string	Указывает, должно ли правило Config присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	При установке в `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется. Вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не из «контроллера». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не из «хост».
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/config_rule_module.html