Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

создать-входящее-соединение

Описание

Создает новое межкластерное поисковое соединение от источника Amazon OpenSearch Service домена до целевого домена. Дополнительную информацию см. в разделе Поиск межкластеров для Amazon OpenSearch Service.

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

Синтаксис

  create-outbound-connection
--local-domain-info <value>
--remote-domain-info <value>
--connection-alias <value>
[--connection-mode <value>]
[--connection-properties <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]

Параметры

--local-domain-info (структура)

Имя и регион исходного (локального) домена.

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

Информация о домене Amazon OpenSearch Service.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services владельца домена.

DomainName -> (строка)

Имя домена.

Region -> (строка)

Регион Amazon Web Services, в котором находится домен.

Краткий синтаксис:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

Синтаксис JSON:

{
  "AWSDomainInformation": {
    "OwnerId": "string",
    "DomainName": "string",
    "Region": "string"
  }
}

--remote-domain-info (структура)

Имя и регион целевого (удаленного) домена.

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

Информация о домене Amazon OpenSearch Service.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services владельца домена.

DomainName -> (строка)

Имя домена.

Region -> (строка)

Регион Amazon Web Services, в котором находится домен.

Краткий синтаксис:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

Синтаксис JSON:

{
  "AWSDomainInformation": {
    "OwnerId": "string",
    "DomainName": "string",
    "Region": "string"
  }
}

--connection-alias (строка)

Имя соединения.

--connection-mode (строка)

Режим соединения.

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

  • DIRECT
  • VPC_ENDPOINT

--connection-properties (структура)

Свойства ConnectionProperties для исходящего соединения.

Endpoint -> (строка)

Предупреждение

Атрибут Endpoint изменить нельзя.

Конечная точка удаленного домена. Применимо для режима соединения VPC_ENDPOINT.

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

Свойства соединения для межкластерного поиска.

SkipUnavailable -> (строка)

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

Краткий синтаксис:

Endpoint=string,CrossClusterSearch={SkipUnavailable=string}

Синтаксис JSON:

{
  "Endpoint": "string",
  "CrossClusterSearch": {
    "SkipUnavailable": "ENABLED"|"DISABLED"
  }
}

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод кли-паджера.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Информация о домене источника (локальном).

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

Информация о домене Amazon OpenSearch Service.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services владельца домена.

DomainName -> (строка)

Имя домена.

Region -> (строка)

Регион Amazon Web Services, в котором расположен домен.

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

Информация о домене назначения (удаленном).

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

Информация о домене Amazon OpenSearch Service.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services владельца домена.

DomainName -> (строка)

Имя домена.

Region -> (строка)

Регион Amazon Web Services, в котором расположен домен.

ConnectionAlias -> (строка)

Имя подключения.

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

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

StatusCode -> (строка)

Код статуса исходящего подключения. Может быть одним из следующих:

  • VALIDATING - Запрос на исходящее подключение проходит валидацию.
  • VALIDATION_FAILED - Валидация запроса на подключение не удалась.
  • PENDING_ACCEPTANCE: Запрос на исходящее подключение валидирован и еще не принят владельцем удаленного домена.
  • APPROVED - Исходящее подключение одобрено владельцем удаленного домена для подготовки.
  • PROVISIONING - Запрос на исходящее подключение находится в процессе обработки.
  • ACTIVE - Исходящее подключение активно и готово к использованию.
  • REJECTING - Отклонение исходящего подключения владельцем удаленного домена находится в процессе.
  • REJECTED - Запрос на исходящее подключение отклонен владельцем удаленного домена.
  • DELETING - Удаление исходящего подключения находится в процессе.
  • DELETED - Исходящее подключение удалено и больше не может быть использовано.

Message -> (строка)

Подробная информация об исходящем подключении.

ConnectionId -> (строка)

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

ConnectionMode -> (строка)

Режим подключения.

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

ConnectionProperties для нового созданного подключения.

Endpoint -> (строка)

Предупреждение

Атрибут Endpoint изменить нельзя.

Конечная точка удаленного домена. Применимо для режима подключения VPC_ENDPOINT.

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

Свойства подключения для межкластерного поиска.

SkipUnavailable -> (строка)

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

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

Spec-Zone.ru

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