Spec-Zone.ru › AWS CLI v2

[ aws . networkflowmonitor ]

создание-области

Описание

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

При создании области вы предоставляете разрешения для монитора сетевого потока. Область устанавливается на ресурсы Amazon Web Services, которые поддерживают эту функцию.

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

Синтаксис

  create-scope
--targets <value>
[--client-token <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]

Параметры

--targets (список)

Цели для определения области, которая должна отслеживаться. В настоящее время цель — это учетная запись Amazon Web Services.

(структура)

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

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

Идентификатор цели — это пара идентификационной информации для ресурса, включенного в цель. Идентификатор цели включает идентификатор цели и тип цели.

targetId -> (структура помеченного союза)

Идентификатор цели.

Примечание

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

accountId -> (строка)

Идентификатор учетной записи для цели.

targetType -> (строка)

Тип цели. Тип цели в настоящее время всегда ACCOUNT, так как цель в настоящее время — это одна учетная запись Amazon Web Services.

region -> (строка)

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

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

targetIdentifier={targetId={accountId=string},targetType=string},region=string ...

Синтаксис JSON:

[
  {
    "targetIdentifier": {
      "targetId": {
        "accountId": "string"
      },
      "targetType": "ACCOUNT"
    },
    "region": "string"
  }
  ...
]

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

Уникальная, чувствительная к регистру строка длиной до 64 ASCII-символов, которую вы указываете для выполнения идемпотентного запроса API. Не используйте один и тот же маркер клиента для других запросов API.

--tags (массив)

Теги для области. Вы можете добавить максимум 200 тегов.

key -> (строка)

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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования по типу Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Для создания области

Следующий create-scope пример создает область, которая включает набор ресурсов, для которых монитор сетевого трафика будет генерировать метрики сетевого трафика.

aws networkflowmonitor create-scope \
    --targets '[{"targetIdentifier":{"targetId":{"accountId":"123456789012"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'

Вывод:

{
    "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615",
    "status": "IN_PROGRESS",
    "tags": {}
}

Дополнительную информацию см. в разделе «Компоненты и функции монитора сетевого потока» в Руководстве пользователя Amazon CloudWatch.

Вывод

scopeId -> (строка)

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

status -> (строка)

Статус вызова для создания области. Статус может быть одним из следующих: SUCCEEDED , IN_PROGRESS или FAILED.

scopeArn -> (строка)

Идентификатор ресурса Amazon (ARN) области.

tags -> (массив)

Теги для области.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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