Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

create-rule

Описание

Создаёт правило прослушивателя. Каждый прослушиватель имеет правило по умолчанию для проверки запросов соединений, но вы можете определить дополнительные правила. Каждое правило состоит из приоритета, одного или нескольких действий и одного или нескольких условий. Дополнительную информацию см. в разделе «Правила прослушивателей» в руководстве пользователя Amazon VPC Lattice.

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

Синтаксис

  create-rule
--action <value>
[--client-token <value>]
--listener-identifier <value>
--match <value>
--name <value>
--priority <value>
--service-identifier <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]

Параметры

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

Действие для правила по умолчанию.

Примечание

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

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

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

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

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

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

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

targetGroups -> (список)

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

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

(структура)

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

targetGroupIdentifier -> (строка)

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

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

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

Синтаксис JSON:

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

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы гарантировать идемпотентность запроса. Если вы повторно отправляете запрос, который был успешно выполнен с использованием того же маркера клиента и параметров, повторная отправка завершается успешно без выполнения каких-либо действий. Если параметры не идентичны, повторная отправка завершается неудачно.

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

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

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

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

Примечание

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

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

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

headerMatches -> (список)

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

(структура)

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

caseSensitive -> (булево)

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

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

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

Примечание

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

contains -> (строка)

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

exact -> (строка)

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

prefix -> (строка)

Соответствие типа 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"
      }
    }
  }
}

--name (строка)

Имя правила. Имя должно быть уникальным в пределах прослушивателя. Допустимые символы — a-z, 0-9 и дефисы (-). Дефис не может быть первым или последним символом, или сразу после другого дефиса.

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

Приоритет, назначенный правилу. Каждое правило для конкретного прослушивателя должно иметь уникальный приоритет. Чем меньше номер приоритета, тем выше приоритет.

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

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

--tags (массив)

Теги для правила.

key -> (строка)

Ключ тега.

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

value -> (строка)

Значение тега.

Ограничения: Значения тегов чувствительны к регистру и принимают максимум 256 символов Юникода. Допустимыми символами являются буквы Юникода, цифры, пробелы и следующие символы: _ . : / = + - @

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

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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

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

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

Примечание

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

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

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

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

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

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

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

targetGroups -> (список)

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

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

(структура)

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

targetGroupIdentifier -> (строка)

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

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

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

arn -> (строка)

Amazon Resource Name (ARN) правила.

id -> (строка)

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

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

Сопоставление правила. RuleMatch должно быть HttpMatch. Это означает, что правило должно быть точным соответствием HTTP-ограничениям, которые состоят из HTTP-метода, пути и заголовка.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых слов верхнего уровня: 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