Spec-Zone.ru › AWS CLI v2

[ aws . osis ]

создание-пайплайна

Описание

Создаёт пайплайн погрузки OpenSearch. Дополнительная информация: Создание пайплайнов погрузки Amazon OpenSearch .

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

Синтаксис

  create-pipeline
--pipeline-name <value>
--min-units <value>
--max-units <value>
--pipeline-configuration-body <value>
[--log-publishing-options <value>]
[--vpc-options <value>]
[--buffer-options <value>]
[--encryption-at-rest-options <value>]
[--tags <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 (строка)

Имя создаваемого пайплайна погрузки OpenSearch. Имена пайплайнов уникальны для пайплайнов, принадлежащих учётной записи в регионе Amazon Web Services.

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

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

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

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

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

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

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

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

IsLoggingEnabled -> (булево)

Включает/выключает публикацию журналов.

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

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

LogGroup -> (строка)

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

Упрощённый синтаксис:

IsLoggingEnabled=boolean,CloudWatchLogDestination={LogGroup=string}

Синтаксис JSON:

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

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

Контейнер для значений, необходимых для настройки доступа VPC для пайплайна. Если вы не укажете эти значения, OpenSearch Ingestion создаст пайплайн с общедоступным конечным пунктом.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Параметры подключения VPC к пайплайну.

AttachToVpc -> (булево)

Подключить VPC к пайплайну.

CidrBlock -> (строка)

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

VpcEndpointManagement -> (строка)

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

Упрощённый синтаксис:

SubnetIds=string,string,SecurityGroupIds=string,string,VpcAttachmentOptions={AttachToVpc=boolean,CidrBlock=string},VpcEndpointManagement=string

Синтаксис JSON:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...],
  "VpcAttachmentOptions": {
    "AttachToVpc": true|false,
    "CidrBlock": "string"
  },
  "VpcEndpointManagement": "CUSTOMER"|"SERVICE"
}

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

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

PersistentBufferEnabled -> (булево)

Включить постоянную буферизацию.

Упрощённый синтаксис:

PersistentBufferEnabled=boolean

Синтаксис JSON:

{
  "PersistentBufferEnabled": true|false
}

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

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

KmsKeyArn -> (строка)

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

Упрощённый синтаксис:

KmsKeyArn=string

Синтаксис JSON:

{
  "KmsKeyArn": "string"
}

--tags (список)

Список тегов для добавления к пайплайну при создании.

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

Упрощённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 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.

Вывод

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

Контейнер для информации о созданном потоке.

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

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

PipelineArn -> (строка)

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

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

Минимальная пропускная способность потока в Ingestion Compute Units (ICU).

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

Максимальная пропускная способность потока в Ingestion Compute Units (ICU).

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

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

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

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

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

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

PipelineConfigurationBody -> (строка)

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

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

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

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

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

IngestEndpointUrls -> (список)

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

(строка)

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

Параметры публикации логов.

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

Включить или отключить публикацию логов.

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

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

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

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

VpcEndpoints -> (список)

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

(структура)

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

VpcEndpointId -> (строка)

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

VpcId -> (строка)

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

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

ПодключитьКVpc -> (булево)

Подключен ли VPC к потоку.

CidrBlock -> (строка)

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

VpcEndpointManagement -> (строка)

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

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

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

PersistentBufferEnabled -> (булево)

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

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

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

KmsKeyArn -> (строка)

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

VpcEndpointService -> (строка)

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

ServiceVpcEndpoints -> (список)

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

(структура)

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

ИмяСлужбы -> (строка)

Имя службы, для которой была создана VPC-точка входа.

VpcEndpointId -> (строка)

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

Destinations -> (список)

Назначение для записи данных потоком.

(структура)

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

ИмяСлужбы -> (строка)

Имя службы, получающей данные от потока.

Endpoint -> (строка)

Точка входа, получающая данные от потока.

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

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

(структура)

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

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

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

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

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

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

Spec-Zone.ru

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