Spec-Zone.ru › AWS CLI v2

[ aws . resource-groups ]

update-group-query

Описание

Обновляет запрос ресурсов для группы. Дополнительную информацию о запросах ресурсов см. в разделе Создание группы на основе тегов в Resource Groups.

Минимальные разрешения

Для выполнения этой команды требуется следующее разрешение:

  • resource-groups:UpdateGroupQuery

См. также: AWS API Documentation

Синтаксис

  update-group-query
[--group-name <value>]
[--group <value>]
--resource-query <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 (строка)

Не используйте этот параметр. Используйте Group вместо него.

--group (строка)

Имя или Amazon Resource Name (ARN) группы ресурсов для запроса.

--resource-query (структура)

Запрос ресурсов для определения, какие ресурсы Amazon Web Services являются членами этой группы ресурсов.

Примечание

Группа ресурсов может содержать либо Configuration, либо ResourceQuery, но не оба.

Тип -> (строка)

Тип запроса. Может принимать одно из двух значений:

  • *CLOUDFORMATION_STACK_1_0: * Указывает, что группа должна содержать членов стека CloudFormation. Query содержит элемент StackIdentifier с Amazon Resource Name (ARN) для стека CloudFormation.
  • *TAG_FILTERS_1_0: * Указывает, что группа должна включать ресурсы, имеющие теги, соответствующие запросу.

Запрос -> (строка)

Запрос, определяющий группу или поиск. Содержимое зависит от значения элемента Type.

  • ResourceTypeFilters – Применяется ко всем ResourceQuery объектам Type . Этот элемент содержит один из следующих двух элементов:
    • Значение AWS::AllSupported. Это заставляет ResourceQuery соответствовать ресурсам любого типа ресурсов, которые также соответствуют запросу.
    • Список (массив JSON) идентификаторов типов ресурсов, которые ограничивают запрос только ресурсами указанных типов. Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в руководстве Resource Groups User Guide в разделе Ресурсы, которые можно использовать с Resource Groups и редактором тегов.

Пример: "ResourceTypeFilters": ["AWS::AllSupported"] или "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

  • TagFilters – Применимо только если Type = TAG_FILTERS_1_0. Query содержит строку JSON, представляющую набор простых фильтров тегов. Строка JSON использует синтаксис, похожий на операцию ``GetResources``, но использует только поля ``ResourceTypeFilters`` и ``TagFilters``. Если вы укажете более одного ключа тега, в запросе будут возвращены только ресурсы, соответствующие всем ключам тегов и, по крайней мере, одному значению каждого указанного ключа тега. Если вы укажете более одного значения для ключа тега, ресурс соответствует фильтру, если у него есть значение ключа тега, соответствующее любому из указанных значений. Например, рассмотрим следующий пример запроса для ресурсов, имеющих два тега, Stage и Version, с двумя значениями каждый: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] Результаты этого запроса ресурсов могут включать следующее.
    • Инстанс Amazon EC2, у которого есть следующие два тега: {"Stage":"Deploy"} и {"Version":"2"}
    • Ведро S3, у которого есть следующие два тега: {"Stage":"Test"} и {"Version":"1"}

Однако результаты запроса ресурсов не будут включать следующие элементы.

  • Инстанс Amazon EC2, у которого есть только следующий тег: {"Stage":"Deploy"}. У инстанса нет всех ключей тегов, указанных в фильтре, поэтому он исключается из результатов.
  • База данных RDS, у которой есть следующие два тега: {"Stage":"Archived"} и {"Version":"4"}. У базы данных есть все ключи тегов, но ни один из этих ключей не имеет связанного значения, соответствующего хотя бы одному из указанных значений в фильтре.

Пример: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

  • StackIdentifier – Применимо только если Type = CLOUDFORMATION_STACK_1_0. Значение этого параметра — Amazon Resource Name (ARN) стека CloudFormation, ресурсы которого должны быть включены в группу.

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

Type=string,Query=string

Синтаксис JSON:

{
  "Type": "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0",
  "Query": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл с сертификатом корневого центра, который нужно использовать при проверке сертификатов 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.

Пример 1: Обновление запроса для группы ресурсов на основе тегов

Следующий пример update-group-query обновляет запрос, прикрепленный к указанной группе ресурсов на основе тегов.

aws resource-groups update-group-query \
    --group-name tbq-WebServer \
    --resource-query '{"Type":"TAG_FILTERS_1_0", "Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"}'

Вывод:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}

Дополнительную информацию см. в разделе Обновление групп в руководстве пользователя AWS Resource Groups.

Пример 2: Обновление запроса для группы ресурсов на основе стека CloudFormation

Следующий пример update-group-query обновляет запрос, прикрепленный к указанной группе ресурсов AWS CloudFormation на основе стека.

aws resource-groups update-group-query \
    --group-name cbq-CFNstackgroup \
    --resource-query '{"Type": "CLOUDFORMATION_STACK_1_0", "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'

Вывод:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
    }
}

Дополнительную информацию см. в разделе Обновление групп в руководстве пользователя AWS Resource Groups.

Результат

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

Обновленный запрос к ресурсу, связанный с группой ресурсов после обновления.

GroupName -> (строка)

Имя группы ресурсов, связанной с указанным запросом к ресурсу.

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

Запрос к ресурсу, определяющий, какие ресурсы Amazon Web Services являются членами связанной группы ресурсов.

Type -> (строка)

Тип запроса. Может принимать одно из двух значений:

  • *CLOUDFORMATION_STACK_1_0: * Указывает, что группа должна содержать члены стека CloudFormation. Query содержит элемент StackIdentifier с именем Amazon Resource Name (ARN) стека CloudFormation.
  • *TAG_FILTERS_1_0: * Указывает, что группа должна включать ресурсы, имеющие теги, соответствующие запросу.

Query -> (строка)

Запрос, определяющий группу или поиск. Содержимое зависит от значения элемента Type.

  • ResourceTypeFilters – Применяется ко всем ResourceQuery объектам либо Type. Этот элемент содержит одно из двух следующих значений:
    • Значение AWS::AllSupported. Это заставляет ResourceQuery соответствовать ресурсам любого типа ресурсов, которые также соответствуют запросу.
    • Список (массив JSON) идентификаторов типов ресурсов, ограничивающих запрос только ресурсами указанных типов. Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в разделе «Ресурсы, которые можно использовать с группами ресурсов и редактором тегов» в Руководстве пользователя по группам ресурсов.

Пример: "ResourceTypeFilters": ["AWS::AllSupported"] или "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

  • TagFilters – Применимо только в случае, если Type = TAG_FILTERS_1_0. Query содержит JSON-строку, представляющую набор простых фильтров тегов. JSON-строка использует синтаксис, похожий на операцию ``GetResources``, но использует только поля ``ResourceTypeFilters`` и ``TagFilters``. Если вы укажете более одного ключа тега, в запросе будут возвращены только ресурсы, соответствующие всем ключам тегов и по меньшей мере одному значению каждого указанного ключа тега. Если вы укажете более одного значения для ключа тега, ресурс соответствует фильтру, если у него есть значение ключа тега, соответствующее любому из указанных значений. Например, рассмотрим следующий пример запроса к ресурсам, имеющим два тега, Stage и Version, с двумя значениями каждый: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]. Результаты этого запроса к ресурсу могут включать следующее:
    • Инстанс Amazon EC2, имеющий следующие два тега: {"Stage":"Deploy"} и {"Version":"2"}
    • Ведро S3, имеющее следующие два тега: {"Stage":"Test"} и {"Version":"1"}

Однако результаты запроса к ресурсу не будут включать следующие элементы:

  • Инстанс Amazon EC2, имеющий только следующий тег: {"Stage":"Deploy"}. У инстанса нет всех указанных в фильтре ключей тега, поэтому он исключается из результатов.
  • База данных RDS, имеющая следующие два тега: {"Stage":"Archived"} и {"Version":"4"}. У базы данных есть все ключи тегов, но ни один из них не имеет соответствующего значения, совпадающего по меньшей мере с одним из указанных значений в фильтре.

Пример: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

  • StackIdentifier – Применимо только в случае, если Type = CLOUDFORMATION_STACK_1_0. Значение этого параметра — Amazon Resource Name (ARN) стека CloudFormation, ресурсы которого должны быть включены в группу.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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