Spec-Zone.ru › AWS CLI v2

[ aws . журнал ]

put-subscription-filter

Описание

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

Для фильтров подписки поддерживаются следующие места назначения:

  • Поток данных Amazon Kinesis, принадлежащий той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.
  • Логическое место назначения, созданное с помощью PutDestination, которое принадлежит другой учетной записи, для межсчетной доставки. В настоящее время мы поддерживаем Kinesis Data Streams и Firehose в качестве логических мест назначения.
  • Поток доставки Amazon Kinesis Data Firehose, принадлежащий той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.
  • Функция Lambda, принадлежащая той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.

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

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

Для выполнения операции PutSubscriptionFilter для любого места назначения, кроме функции Lambda, необходимо также иметь разрешение iam:PassRole.

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

Синтаксис

  put-subscription-filter
--log-group-name <value>
--filter-name <value>
--filter-pattern <value>
--destination-arn <value>
[--role-arn <value>]
[--distribution <value>]
[--apply-on-transformed-logs | --no-apply-on-transformed-logs]
[--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-name (строка)

Имя группы журналов.

--filter-name (строка)

Имя фильтра подписки. Если вы обновляете существующий фильтр, вы должны указать правильное имя в filterName. Чтобы найти имя фильтра, в настоящее время связанного с группой журналов, используйте DescribeSubscriptionFilters.

--filter-pattern (строка)

Шаблон фильтра для подписки на отфильтрованный поток событий журналов.

--destination-arn (строка)

ARN места назначения для доставки соответствующих событий журналов. В настоящее время поддерживаются следующие места назначения:

  • Поток Amazon Kinesis, принадлежащий той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.
  • Логическое место назначения (указанное с помощью ARN) из другой учетной записи для межсчетной доставки. Если вы настраиваете межсчетную подписку, место назначения должно иметь связанную с ним политику IAM. Политика IAM должна разрешать отправителю отправлять журналы в место назначения. Дополнительную информацию см. в разделе PutDestinationPolicy.
  • Поток доставки Kinesis Data Firehose, принадлежащий той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.
  • Функция Lambda, принадлежащая той же учетной записи, что и фильтр подписки, для доставки в рамках одной учетной записи.

--role-arn (строка)

ARN роли IAM, предоставляющей CloudWatch Logs разрешения на доставку поступивших событий журналов в поток назначения. Вам не нужно указывать ARN, когда вы работаете с логическим местом назначения для межсчетной доставки.

--distribution (строка)

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

Возможные значения:

  • Random
  • ByLogStream

--apply-on-transformed-logs | --no-apply-on-transformed-logs (булево)

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

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

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, 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