Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

создать-группу

Описание

Создаёт ресурс группы с именем и выражением фильтра.

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

Синтаксис

  create-group
--group-name <value>
[--filter-expression <value>]
[--insights-configuration <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]

Параметры

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

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

--filter-expression (строка)

Выражение фильтра, определяющее критерии группировки трасс.

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

Структура, содержащая настройки, связанные с инсайтами.

  • Логический параметр InsightsEnabled можно установить в значение true для включения инсайтов для новой группы или в значение false для отключения инсайтов для новой группы.
  • Логический параметр NotificationsEnabled можно установить в значение true для включения уведомлений об инсайтах для новой группы. Уведомления могут быть включены только для группы с InsightsEnabled, установленным в значение true.

InsightsEnabled -> (логическое значение)

Установите значение InsightsEnabled в true для включения инсайтов или в false для их отключения.

NotificationsEnabled -> (логическое значение)

Установите значение NotificationsEnabled в true для включения уведомлений об инсайтах. Уведомления могут быть включены только для группы с InsightsEnabled, установленным в значение true.

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

InsightsEnabled=boolean,NotificationsEnabled=boolean

Синтаксис JSON:

{
  "InsightsEnabled": true|false,
  "NotificationsEnabled": true|false
}

--tags (список)

Карта, содержащая один или несколько ключей и значений тегов для прикрепления к группе X-Ray. Дополнительная информация о способах использования тегов приведена в разделе «Использование тегов ресурсов Amazon Web Services» в «Общие сведения об Amazon Web Services».

Для тегов действуют следующие ограничения:

  • Максимальное количество пользовательских тегов на ресурс: 50
  • Максимальная длина ключа тега: 128 символов Юникода
  • Максимальная длина значения тега: 256 символов Юникода
  • Допустимые значения для ключа и значения: a-z, A-Z, 0-9, пробел и следующие символы: _ . : / = + - и @
  • Ключи и значения тегов регистрозависимы.
  • Не используйте aws: в качестве префикса ключей; он зарезервирован для использования Amazon Web Services.

(структура)

Карта, содержащая ключи и значения тегов для прикрепления к группе Amazon Web Services X-Ray или правилу выборки. Дополнительная информация о способах использования тегов приведена в разделе «Использование тегов ресурсов Amazon Web Services» в «Общие сведения об Amazon Web Services».

Для тегов действуют следующие ограничения:

  • Максимальное количество пользовательских тегов на ресурс: 50
  • Ключи и значения тегов регистрозависимы.
  • Не используйте aws: в качестве префикса ключей; он зарезервирован для использования Amazon Web Services. Вы не можете изменять или удалять системные теги.

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

Ключ тега, такой как Stage или Name. Ключ тега не может быть пустым. Длина ключа может составлять максимум 128 символов и содержать только буквы, цифры Юникода или разделители, или следующие специальные символы: + - = . _ : /

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

Необязательное значение тега, такое как Production или test-only. Длина значения может составлять максимум 255 символов и содержать только буквы, цифры Юникода или разделители, или следующие специальные символы: + - = . _ : /

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

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.

Примеры

Примечание

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

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

Для создания группы

Следующий create-group пример создаёт ресурс группы с именем AdminGroup. Группа получает выражение фильтра, определяющее критерии группы как сегмента, относящегося к определённому сервису, вызвавшему ошибку или сбой.

aws xray create-group \
   --group-name "AdminGroup" \
   --filter-expression "service(\"mydomain.com\") {fault OR error}"

Вывод:

{
    "GroupName": "AdminGroup",
    "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789",
    "FilterExpression": "service(\"mydomain.com\") {fault OR error}"
}

Для получения дополнительной информации см. «Настройка выборки, групп и параметров шифрования с помощью API AWS X-Ray» в «Руководстве разработчика AWS X-Ray».

Вывод

Группа -> (структура)

Созданная группа. Содержит имя созданной группы, Amazon Resource Name (ARN) сгенерированной группы на основе имени группы, выражение фильтра и настройки инсайтов, назначенные группе.

ИмяГруппы -> (строка)

Уникальное регистрозависимое имя группы.

ARNГруппы -> (строка)

Amazon Resource Name (ARN) группы, сгенерированный на основе имениГруппы.

ВыражениеФильтра -> (строка)

Выражение фильтра, определяющее параметры включения трасс.

НастройкиИнсайтов -> (структура)

Структура, содержащая настройки, связанные с инсайтами.

  • Логическое значение InsightsEnabled можно установить в true для включения инсайтов для группы или в false для их отключения для группы.
  • Логическое значение NotificationsEnabled можно установить в true для включения уведомлений об инсайтах через Amazon EventBridge для группы.

InsightsEnabled -> (логическое значение)

Установите значение InsightsEnabled в true для включения инсайтов или в false для их отключения.

NotificationsEnabled -> (логическое значение)

Установите значение NotificationsEnabled в true для включения уведомлений об инсайтах. Уведомления могут быть включены только для группы с InsightsEnabled, установленным в значение true.

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

Spec-Zone.ru

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