Spec-Zone.ru › AWS CLI v2

[ aws . журналы ]

put-integration

Описание

Создаёт интеграцию между CloudWatch Logs и другой службой в этом аккаунте. В настоящее время поддерживаются только интеграции с OpenSearch Service, и в данный момент в вашем аккаунте может быть только одна интеграция.

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

Данная операция может использоваться только для создания новой интеграции. Изменить существующую интеграцию нельзя.

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

Синтаксис

  put-integration
--integration-name <value>
--resource-config <value>
--integration-type <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]

Параметры

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

Имя интеграции.

--resource-config (структура помеченного объединения)

Структура, содержащая конфигурационную информацию для создаваемой интеграции.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: openSearchResourceConfig.

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

Эта структура содержит детали конфигурации интеграции между CloudWatch Logs и OpenSearch Service.

kmsKeyArn -> (строка)

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

dataSourceRoleArn -> (строка)

Укажите ARN роли IAM, которую CloudWatch Logs будет использовать для создания интеграции. Эта роль должна иметь необходимые разрешения для доступа к коллекции OpenSearch Service, чтобы создавать панели мониторинга. Для получения дополнительной информации о необходимых разрешениях, см. Разрешения, необходимые для интеграции в Руководстве пользователя CloudWatch Logs.

dashboardViewerPrincipals -> (список)

Укажите ARNs ролей IAM и пользователей IAM, которым вы хотите предоставить разрешения на просмотр панелей мониторинга.

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

В дополнение к указанию этих пользователей здесь, вы также должны предоставить им политику IAM CloudWatchOpenSearchDashboardAccess. Для получения дополнительной информации, см. Политики IAM для пользователей.

(строка)

applicationArn -> (строка)

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

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

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

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

openSearchResourceConfig={kmsKeyArn=string,dataSourceRoleArn=string,dashboardViewerPrincipals=[string,string],applicationArn=string,retentionDays=integer}

Синтаксис JSON:

{
  "openSearchResourceConfig": {
    "kmsKeyArn": "string",
    "dataSourceRoleArn": "string",
    "dashboardViewerPrincipals": ["string", ...],
    "applicationArn": "string",
    "retentionDays": integer
  }
}

--integration-type (строка)

Тип интеграции. В настоящее время поддерживается только тип OPENSEARCH.

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

  • OPENSEARCH

--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.

Вывод

integrationName -> (строка)

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

integrationStatus -> (строка)

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

После создания интеграции её завершение занимает несколько минут. В течение этого времени вы увидите состояние как PROVISIONING.

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

Spec-Zone.ru

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