Spec-Zone.ru › AWS CLI v2

[ aws . журналы ]

put-transformer

Описание

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

После создания трансформатора CloudWatch Logs выполняет преобразования в момент поступления журнала. Затем вы можете обратиться к преобразованным версиям журналов во время операций, таких как запросы с помощью CloudWatch Logs Insights или создание фильтров метрик или фильтров подписок.

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

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

Наличие событий журналов в стандартизированном формате обеспечивает видимость по всем вашим приложениям для анализа журналов, составления отчётов и обработки событий тревоги. CloudWatch Logs предоставляет трансформацию для распространённых типов журналов с готовыми шаблонами преобразования для основных источников журналов Amazon Web Services, таких как журналы потоков VPC, Lambda и Amazon RDS. Вы можете использовать готовые шаблоны преобразования или создавать пользовательские политики преобразования.

Вы можете создавать трансформаторы только для групп журналов в стандартном классе журналов.

Вы также можете настроить трансформатор на уровне учетной записи. Дополнительную информацию см. в разделе PutAccountPolicy . Если существует трансформатор на уровне группы журналов, созданный с помощью PutTransformer, и трансформатор на уровне учетной записи, который мог бы применяться к той же группе журналов, группа журналов использует только трансформатор на уровне группы журналов. Он игнорирует трансформатор на уровне учетной записи.

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

Синтаксис

  put-transformer
--log-group-identifier <value>
--transformer-config <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 (строка)

Укажите имя или ARN группы журналов, для которой нужно создать трансформатор.

--transformer-config (список)

Эта структура содержит конфигурацию этого трансформатора журналов. Трансформатор журналов представляет собой массив процессоров, где каждый процессор применяет один тип преобразования к событиям журналов, которые поступают.

(структура)

Эта структура содержит информацию об одном процессоре в преобразователе логов.

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

Используйте этот параметр для включения процессора addKeys в ваш преобразователь.

entries -> (список)

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

(структура)

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

key -> (строка)

Ключ новой записи, которая будет добавлена в событие лога

value -> (строка)

Значение новой записи, которая будет добавлена в событие лога

overwriteIfExists -> (логическое значение)

Указывает, следует ли перезаписывать значение, если ключ уже существует в событии лога. Если вы опустите этот параметр, по умолчанию используется значение false.

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

Используйте этот параметр для включения процессора copyValue в ваш преобразователь.

entries -> (список)

Массив CopyValueEntry объектов, где каждый объект содержит информацию об одном значении поля для копирования.

(структура)

Этот объект определяет одно значение, которое будет скопировано процессором copyValue.

source -> (строка)

Ключ для копирования.

target -> (строка)

Ключ поля, в которое будет скопировано значение.

overwriteIfExists -> (логическое значение)

Указывает, следует ли перезаписывать значение, если ключ назначения уже существует. Если вы опустите этот параметр, по умолчанию используется значение false.

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

Используйте этот параметр для включения процессора CSV в ваш преобразователь.

quoteCharacter -> (строка)

Символ, используемый в качестве квалификатора текста для отдельного столбца данных. Если вы опустите этот параметр, используется двойная кавычка ".

delimiter -> (строка)

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

columns -> (список)

Массив имён, которые следует использовать для столбцов в преобразованном событии лога.

Если вы опустите этот параметр, используются значения по умолчанию [column_1, column_2 ...].

(строка)

source -> (строка)

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

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

Используйте этот параметр для включения процессора datetimeConverter в ваш преобразователь.

source -> (строка)

Ключ, к которому применяется преобразование даты.

target -> (строка)

Поле JSON для хранения результата.

targetFormat -> (строка)

Формат даты и времени для преобразованных данных в целевом поле.

Если вы опустите этот параметр, используется значение по умолчанию yyyy-MM-dd'T'HH:mm:ss.SSS'Z.

matchPatterns -> (список)

Список шаблонов для сопоставления с полем source.

(строка)

sourceTimezone -> (строка)

Временная зона исходного поля. Если вы опустите этот параметр, используется временная зона UTC.

targetTimezone -> (строка)

Временная зона целевого поля. Если вы опустите этот параметр, используется временная зона UTC.

locale -> (строка)

Локаль исходного поля. Если вы опустите этот параметр, используется значение по умолчанию locale.ROOT.

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

Используйте этот параметр для включения процессора deleteKeys в ваш преобразователь.

withKeys -> (список)

Список ключей для удаления.

(строка)

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

Используйте этот параметр для включения процессора grok в ваш преобразователь.

source -> (строка)

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

match -> (строка)

Шаблон grok для сопоставления с событием лога. Список поддерживаемых шаблонов grok см. в разделе Поддерживаемые шаблоны grok.

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

Используйте этот параметр для включения процессора listToMap в ваш преобразователь.

source -> (строка)

Ключ в событии лога, содержащий список объектов, которые будут преобразованы в карту.

key -> (строка)

Ключ поля, который будет извлечён в качестве ключей в сгенерированной карте.

valueKey -> (строка)

Если это значение указано, значения, которые вы указываете в этом параметре, будут извлечены из объектов source и помещены в значения сгенерированной карты. В противном случае, исходные объекты из списка source будут помещены в значения сгенерированной карты.

target -> (строка)

Ключ поля, которое будет содержать сгенерированную карту.

flatten -> (логическое значение)

Логическое значение, указывающее, будет ли список сглажен в отдельные элементы. Укажите true, чтобы сгладить список. По умолчанию значение false.

flattenedElement -> (строка)

Если вы установите flatten в true, используйте flattenedElement, чтобы указать, какой элемент, first или last, сохранить.

Вы должны указать этот параметр, если flatten равно true.

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

Используйте этот параметр для включения процессора lowerCaseString в ваш преобразователь.

withKeys -> (список)

Массив, содержащий ключи полей, которые нужно преобразовать в нижний регистр.

(строка)

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

Используйте этот параметр для включения процессора moveKeys в ваш преобразователь.

entries -> (список)

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

(структура)

Этот объект определяет один ключ, который будет перемещён процессором moveKey.

source -> (строка)

Ключ для перемещения.

target -> (строка)

Ключ для перемещения.

overwriteIfExists -> (логическое значение)

Указывает, следует ли перезаписывать значение, если ключ назначения уже существует. Если вы опустите этот параметр, по умолчанию используется значение false.

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

Используйте этот параметр для включения процессора parseCloudfront в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым в вашем преобразователе.

source -> (строка)

Опустите этот параметр, и всё сообщение лога будет обработано этим процессором. Для source разрешено только значение @message.

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

Используйте этот параметр для включения процессора parseJSON в ваш преобразователь.

source -> (строка)

Путь к полю в событии лога, которое будет обработано. Используйте нотацию точек для доступа к дочерним полям. Например, store.book

destination -> (строка)

Место размещения пар ключ-значение, полученных после разбора. Если вы опустите этот параметр, он будет размещён на корневом узле.

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

Используйте этот параметр для включения процессора parseKeyValue в ваш преобразователь.

source -> (строка)

Путь к полю в событии лога, которое будет обработано. Используйте нотацию точек для доступа к дочерним полям. Например, store.book

destination -> (строка)

Целевое поле для размещения извлечённых пар ключ-значение.

fieldDelimiter -> (строка)

Строка-разделитель поля, используемая между парами ключ-значение в исходных событиях логов. Если вы опустите этот параметр, будет использоваться амперсанд &.

keyValueDelimiter -> (строка)

Строка-разделитель, используемая между ключом и значением в каждой паре в преобразованном событии лога.

Если вы опустите этот параметр, будет использоваться знак равенства =.

keyPrefix -> (строка)

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

nonMatchValue -> (строка)

Значение для вставки в поле значения в результате, когда пара ключ-значение не разделяется успешно.

overwriteIfExists -> (логическое значение)

Указывает, следует ли перезаписывать значение, если целевой ключ уже существует. Если вы опустите этот параметр, по умолчанию используется значение false.

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

Используйте этот параметр для включения процессора parseRoute53 в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым в вашем преобразователе.

source -> (строка)

Опустите этот параметр, и всё сообщение лога будет обработано этим процессором. Для source разрешено только значение @message.

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

Используйте этот параметр для включения процессора parsePostGres в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым в вашем преобразователе.

source -> (строка)

Опустите этот параметр, и всё сообщение лога будет обработано этим процессором. Для source разрешено только значение @message.

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

Используйте этот параметр для включения процессора parseVPC в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым в вашем преобразователе.

source -> (строка)

Опустите этот параметр, и всё сообщение лога будет обработано этим процессором. Для source разрешено только значение @message.

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

Используйте этот параметр для включения процессора parseWAF в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым в вашем преобразователе.

source -> (строка)

Опустите этот параметр, и всё сообщение лога будет обработано этим процессором. Для source разрешено только значение @message.

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

Используйте этот параметр для включения процессора renameKeys в ваш преобразователь.

entries -> (список)

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

(структура)

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

key -> (строка)

Ключ для переименования.

renameTo -> (строка)

Строка, используемая для нового имени ключа.

overwriteIfExists -> (логическое значение)

Указывает, следует ли перезаписывать существующее значение, если целевой ключ уже существует. По умолчанию используется значение false.

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

Используйте этот параметр для включения процессора splitString в ваш преобразователь.

entries -> (список)

Массив SplitStringEntry объектов, где каждый объект содержит информацию об одном поле для разделения.

(структура)

Этот объект определяет одно поле лога, которое будет разделено процессором splitString.

source -> (строка)

Ключ поля для разделения.

delimiter -> (строка)

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

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

Используйте этот параметр, чтобы включить процессор substituteString в ваш трансформер.

entries -> (список)

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

(структура)

Этот объект определяет один ключ поля журнала, который будет заменён с помощью процессора substituteString.

source -> (строка)

Ключ для изменения

from -> (строка)

Строка регулярного выражения, подлежащая замене. Специальные символы regex, такие как [ и ], должны быть экранированы с помощью \ при использовании двойных кавычек и с помощью \ при использовании одинарных кавычек. Для получения дополнительной информации см. раздел Class Pattern на веб-сайте Oracle.

to -> (строка)

Строка, которая будет заменена на каждый совпадение from

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

Используйте этот параметр, чтобы включить процессор trimString в ваш трансформер.

withKeys -> (список)

Массив, содержащий ключи полей, которые нужно обрезать.

(строка)

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

Используйте этот параметр, чтобы включить процессор typeConverter в ваш трансформер.

entries -> (список)

Массив TypeConverterEntry объектов, где каждый объект содержит информацию об одном поле, тип которого нужно изменить.

(структура)

Этот объект определяет один тип значения, который будет преобразован с помощью процессора typeConverter.

key -> (строка)

Ключ со значением, которое нужно преобразовать в другой тип.

type -> (строка)

Тип, в который нужно преобразовать значение поля. Допустимые значения — integer , double , string и boolean .

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

Используйте этот параметр, чтобы включить процессор upperCaseString в ваш трансформер.

withKeys -> (список)

Массив, содержащий ключи полей, которые нужно преобразовать в верхний регистр.

(строка)

Синтаксис JSON:

[
  {
    "addKeys": {
      "entries": [
        {
          "key": "string",
          "value": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "copyValue": {
      "entries": [
        {
          "source": "string",
          "target": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "csv": {
      "quoteCharacter": "string",
      "delimiter": "string",
      "columns": ["string", ...],
      "source": "string"
    },
    "dateTimeConverter": {
      "source": "string",
      "target": "string",
      "targetFormat": "string",
      "matchPatterns": ["string", ...],
      "sourceTimezone": "string",
      "targetTimezone": "string",
      "locale": "string"
    },
    "deleteKeys": {
      "withKeys": ["string", ...]
    },
    "grok": {
      "source": "string",
      "match": "string"
    },
    "listToMap": {
      "source": "string",
      "key": "string",
      "valueKey": "string",
      "target": "string",
      "flatten": true|false,
      "flattenedElement": "first"|"last"
    },
    "lowerCaseString": {
      "withKeys": ["string", ...]
    },
    "moveKeys": {
      "entries": [
        {
          "source": "string",
          "target": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "parseCloudfront": {
      "source": "string"
    },
    "parseJSON": {
      "source": "string",
      "destination": "string"
    },
    "parseKeyValue": {
      "source": "string",
      "destination": "string",
      "fieldDelimiter": "string",
      "keyValueDelimiter": "string",
      "keyPrefix": "string",
      "nonMatchValue": "string",
      "overwriteIfExists": true|false
    },
    "parseRoute53": {
      "source": "string"
    },
    "parsePostgres": {
      "source": "string"
    },
    "parseVPC": {
      "source": "string"
    },
    "parseWAF": {
      "source": "string"
    },
    "renameKeys": {
      "entries": [
        {
          "key": "string",
          "renameTo": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "splitString": {
      "entries": [
        {
          "source": "string",
          "delimiter": "string"
        }
        ...
      ]
    },
    "substituteString": {
      "entries": [
        {
          "source": "string",
          "from": "string",
          "to": "string"
        }
        ...
      ]
    },
    "trimString": {
      "withKeys": ["string", ...]
    },
    "typeConverter": {
      "entries": [
        {
          "key": "string",
          "type": "boolean"|"integer"|"double"|"string"
        }
        ...
      ]
    },
    "upperCaseString": {
      "withKeys": ["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
  • текст
  • таблица
  • 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 (булево)

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

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров CLI.

Вывод

Нет

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

Spec-Zone.ru

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