Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

update-rule

Описание

Обновляет указанное правило для слушателя. Вы не можете изменить правило для слушателя по умолчанию. Чтобы изменить правило для слушателя по умолчанию, используйте UpdateListener .

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

Синтаксис

  update-rule
[--action <value>]
--listener-identifier <value>
[--match <value>]
[--priority <value>]
--rule-identifier <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]

Параметры

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

Информация об действии для указанного правила слушателя.

Примечание

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

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

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

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

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

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

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

targetGroups -> (список)

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

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

(структура)

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

targetGroupIdentifier -> (строка)

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

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

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

Синтаксис JSON:

{
  "fixedResponse": {
    "statusCode": integer
  },
  "forward": {
    "targetGroups": [
      {
        "targetGroupIdentifier": "string",
        "weight": integer
      }
      ...
    ]
  }
}

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

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

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

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

Примечание

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

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

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

headerMatches -> (список)

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

(структура)

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

caseSensitive -> (булево)

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

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

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

Примечание

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

contains -> (строка)

Соответствие типа contains.

exact -> (строка)

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

prefix -> (строка)

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

name -> (строка)

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

method -> (строка)

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

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

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

caseSensitive -> (булево)

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

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

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

Примечание

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

exact -> (строка)

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

prefix -> (строка)

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

Синтаксис JSON:

{
  "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 (целое число)

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

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

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

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

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

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

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

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

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

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

targetGroups -> (список)

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

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

(структура)

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

targetGroupIdentifier -> (строка)

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

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

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

arn -> (строка)

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

id -> (строка)

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

isDefault -> (булево)

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

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

Совпадение правила.

Примечание

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

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

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

headerMatches -> (список)

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

(структура)

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

caseSensitive -> (булево)

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

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

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

Примечание

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

contains -> (строка)

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

exact -> (строка)

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

prefix -> (строка)

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

name -> (строка)

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

method -> (строка)

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

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

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

caseSensitive -> (булево)

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

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

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

Примечание

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

exact -> (строка)

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

prefix -> (строка)

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

name -> (строка)

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

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

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

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

Spec-Zone.ru

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