Spec-Zone.ru › AWS CLI v2

[ aws . amp ]

create-scraper

Описание

Операция CreateScraper создаёт сканер для сбора метрик. Сканер собирает метрики из совместимых с Prometheus источников внутри кластера Amazon EKS и отправляет их в ваше рабочее пространство Amazon Managed Service for Prometheus. Сканеры гибкие и позволяют настроить сбор определённых метрик, частоту сбора, применение преобразований к метрикам и многое другое.

Для вас будет создана роль IAM, которую Amazon Managed Service for Prometheus использует для доступа к метрикам в вашем кластере. Вы должны настроить эту роль с политикой, разрешающей сбор метрик из вашего кластера. Дополнительную информацию см. в разделе Настройка вашего кластера Amazon EKS в руководстве пользователя Amazon Managed Service for Prometheus.

Параметр scrapeConfiguration содержит закодированную в base-64 конфигурацию сканера в формате YAML.

При создании сканера служба создаёт Network Interface в каждой зоне доступности, которые передаются в CreateScraper через подсети. Эти сетевые интерфейсы используются для подключения к кластеру Amazon EKS внутри VPC для сбора метрик.

Примечание

Дополнительную информацию о коллекторах, включая собираемые метрики и настройку сканера, см. в разделе Использование управляемого коллектора Amazon Web Services в руководстве пользователя Amazon Managed Service for Prometheus.

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

Синтаксис

  create-scraper
[--alias <value>]
[--client-token <value>]
--destination <value>
[--role-configuration <value>]
--scrape-configuration <value>
--source <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]

Параметры

--alias (строка)

(необязательно) Псевдоним, который будет присвоен сканеру. Это для вашего удобства и не обязательно должен быть уникальным.

--client-token (строка)

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

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

Рабочее пространство Amazon Managed Service for Prometheus, в которое будут отправляться метрики.

Примечание

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

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

Рабочее пространство Amazon Managed Service for Prometheus, в которое будут отправляться метрики.

workspaceArn -> (строка)

ARN рабочего пространства Amazon Managed Service for Prometheus.

Краткая запись:

ampConfiguration={workspaceArn=string}

Синтаксис JSON:

{
  "ampConfiguration": {
    "workspaceArn": "string"
  }
}

--role-configuration (структура)

Используйте эту структуру, чтобы включить доступ между учётными записями, позволяя использовать целевую учётную запись для доступа к метрикам Prometheus из исходных учётных записей.

sourceRoleArn -> (строка)

Amazon Resource Name (ARN) роли, используемой в исходной учётной записи для включения межсчётного сбора. Для получения информации о содержимом этой политики, см. Настройка межсчётного взаимодействия.

targetRoleArn -> (строка)

Amazon Resource Name (ARN) роли, используемой в целевой учётной записи для включения межсчётного сбора. Для получения информации о содержимом этой политики, см. Настройка межсчётного взаимодействия.

Краткая запись:

sourceRoleArn=string,targetRoleArn=string

Синтаксис JSON:

{
  "sourceRoleArn": "string",
  "targetRoleArn": "string"
}

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

Файл конфигурации, который будет использоваться в новом сканере. Дополнительную информацию см. в разделе Конфигурация сканера в руководстве пользователя Amazon Managed Service for Prometheus.

Примечание

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

configurationBlob -> (байтовый массив)

Файл конфигурации сбора, закодированный в base 64.

Краткая запись:

configurationBlob=blob

Синтаксис JSON:

{
  "configurationBlob": blob
}

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

Кластер Amazon EKS, из которого сканер будет собирать метрики.

Примечание

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

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

Кластер Amazon EKS, из которого сканер собирает метрики.

clusterArn -> (строка)

ARN кластера Amazon EKS.

securityGroupIds -> (список)

Список идентификаторов групп безопасности для конфигурации VPC кластера Amazon EKS.

(строка)

Идентификатор группы безопасности VPC.

subnetIds -> (список)

Список идентификаторов подсетей для конфигурации VPC кластера Amazon EKS.

(строка)

Идентификатор подсети VPC.

Краткая запись:

eksConfiguration={clusterArn=string,securityGroupIds=[string,string],subnetIds=[string,string]}

Синтаксис JSON:

{
  "eksConfiguration": {
    "clusterArn": "string",
    "securityGroupIds": ["string", ...],
    "subnetIds": ["string", ...]
  }
}

--tags (массив)

(Необязательно) Список ключей и значений тегов, которые нужно ассоциировать со сканером.

key -> (строка)

Ключ тега. Не должен начинаться с aws: .

value -> (строка)

Значение тега.

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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.

Вывод

arn -> (строка)

Amazon Resource Name (ARN) нового сканера.

scraperId -> (строка)

Идентификатор нового сканера.

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

Структура, отображающая текущее состояние сканера.

statusCode -> (строка)

Текущее состояние сканера.

tags -> (массив)

Список ключей и значений тегов, связанных со сканером.

key -> (строка)

Ключ тега. Не должен начинаться с aws: .

value -> (строка)

Значение тега.

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

Spec-Zone.ru

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