Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

put-remediation-configurations

Описание

Добавляет или обновляет конфигурацию исправления с определённым правилом Config с выбранной целью или действием. API создаёт объект RemediationConfiguration для правила Config. Правило Config должно уже существовать, чтобы вы могли добавить конфигурацию исправления. Цель (документ SSM) должна существовать и иметь разрешения на использование цели.

Примечание

Обратите внимание на изменения, несовместимые с предыдущими версиями

Если вы внесли изменения в документ SSM, несовместимые с предыдущими версиями, вам необходимо снова вызвать этот API, чтобы убедиться, что исправления могут выполняться.

Этот API не поддерживает добавление конфигураций исправления для правил Config, связанных с сервисом, таких как правила Config организации, правила, развернутые пакетами соответствия, и правила, развернутые Amazon Web Services Security Hub.

Примечание

Необходимые поля

Для ручного исправления конфигурации необходимо указать значение для automationAssumeRole или использовать значение в поле assumeRole для исправления ваших ресурсов. Документ автоматизации SSM может использовать любое из них, если оно сопоставляется с допустимым параметром.

Однако для автоматической конфигурации исправления единственное допустимое значение поля assumeRole — AutomationAssumeRole, и вам необходимо указать значение для AutomationAssumeRole для исправления ваших ресурсов.

Примечание

Автоматическое исправление может быть инициировано даже для соответствующих ресурсов

Если вы включите автоматическое исправление для определённого правила Config с помощью API PutRemediationConfigurations или консоли Config, это инициирует процесс исправления для всех несоответствующих ресурсов для этого правила. Процесс автоматического исправления полагается на снимок данных соответствия, который фиксируется периодически. Любой несоответствующий ресурс, обновлённый между расписаниями снимков, будет продолжать исправляться на основе последнего известного снимка данных соответствия.

Это означает, что в некоторых случаях автоматическое исправление может быть инициировано даже для соответствующих ресурсов, так как загрузчик использует базу данных, которая может содержать устаревшие результаты оценки на основе последнего известного снимка данных соответствия.

См. также: AWS API Documentation

Синопсис

  put-remediation-configurations
--remediation-configurations <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]

Параметры

--remediation-configurations (список)

Список объектов конфигурации исправления.

(структура)

Объект, представляющий подробности о конфигурации исправления, включающей действие исправления, параметры и данные для выполнения действия.

ConfigRuleName -> (строка)

Имя правила Config.

TargetType -> (строка)

Тип цели. Цель выполняет исправление. Например, документ SSM.

TargetId -> (строка)

ID цели — имя документа SSM.

TargetVersion -> (строка)

Версия цели. Например, версия документа SSM.

Примечание

Если вы внесли изменения в документ SSM, несовместимые с предыдущими версиями, вам необходимо снова вызвать API PutRemediationConfiguration, чтобы убедиться, что исправления могут выполняться.

Parameters -> (карта)

Объект RemediationParameterValue.

key -> (строка)

value -> (структура)

Значение является динамическим (ресурсным) или статическим. Вы должны выбрать либо динамическое, либо статическое значение.

ResourceValue -> (структура)

Значение динамическое и изменяется во время выполнения.

Value -> (строка)

Значение — это идентификатор ресурса.

StaticValue -> (структура)

Значение статическое и не изменяется во время выполнения.

Values -> (список)

Список значений. Например, ARN предполагаемой роли.

(строка)

ResourceType -> (строка)

Тип ресурса.

Automatic -> (булево)

Исправление запускается автоматически.

ExecutionControls -> (структура)

Объект ExecutionControls.

SsmControls -> (структура)

Объект SsmControls.

ConcurrentExecutionRatePercentage -> (целое число)

Максимальный процент действий исправления, которые разрешено выполнять параллельно над несоответствующими ресурсами для данного правила. Вы можете указать процент, например, 10%. Значение по умолчанию — 10.

ErrorPercentage -> (целое число)

Процент ошибок, разрешённых перед тем, как SSM прекратит выполнение автоматизаций над несоответствующими ресурсами для данного правила. Вы можете указать процент ошибок, например, 10%. Если вы не указываете процент, значение по умолчанию — 50%. Например, если вы установите ErrorPercentage в 40% для 10 несоответствующих ресурсов, то SSM прекратит выполнение автоматизаций, когда будет получена пятая ошибка.

MaximumAutomaticAttempts -> (целое число)

Максимальное количество неудачных попыток автоматического исправления. Если вы не указываете число, значение по умолчанию — 5.

Например, если вы укажете MaximumAutomaticAttempts как 5 с RetryAttemptSeconds как 50 секунд, Config добавит RemediationException от вашего имени для неисправного ресурса после 5-й неудачной попытки в течение 50 секунд.

RetryAttemptSeconds -> (длинное целое)

Временной интервал для определения того, следует ли добавлять исключение исправления, чтобы предотвратить бесконечные попытки исправления. Если MaximumAutomaticAttempts попыток исправления были сделаны в течение RetryAttemptSeconds, будет добавлено исключение исправления для ресурса. Если вы не указываете число, значение по умолчанию — 60 секунд.

Например, если вы укажете RetryAttemptSeconds как 50 секунд и MaximumAutomaticAttempts как 5, Config выполнит автоматические исправления 5 раз в течение 50 секунд, прежде чем добавить исключение исправления для ресурса.

Arn -> (строка)

Amazon Resource Name (ARN) конфигурации исправления.

CreatedByService -> (строка)

Имя службы, владеющей правилом, связанным с сервисом, если применимо.

Синтаксис JSON:

[
  {
    "ConfigRuleName": "string",
    "TargetType": "SSM_DOCUMENT",
    "TargetId": "string",
    "TargetVersion": "string",
    "Parameters": {"string": {
          "ResourceValue": {
            "Value": "RESOURCE_ID"
          },
          "StaticValue": {
            "Values": ["string", ...]
          }
        }
      ...},
    "ResourceType": "string",
    "Automatic": true|false,
    "ExecutionControls": {
      "SsmControls": {
        "ConcurrentExecutionRatePercentage": integer,
        "ErrorPercentage": integer
      }
    },
    "MaximumAutomaticAttempts": integer,
    "RetryAttemptSeconds": long,
    "Arn": "string",
    "CreatedByService": "string"
  }
  ...
]

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/отключить вывод цвета.

  • on
  • off
  • auto

--no-sign-request (булево)

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

--ca-bundle (строка)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

--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.

Вывод

FailedBatches -> (список)

Возвращает список объектов необработанных партий исправления.

(структура)

Список каждого из необработанных исправлений с конкретными причинами.

FailureMessage -> (строка)

Возвращает сообщение об ошибке. Например, ресурс уже соответствует требованиям.

FailedItems -> (список)

Возвращает конфигурации исправления для необработанных элементов.

(структура)

Объект, представляющий детали конфигурации исправления, включающей действие исправления, параметры и данные для выполнения действия.

ConfigRuleName -> (строка)

Имя правила Config.

TargetType -> (строка)

Тип целевого объекта. Целевой объект выполняет исправление. Например, документ SSM.

TargetId -> (строка)

Идентификатор целевого объекта — это имя документа SSM.

TargetVersion -> (строка)

Версия целевого объекта. Например, версия документа SSM.

Примечание

Если вы внесли несовместимые изменения в документ SSM, необходимо снова вызвать API PutRemediationConfiguration, чтобы убедиться, что исправления могут выполняться.

Parameters -> (карта)

Объект RemediationParameterValue.

ключ -> (строка)

значение -> (структура)

Значение — это динамическое (ресурсное) значение или статическое значение. Вы должны выбрать либо динамическое, либо статическое значение.

ResourceValue -> (структура)

Значение динамическое и изменяется во время выполнения.

Значение -> (строка)

Значение — это идентификатор ресурса.

StaticValue -> (структура)

Значение статическое и не изменяется во время выполнения.

Значения -> (список)

Список значений. Например, ARN предположительно используемой роли.

(строка)

ResourceType -> (строка)

Тип ресурса.

Automatic -> (булево)

Исправление запускается автоматически.

ExecutionControls -> (структура)

Объект ExecutionControls.

SsmControls -> (структура)

Объект SsmControls.

ConcurrentExecutionRatePercentage -> (целое число)

Максимальный процент действий исправления, которые разрешено выполнять параллельно на несоответствующих ресурсах для данного правила. Вы можете указать процент, например, 10%. Значение по умолчанию — 10.

ErrorPercentage -> (целое число)

Процент ошибок, которые разрешено допустить, прежде чем SSM прекратит запуск автоматизаций на несоответствующих ресурсах для данного правила. Вы можете указать процент ошибок, например, 10%. Если вы не укажете процент, значение по умолчанию — 50%. Например, если вы установите ErrorPercentage в 40% для 10 несоответствующих ресурсов, SSM прекратит запуск автоматизаций при получении пятой ошибки.

MaximumAutomaticAttempts -> (целое число)

Максимальное количество неудачных попыток автоматического исправления. Если вы не выберете число, значение по умолчанию — 5.

Например, если вы укажете MaximumAutomaticAttempts как 5 с RetryAttemptSeconds как 50 секунд, Config добавит RemediationException от вашего имени для неисправного ресурса после пятой неудачной попытки в течение 50 секунд.

RetryAttemptSeconds -> (длинное целое число)

Временной интервал для определения того, следует ли добавлять исключение исправления, чтобы предотвратить бесконечные попытки исправления. Если MaximumAutomaticAttempts попыток исправления были предприняты в течение RetryAttemptSeconds, исключение исправления будет добавлено к ресурсу. Если вы не выберете число, значение по умолчанию — 60 секунд.

Например, если вы укажете RetryAttemptSeconds как 50 секунд и MaximumAutomaticAttempts как 5, Config выполнит автоматические исправления 5 раз в течение 50 секунд, прежде чем добавить исключение исправления к ресурсу.

Arn -> (строка)

Amazon Resource Name (ARN) конфигурации исправления.

CreatedByService -> (строка)

Имя службы, владеющей правилом, связанным со службой, если применимо.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API