put-index-policy

Описание

Создаёт или обновляет политику индексации полей для указанной группы журналов. Политики индексации полей поддерживаются только для групп журналов в стандартном классе журналов. Подробнее о классах журналов см. в разделе Классы журналов.

Политики индексации полей позволяют создавать индексы полей, содержащихся в событиях журналов в группе журналов. Создание индексов полей ускоряет и снижает стоимость запросов CloudWatch Logs Insights, ссылающихся на эти индексы полей, поскольку эти запросы пытаются пропустить обработку событий журналов, которые, как известно, не соответствуют индексируемому полю. Хорошими полями для индексации являются поля, которые часто требуются для запросов, и поля или значения, которые соответствуют лишь небольшой части всех событий журналов. Типичные примеры индексов включают идентификатор запроса, идентификатор сеанса, идентификатор пользователя и идентификаторы экземпляров. Дополнительную информацию см. в разделе Создание индексов полей для повышения производительности запросов и снижения затрат.

Для поиска полей в событиях вашей группы журналов используйте операцию GetLogGroupFields.

Например, предположим, что вы создали индекс поля для requestId. Тогда любой запрос CloudWatch Logs Insights для этой группы журналов, включающий requestId = *value* `` or ``requestId IN [*value* , *value* , ...], будет обрабатывать меньше событий журналов для снижения затрат и повышения производительности.

Каждая политика индексации имеет следующие квоты и ограничения:

• В политику можно включить не более 20 полей.
• Каждое имя поля может содержать не более 100 символов.

Сопоставления событий журналов с именами индексируемых полей регистрозависимые. Например, индекс поля RequestId не будет соответствовать событию журнала, содержащему requestId.

Политики индексации полей на уровне группы журналов, созданные с помощью PutIndexPolicy, переопределяют политики индексации полей на уровне учётной записи, созданные с помощью PutAccountPolicy. Если вы используете PutIndexPolicy для создания политики индексации полей для группы журналов, эта группа журналов использует только эту политику. Группа журналов игнорирует любую политику индексации полей на уровне учётной записи, которую вы могли создать.

См. также: Документация по API AWS

Синтаксис

  put-index-policy
--log-group-identifier <value>
--policy-document <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]

Параметры

--log-group-identifier (строка)

--policy-document (строка)

--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
• текст
• таблица
• 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичными данными, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинатор командной строки для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запрошение параметров ввода командной строки.

Вывод

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