[ aws . configservice ]
describe-configuration-recorders
Описание
Возвращает детали указанного вами регистратора конфигурации.
Если регистратор конфигурации не указан, эта операция возвращает детали конфигурации регистратора, управляемого клиентом, настроенного для учетной записи, если применимо.
Примечание
При выполнении запроса к этой операции можно указать только один регистратор конфигурации.См. также: Документация API AWS
Синтаксис
describe-configuration-recorders
[--configuration-recorder-names <value>]
[--service-principal <value>]
[--arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--configuration-recorder-names (список)
Список имен регистраторов конфигурации, которые вы хотите указать.
(строка)
Синтаксис:
"string" "string" ...
--service-principal (строка)
--arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладку.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команд.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включить
- выключить
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с сертификатами CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет рассматриваться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить вывод страниц cli для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
За исключением случаев, когда сказано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для получения подробных сведений о регистраторе конфигурации
Следующая команда возвращает подробную информацию о регистраторе конфигурации по умолчанию:
aws configservice describe-configuration-recorders
Вывод:
{
"ConfigurationRecorders": [
{
"recordingGroup": {
"allSupported": true,
"resourceTypes": [],
"includeGlobalResourceTypes": true
},
"roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6",
"name": "default"
}
]
}
Вывод
ConfigurationRecorders -> (список)
Список, содержащий описания указанных записывателей конфигурации.
(структура)
Записывает изменения конфигурации для типов ресурсов в области действия.
Дополнительную информацию о записывателе конфигурации см. в разделе «Работа с записывателем конфигурации» ` Работа с записывателем конфигурации https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html`__ в руководстве разработчика Config .
arn -> (строка)
name -> (строка)
Имя записывателя конфигурации.
Для записывателей конфигурации, управляемых клиентом, Config автоматически назначает имя «default», если вы не указали имя при создании записывателя конфигурации.
Для записывателей конфигурации, связанных со службой, Config автоматически назначает имя, начинающееся с «AWS » новому записывателю конфигурации, связанному со службой.
Примечание
Чтобы изменить имя записывателя конфигурации, управляемого клиентом, необходимо удалить его и создать новый записыватель конфигурации, управляемый клиентом, с новым именем.
Имя записывателя конфигурации, связанного со службой, изменить нельзя.
roleARN -> (строка)
Amazon Resource Name (ARN) роли IAM, которая используется Config и указанным записывателем конфигурации.
Примечание
Хотя в модели API это поле не требуется, сервер отклонит запрос без определения roleARN для записывателя конфигурации.
Политики и результаты соответствия
Политики IAM и другие политики, управляемые в Организациях, могут повлиять на наличие у Config разрешений для записи изменений конфигурации для ваших ресурсов. Кроме того, правила напрямую оценивают конфигурацию ресурса, и правила не учитывают эти политики при выполнении оценок. Убедитесь, что действующие политики соответствуют тому, как вы намерены использовать Config.
Сохранение минимальных разрешений при повторном использовании роли IAM
Если вы используете Amazon Web Services-сервис, использующий Config, такой как Security Hub или Control Tower, и роль IAM уже создана, убедитесь, что роль IAM, которую вы используете при настройке Config, сохраняет те же минимальные разрешения, что и существующая роль IAM. Это необходимо для обеспечения корректной работы другого Amazon Web Services-сервиса.
Например, если у Control Tower есть роль IAM, которая разрешает Config читать объекты S3, убедитесь, что те же разрешения предоставлены роли IAM, которую вы используете при настройке Config. В противном случае это может повлиять на работу Control Tower.
Для записывателей конфигурации, связанных со службой, необходимо использовать роль IAM, связанную со службой для Config: AWSServiceRoleForConfig .
recordingGroup -> (структура)
Определяет, какие типы ресурсов находятся в области действия для записи записывателем конфигурации.
Примечание
В первый месяц работы с Config вы можете заметить повышенную активность в вашей учетной записи по сравнению с последующими месяцами. Во время начальной фазы запуска Config выполняет оценки для всех ресурсов в вашей учетной записи, которые вы выбрали для записи в Config.
Если вы работаете с временными рабочими нагрузками, вы можете заметить повышенную активность Config при записи изменений конфигурации, связанных с созданием и удалением этих временных ресурсов. Временная рабочая нагрузка — это временное использование вычислительных ресурсов, которые загружаются и выполняются по мере необходимости. Примеры включают Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, задания Amazon EMR и Auto Scaling.
Если вы хотите избежать увеличенной активности от временных рабочих нагрузок, вы можете настроить записыватель конфигурации так, чтобы исключить эти типы ресурсов из записи, или запустить эти типы рабочих нагрузок в отдельной учетной записи с отключенной Config, чтобы избежать увеличенной записи конфигурации и оценки правил.
allSupported -> (булево)
Указывает, записывает ли Config изменения конфигурации для всех поддерживаемых типов ресурсов, за исключением глобальных типов ресурсов IAM.
Если вы установите это поле в true , при добавлении Config поддержки нового типа ресурса, Config автоматически начнёт запись ресурсов этого типа.
Если вы установите это поле в true , вы не сможете перечислить конкретные типы ресурсов для записи в поле resourceTypes RecordingGroup или исключить их в поле resourceTypes ExclusionByResourceTypes .
Примечание
Проверьте покрытие ресурсов по регионам, чтобы увидеть, поддерживается ли тип ресурса в Amazon Web Services-регионе, где вы настраиваете Config.
includeGlobalResourceTypes -> (булево)
Этот параметр применяется только к глобальным типам ресурсов IAM: пользователям IAM, группам, ролям и управляемым клиентом политикам. Эти глобальные типы ресурсов IAM могут быть записаны Config только в регионах, где Config был доступен до февраля 2022 года. Вы не можете записывать глобальные типы ресурсов IAM в регионах, поддерживаемых Config после февраля 2022 года. Список этих регионов см. в разделе Запись Amazon Web Services ресурсов | Глобальные ресурсы .
Предупреждение
Тип ресурса AWS::RDS::GlobalCluster будет записан во всех поддерживаемых регионах Config, где включен записыватель конфигурации, даже если includeGlobalResourceTypes установлен в `false` . Параметр includeGlobalResourceTypes применяется только к пользователям IAM, группам, ролям и управляемым клиентом политикам.
Если вы не хотите записывать AWS::RDS::GlobalCluster во всех включенных регионах, используйте одну из следующих стратегий записи:
-
Запись всех текущих и будущих типов ресурсов с исключениями (
EXCLUSION_BY_RESOURCE_TYPES), или -
Запись определенных типов ресурсов (
INCLUSION_BY_RESOURCE_TYPES).
Дополнительную информацию см. в разделе Выбор ресурсов, которые записываются в руководстве разработчика Config .
Предупреждение
Поле includeGlobalResourceTypes не влияет на стратегию записи с исключениями EXCLUSION_BY_RESOURCE_TYPES. Это означает, что глобальные типы ресурсов IAM (пользователи IAM, группы, роли и управляемые клиентом политики) не будут автоматически добавлены в качестве исключений для exclusionByResourceTypes, когда includeGlobalResourceTypes установлено в false .
Поле includeGlobalResourceTypes должно использоваться только для изменения поля AllSupported, так как значение по умолчанию для поля AllSupported — запись изменений конфигурации для всех поддерживаемых типов ресурсов, за исключением глобальных типов ресурсов IAM. Чтобы включить глобальные типы ресурсов IAM, когда AllSupported установлено в true , убедитесь, что includeGlobalResourceTypes установлено в true .
Чтобы исключить глобальные типы ресурсов IAM для стратегии записи EXCLUSION_BY_RESOURCE_TYPES , необходимо вручную добавить их в поле resourceTypes поля exclusionByResourceTypes .
Примечание
Прежде чем установить это поле в true , установите поле allSupported RecordingGroup в true . Дополнительно вы можете установить поле useOnly RecordingStrategy в ALL_SUPPORTED_RESOURCE_TYPES .
Примечание
Если вы установите это поле в false , но перечислите глобальные типы ресурсов IAM в поле resourceTypes RecordingGroup , Config по-прежнему будет записывать изменения конфигурации для этих указанных типов ресурсов, независимо от того, установлено ли поле includeGlobalResourceTypes в false.
Если вы не хотите записывать изменения конфигурации для глобальных типов ресурсов IAM (пользователи IAM, группы, роли и управляемые клиентом политики), убедитесь, что вы не перечисляете их в поле resourceTypes, а также установили поле includeGlobalResourceTypes в false.
resourceTypes -> (список)
Список, разделенный запятыми, который указывает типы ресурсов, которые Config записывает.
Список допустимых значений resourceTypes см. в столбце Значение типа ресурса в таблице Поддерживаемые Amazon Web Services типы ресурсов в руководстве разработчика Config .
Примечание
Дополнительно вы можете установить поле useOnly RecordingStrategy в INCLUSION_BY_RESOURCE_TYPES .
Чтобы записать все изменения конфигурации, установите поле allSupported RecordingGroup в true и либо опустите это поле, либо не указывайте никаких типов ресурсов в этом поле. Если вы установите поле allSupported в false и укажете значения для resourceTypes , при добавлении Config поддержки нового типа ресурса он не будет записывать ресурсы этого типа, пока вы вручную не добавите этот тип в вашу группу записи.
Примечание
Перед указанием типа ресурса для отслеживания Config проверьте Доступность покрытия ресурсов по регионам, чтобы увидеть, поддерживается ли тип ресурса в Amazon Web Services-регионе, где вы настраиваете Config. Если тип ресурса поддерживается Config хотя бы в одном регионе, вы можете включить запись этого типа ресурса во всех поддерживаемых Config регионах, даже если указанный тип ресурса не поддерживается в Amazon Web Services-регионе, где вы настраиваете Config.
(строка)
exclusionByResourceTypes -> (структура)
Объект, который указывает, как Config исключает типы ресурсов из записи записывателем конфигурации.
Примечание
Чтобы использовать этот параметр, необходимо установить поле useOnly RecordingStrategy в EXCLUSION_BY_RESOURCE_TYPES .
resourceTypes -> (список)
Список типов ресурсов, разделенных запятыми, которые необходимо исключить из записи записывателем конфигурации.
(строка)
recordingStrategy -> (структура)
Объект, определяющий стратегию записи для регистратора конфигурации.
- Если вы установите поле
useOnlyRecordingStrategy вALL_SUPPORTED_RESOURCE_TYPES, Config записывает изменения конфигурации для всех поддерживаемых типов ресурсов, за исключением глобальных типов ресурсов IAM. Вам также необходимо установить полеallSupportedRecordingGroup в значениеtrue. При добавлении Config поддержки нового типа ресурса, Config автоматически начинает запись ресурсов этого типа. - Если вы установите поле
useOnlyRecordingStrategy в значениеINCLUSION_BY_RESOURCE_TYPES, Config записывает изменения конфигурации только для тех типов ресурсов, которые вы укажете в полеresourceTypesRecordingGroup. - Если вы установите поле
useOnlyRecordingStrategy в значениеEXCLUSION_BY_RESOURCE_TYPES, Config записывает изменения конфигурации для всех поддерживаемых типов ресурсов, за исключением типов ресурсов, которые вы укажете для исключения из записи в полеresourceTypesExclusionByResourceTypes.
Примечание
Поле recordingStrategy необязательно, когда вы устанавливаете поле allSupported RecordingGroup в значение true.
Поле recordingStrategy необязательно, когда вы указываете типы ресурсов в поле resourceTypes RecordingGroup.
Поле recordingStrategy обязательно, если вы указываете типы ресурсов для исключения из записи в поле resourceTypes ExclusionByResourceTypes.
Примечание
Если вы выберете EXCLUSION_BY_RESOURCE_TYPES для стратегии записи, поле exclusionByResourceTypes переопределит другие свойства в запросе.
Например, даже если вы установите includeGlobalResourceTypes в значение false, глобальные типы ресурсов IAM по-прежнему будут автоматически записываться в этом варианте, если эти типы ресурсов не указаны как исключения в поле resourceTypes exclusionByResourceTypes.
Примечание
По умолчанию, если вы выберете стратегию записи EXCLUSION_BY_RESOURCE_TYPES, при добавлении Config поддержки нового типа ресурса в регионе, где вы настроили регистратор конфигурации, включая глобальные типы ресурсов, Config автоматически начинает запись ресурсов этого типа.
Если эти типы ресурсов не указаны в качестве исключений, AWS::RDS::GlobalCluster будут автоматически записаны во всех поддерживаемых регионах Config, где включен регистратор конфигурации.
Пользователи, группы, роли и управляемые клиентом политики IAM будут записаны в регионе, где вы настроили регистратор конфигурации, если этот регион поддерживал Config до февраля 2022 года. Вы не можете записывать глобальные типы ресурсов IAM в регионах, поддерживаемых Config после февраля 2022 года. Список регионов, в которых нельзя записывать глобальные типы ресурсов IAM, см. в разделе Запись ресурсов Amazon Web Services | Глобальные ресурсы.
useOnly -> (string)
Стратегия записи для регистратора конфигурации.
- Если вы выберете этот параметр в значение
ALL_SUPPORTED_RESOURCE_TYPES, Config записывает изменения конфигурации для всех поддерживаемых типов ресурсов, за исключением глобальных типов ресурсов IAM. Вам также необходимо установить полеallSupportedRecordingGroup в значениеtrue. При добавлении Config поддержки нового типа ресурса, Config автоматически начинает запись ресурсов этого типа. Список поддерживаемых типов ресурсов см. в руководстве разработчика Config в разделе Поддерживаемые типы ресурсов. - Если вы выберете этот параметр в значение
INCLUSION_BY_RESOURCE_TYPES, Config записывает изменения конфигурации только для тех типов ресурсов, которые вы укажете в полеresourceTypesRecordingGroup. - Если вы выберете этот параметр в значение
EXCLUSION_BY_RESOURCE_TYPES, Config записывает изменения конфигурации для всех поддерживаемых типов ресурсов, за исключением типов ресурсов, которые вы укажете для исключения из записи в полеresourceTypesExclusionByResourceTypes.
Примечание
Поле recordingStrategy необязательно, когда вы устанавливаете поле allSupported RecordingGroup в значение true.
Поле recordingStrategy необязательно, когда вы указываете типы ресурсов в поле resourceTypes RecordingGroup.
Поле recordingStrategy обязательно, если вы указываете типы ресурсов для исключения из записи в поле resourceTypes ExclusionByResourceTypes.
Примечание
Если вы выберете EXCLUSION_BY_RESOURCE_TYPES для стратегии записи, поле exclusionByResourceTypes переопределит другие свойства в запросе.
Например, даже если вы установите includeGlobalResourceTypes в значение false, глобальные типы ресурсов IAM по-прежнему будут автоматически записываться в этом варианте, если эти типы ресурсов не указаны как исключения в поле resourceTypes exclusionByResourceTypes.
Примечание
По умолчанию, если вы выберете стратегию записи EXCLUSION_BY_RESOURCE_TYPES, при добавлении Config поддержки нового типа ресурса в регионе, где вы настроили регистратор конфигурации, включая глобальные типы ресурсов, Config автоматически начинает запись ресурсов этого типа.
Если эти типы ресурсов не указаны в качестве исключений, AWS::RDS::GlobalCluster будут автоматически записаны во всех поддерживаемых регионах Config, где включен регистратор конфигурации.
Пользователи, группы, роли и управляемые клиентом политики IAM будут записаны в регионе, где вы настроили регистратор конфигурации, если этот регион поддерживал Config до февраля 2022 года. Вы не можете записывать глобальные типы ресурсов IAM в регионах, поддерживаемых Config после февраля 2022 года. Этот список регионов включает:
- Азиатско-Тихоокеанский регион (Гидарабад)
- Азиатско-Тихоокеанский регион (Мельбурн)
- Западная Канада (Калгари)
- Европа (Испания)
- Европа (Цюрих)
- Израиль (Тель-Авив)
- Ближний Восток (ОАЭ)
recordingMode -> (structure)
Определяет стандартную частоту записи для регистратора конфигурации. Config поддерживает непрерывную запись и ежедневную запись.
- Непрерывная запись позволяет записывать изменения конфигурации непрерывно всякий раз, когда происходит изменение.
- Ежедневная запись позволяет получать элемент конфигурации (CI), представляющий последнее состояние ваших ресурсов за последние 24 часа, только если он отличается от предыдущего записанного CI.
Примечание
Firewall Manager зависит от непрерывной записи для мониторинга ваших ресурсов. Если вы используете Firewall Manager, рекомендуется установить частоту записи в значение Непрерывная.
Вы также можете переопределить частоту записи для определенных типов ресурсов.
recordingFrequency -> (string)
Стандартная частота записи, которую Config использует для записи изменений конфигурации.
Предупреждение
Ежедневная запись не может быть указана для следующих типов ресурсов:
AWS::Config::ResourceComplianceAWS::Config::ConformancePackComplianceAWS::Config::ConfigurationRecorder
Для стратегии записи allSupported (ALL_SUPPORTED_RESOURCE_TYPES ) эти типы ресурсов будут установлены в непрерывную запись.
recordingModeOverrides -> (list)
Массив объектов recordingModeOverride для указания переопределений режима записи. Объект recordingModeOverride в массиве recordingModeOverrides состоит из трех полей: description, нового значения recordingFrequency и массива resourceTypes для переопределения.
(structure)
Объект для указания переопределений режима записи.
description -> (string)
resourceTypes -> (list)
Список, разделяемый запятыми, который определяет типы ресурсов, которые Config включает в переопределение.
Предупреждение
Ежедневная запись не может быть указана для следующих типов ресурсов:
AWS::Config::ResourceComplianceAWS::Config::ConformancePackComplianceAWS::Config::ConfigurationRecorder
(string)
recordingFrequency -> (string)
Частота записи, которая будет применена ко всем типам ресурсов, указанным в переопределении.
- Непрерывная запись позволяет записывать изменения конфигурации непрерывно всякий раз, когда происходит изменение.
- Ежедневная запись позволяет получать элемент конфигурации (CI), представляющий последнее состояние ваших ресурсов за последние 24 часа, только если он отличается от предыдущего записанного CI.
Примечание
Firewall Manager зависит от непрерывной записи для мониторинга ваших ресурсов. Если вы используете Firewall Manager, рекомендуется установить частоту записи в значение Непрерывная.recordingScope -> (string)
INTERNAL) или это влияет на ваши затраты (PAID).servicePrincipal -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.