Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

batch-update-rule

Описание

Обновляет правила прослушивателя в пакетном режиме. Можно использовать эту операцию для изменения приоритета правил прослушивателя. Это может быть полезно при пакетном обновлении или переключении приоритета правил.

Требуемые разрешения: vpc-lattice:UpdateRule

Дополнительную информацию см. в разделе Как Amazon VPC Lattice работает с IAM в руководстве пользователя Amazon VPC Lattice.

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

Синтаксис

  batch-update-rule
--listener-identifier <value>
--rules <value>
--service-identifier <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]

Параметры

--listener-identifier (строка)

Идентификатор или ARN прослушивателя.

--rules (список)

Правила для указанного прослушивателя.

(структура)

Описание обновления правила.

action -> (меченый объединяющий структуру)

Действие правила.

Примечание

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

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

Действие с фиксированным ответом. Правило возвращает пользовательский HTTP-ответ.

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

Код HTTP-ответа.

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

Действие переадресации. Трафик, соответствующий правилу, перенаправляется в указанные группы целевых серверов.

targetGroups -> (список)

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

Значение по умолчанию равно 1. Это означает, что если указана только одна целевая группа, нет необходимости устанавливать вес; 100% трафика идет в эту целевую группу.

(структура)

Описание веса целевой группы.

targetGroupIdentifier -> (строка)

Идентификатор или ARN целевой группы.

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

Требуется только если вы указываете несколько целевых групп для действия переадресации. Вес определяет, как запросы распределяются по целевой группе. Например, если вы укажете две целевые группы, каждая с весом 10, каждая целевая группа получает половину запросов. Если вы укажете две целевые группы, одна с весом 10, а другая с весом 20, целевая группа с весом 20 получает в два раза больше запросов, чем другая целевая группа. Если указана только одна целевая группа, значение по умолчанию равно 100.

match -> (меченый объединяющий структуру)

Сопоставление правила.

Примечание

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

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

Критерии HTTP, которым должно соответствовать правило.

headerMatches -> (список)

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

(структура)

Описание ограничений для соответствия заголовку. Сопоставляет входящие запросы с правилом на основе значения заголовка запроса перед применением действия правила.

caseSensitive -> (булево)

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

match -> (меченый объединяющий структуру)

Тип сопоставления заголовка.

Примечание

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

contains -> (строка)

Сопоставление типа «содержит».

exact -> (строка)

Точное сопоставление.

prefix -> (строка)

Сопоставление по префиксу. Сопоставляет значение с префиксом.

name -> (строка)

Имя заголовка.

method -> (строка)

Тип HTTP-метода.

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

Сопоставление пути.

caseSensitive -> (булево)

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

match -> (меченый объединяющий структуру)

Тип сопоставления пути.

Примечание

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

exact -> (строка)

Точное совпадение пути.

prefix -> (строка)

Сопоставление по префиксу пути.

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

Приоритет правила. У прослушивателя не может быть нескольких правил с одинаковым приоритетом.

ruleIdentifier -> (строка)

Идентификатор или ARN правила.

Синтаксис JSON:

[
  {
    "action": {
      "fixedResponse": {
        "statusCode": integer
      },
      "forward": {
        "targetGroups": [
          {
            "targetGroupIdentifier": "string",
            "weight": integer
          }
          ...
        ]
      }
    },
    "match": {
      "httpMatch": {
        "headerMatches": [
          {
            "caseSensitive": true|false,
            "match": {
              "contains": "string",
              "exact": "string",
              "prefix": "string"
            },
            "name": "string"
          }
          ...
        ],
        "method": "string",
        "pathMatch": {
          "caseSensitive": true|false,
          "match": {
            "exact": "string",
            "prefix": "string"
          }
        }
      }
    },
    "priority": integer,
    "ruleIdentifier": "string"
  }
  ...
]

--service-identifier (строка)

Идентификатор или ARN службы.

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

Выходные данные

успешные -> (список)

Правила, которые были успешно обновлены.

(структура)

Описание успешного обновления правила.

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

Действие для правила.

Примечание

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

фиксированныйОтвет -> (структура)

Действие фиксированного ответа. Правило возвращает пользовательский HTTP-ответ.

кодСостояния -> (целое число)

Код HTTP-ответа.

перенаправление -> (структура)

Действие перенаправления. Трафик, соответствующий правилу, перенаправляется на указанные целевые группы.

целевыеГруппы -> (список)

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

Значение по умолчанию равно 1. Это означает, что если указана только одна целевая группа, нет необходимости устанавливать вес; 100% трафика направляется в эту целевую группу.

(структура)

Описание веса целевой группы.

идентификаторЦелевойГруппы -> (строка)

Идентификатор или ARN целевой группы.

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

Требуется только если вы указываете несколько целевых групп для действия перенаправления. Вес определяет, как запросы распределяются по целевой группе. Например, если вы указываете две целевые группы, каждая с весом 10, каждая целевая группа получает половину запросов. Если вы указываете две целевые группы, одна с весом 10, а другая с весом 20, целевая группа с весом 20 получает в два раза больше запросов, чем другая целевая группа. Если указана только одна целевая группа, значение по умолчанию равно 100.

arn -> (строка)

Amazon Resource Name (ARN) слушателя.

id -> (строка)

Идентификатор слушателя.

isDefault -> (булево)

Указывает, является ли это правилом по умолчанию.

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

Соответствие правила.

Примечание

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

соответствиеHttp -> (структура)

HTTP-критерии, которым должно соответствовать правило.

соответствияЗаголовков -> (список)

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

(структура)

Описание ограничений для соответствия заголовку. Сопоставляет входящие запросы с правилом на основе значения заголовка запроса перед применением действия правила.

чувствительностьКРегистру -> (булево)

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

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

Тип соответствия заголовка.

Примечание

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

содержит -> (строка)

Соответствие типа содержит.

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

Совпадение точного типа.

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

Совпадение типа префикс. Сопоставляет значение с префиксом.

название -> (строка)

Имя заголовка.

метод -> (строка)

Тип HTTP-метода.

соответствиеПути -> (структура)

Соответствие пути.

чувствительностьКРегистру -> (булево)

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

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

Тип соответствия пути.

Примечание

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

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

Точное соответствие пути.

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

Соответствие префиксу пути.

имя -> (строка)

Имя слушателя.

приоритет -> (целое число)

Приоритет правила.

неуспешные -> (список)

Правила, которые операция не смогла обновить.

(структура)

Описание обновления правила, которое завершилось ошибкой.

кодОшибки -> (строка)

Код ошибки.

сообщениеОбОшибке -> (строка)

Сообщение об ошибке.

идентификаторПравила -> (строка)

Идентификатор или ARN правила.

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

Spec-Zone.ru

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