Модуль community.aws.config_recorder — управление регистраторами AWS Config
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.aws.config_recorder.
Добавлено в community.aws 1.0.0
Краткое описание
- Модуль управляет настройками регистратора конфигурации AWS Config.
- До выпуска версии 5.0.0 этот модуль назывался
community.aws.aws_config_recorder. Использование не изменилось.
Псевдонимы: aws_config_recorder
Требования
На хосте, на котором выполняется этот модуль, необходимы следующие компоненты.
- 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 и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
aws_ca_bundle путь | Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную окружения Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
name строка / обязательный | Имя ресурса AWS Config. |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
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 записывает изменения конфигурации (например, Перед установкой этого параметра необходимо задать all_supported=false. |
region псевдонимы: aws_region строка | Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
role_arn строка | Имя ресурса Amazon (ARN) роли IAM, используемой для описания ресурсов AWS, связанных с учетной записью. Обязательно, если state=present. |
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. Также можно использовать переменные окружения Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
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. Также можно использовать переменную окружения Параметры session_token и profile взаимоисключающие. |
state строка | Должно ли правило Config присутствовать или отсутствовать. Варианты:
|
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «хоста» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для подключаемых модулей поиска и соединения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «хоста».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: Create Configuration Recorder for AWS Config
community.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
Ссылки на коллекцию
© 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_recorder_module.html