Spec-Zone.ru › AWS CLI v2

[ aws . osis ]

обновить-пайплайн

Описание

Обновляет пайплайн OpenSearch Ingestion. Более подробную информацию можно найти в разделе Обновление пайплайнов Amazon OpenSearch Ingestion.

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

Синтаксис

  update-pipeline
--pipeline-name <value>
[--min-units <value>]
[--max-units <value>]
[--pipeline-configuration-body <value>]
[--log-publishing-options <value>]
[--buffer-options <value>]
[--encryption-at-rest-options <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]

Параметры

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

Имя пайплайна для обновления.

--min-units (целое число)

Минимальная емкость пайплайна в единицах вычислительной мощности Ingestion (ICU).

--max-units (целое число)

Максимальная емкость пайплайна в единицах вычислительной мощности Ingestion (ICU).

--pipeline-configuration-body (строка)

Конфигурация пайплайна в формате YAML. Команда принимает конфигурацию пайплайна как строку или в файле .yaml. Если вы предоставляете конфигурацию в виде строки, каждая новая строка должна быть экранирована с помощью \n.

--log-publishing-options (структура)

Параметры для настройки публикации логов.

IsLoggingEnabled -> (булево)

Следует ли публиковать логи.

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

Назначение для логов OpenSearch Ingestion, отправленных в Amazon CloudWatch Logs. Этот параметр необходим, если IsLoggingEnabled установлено в true.

LogGroup -> (строка)

Имя группы CloudWatch Logs для отправки логов пайплайна. Вы можете указать существующую группу логов или создать новую. Например, /aws/vendedlogs/OpenSearchService/pipelines.

Сокращенная запись:

IsLoggingEnabled=boolean,CloudWatchLogDestination={LogGroup=string}

Синтаксис JSON:

{
  "IsLoggingEnabled": true|false,
  "CloudWatchLogDestination": {
    "LogGroup": "string"
  }
}

--buffer-options (структура)

Параметры для настройки постоянного буферирования для пайплайна.

PersistentBufferEnabled -> (булево)

Следует ли включить постоянное буферирование.

Сокращенная запись:

PersistentBufferEnabled=boolean

Синтаксис JSON:

{
  "PersistentBufferEnabled": true|false
}

--encryption-at-rest-options (структура)

Параметры для настройки шифрования данных, записываемых в постоянный буфер.

KmsKeyArn -> (строка)

ARN ключа KMS, используемого для шифрования данных буфера. По умолчанию данные шифруются с использованием ключа, принадлежащего Amazon Web Services.

Сокращенная запись:

KmsKeyArn=string

Синтаксис JSON:

{
  "KmsKeyArn": "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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

Поток -> (структура)

Контейнер для информации об обновлённом потоке.

ИмяПотока -> (строка)

Название потока.

ArnПотока -> (строка)

Amazon Resource Name (ARN) потока.

МинЕдиницы -> (целое число)

Минимальная ёмкость потока в единицах вычислений приема (ICU).

МаксЕдиницы -> (целое число)

Максимальная ёмкость потока в единицах вычислений приема (ICU).

Статус -> (строка)

Текущий статус потока.

ПричинаСтатуса -> (структура)

Причина текущего статуса потока.

Описание -> (строка)

Описание причины статуса потока.

ТелоКонфигурацииПотока -> (строка)

Конфигурация потока Data Prepper в формате YAML.

Создан -> (метка времени)

Дата и время создания потока.

ПоследнееОбновление -> (метка времени)

Дата и время последнего обновления потока.

UrlsТочекВвода -> (список)

Точки ввода потока, в которые вы можете отправлять данные.

(строка)

ПараметрыОпубликованияЛогов -> (структура)

Параметры публикации логов в формате ключ-значение.

ВключитьЛогирование -> (булево)

Должны ли публиковаться логи?

НазначениеCloudWatchЛогов -> (структура)

Назначение для логов OpenSearch Ingestion, отправленных в Amazon CloudWatch Logs. Этот параметр требуется, если IsLoggingEnabled установлено в true .

ГруппаЛогов -> (строка)

Имя группы CloudWatch Logs, в которую будут отправляться логи потока. Вы можете указать существующую группу логов или создать новую. Например, /aws/vendedlogs/OpenSearchService/pipelines .

VpcТочки -> (список)

VPC интерфейсные точки, имеющие доступ к потоку.

(структура)

Управляемая OpenSearch Ingestion VPC-точка, которая будет обращаться к одному или нескольким потокам.

IdТочкиVpc -> (строка)

Уникальный идентификатор точки.

IdVpc -> (строка)

Идентификатор вашей VPC. Amazon Web Services PrivateLink генерирует это значение при создании VPC.

ПараметрыVpc -> (структура)

Информация о VPC, включая связанные подсети и группы безопасности.

IdПодсетей -> (список)

Список идентификаторов подсетей, связанных с VPC-точкой.

(строка)

IdГруппБезопасности -> (список)

Список групп безопасности, связанных с VPC-точкой.

(строка)

ПараметрыПрисоединенияVpc -> (структура)

Параметры присоединения VPC к потоку.

ПрисоединитьКVpc -> (булево)

Присоединена ли VPC к потоку?

БлокCidr -> (строка)

Блок CIDR, который будет зарезервирован для OpenSearch Ingestion для создания интерфейсов сети (ENIs).

УправлениеVpcТочкой -> (строка)

Определяет, создаёте вы или служба Amazon OpenSearch Ingestion VPC-точку, настроенную для потока.

ПараметрыБуфера -> (структура)

Параметры, которые определяют конфигурацию постоянного буфера. Чтобы настроить, как OpenSearch Ingestion шифрует эти данные, установите EncryptionAtRestOptions . Дополнительную информацию см. в разделе Постоянное буферирование.

ВключитьПостоянныйБуфер -> (булево)

Включить постоянное буферирование?

ПараметрыШифрованияВОтдыхе -> (структура)

Параметры для управления тем, как OpenSearch шифрует данные буфера.

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

ARN KMS-ключа, используемого для шифрования данных буфера. По умолчанию данные шифруются с помощью ключа, принадлежащего Amazon Web Services.

ИмяСервисаVpcТочки -> (строка)

Имя службы VPC-точки для потока.

ServiceVpcEndpoints -> (список)

Список VPC-точек, которые OpenSearch Ingestion создал для других сервисов Amazon Web Services.

(структура)

Контейнер для информации о VPC-точках, созданных для других сервисов

НазваниеСервиса -> (строка)

Название сервиса, для которого была создана VPC-точка.

IdТочкиVpc -> (строка)

Уникальный идентификатор созданной VPC-точки.

ПунктыНазначения -> (список)

Пункты назначения, в которые поток записывает данные.

(структура)

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

НазваниеСервиса -> (строка)

Название сервиса, получающего данные из потока.

КонечнаяТочка -> (строка)

Конечная точка, получающая данные из потока.

Теги -> (список)

Список тегов, связанных с данным потоком.

(структура)

Тег (пара ключ-значение) для потока OpenSearch Ingestion.

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

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

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

Значение, назначенное соответствующему ключу тега. Значения тегов могут быть null и не обязательно должны быть уникальными в наборе тегов. Например, вы можете иметь пару ключ-значение в наборе тегов project : Trinity и cost-center : Trinity

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

Spec-Zone.ru

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