Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

create-listener

Описание

Создает прослушиватель для сервиса. Прежде чем начать использовать ваш сервис Amazon VPC Lattice, необходимо добавить один или несколько прослушивателей. Прослушиватель — это процесс, который проверяет запросы на подключение к вашим сервисам. Для получения дополнительной информации см. раздел Прослушиватели в Руководстве пользователя Amazon VPC Lattice.

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

Сводка

  create-listener
[--client-token <value>]
--default-action <value>
--name <value>
[--port <value>]
--protocol <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]

Параметры

--client-token (string)

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

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

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

Примечание

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

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

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

statusCode -> (integer)

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

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

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

targetGroups -> (list)

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

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

(структура)

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

targetGroupIdentifier -> (string)

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

weight -> (integer)

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

Синтаксис JSON:

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

--name (string)

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

--port (integer)

Порт прослушивателя. Вы можете указать значение от 1 до 65535. Для HTTP по умолчанию используется 80. Для HTTPS по умолчанию используется 443.

--protocol (string)

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

Возможные значения:

  • HTTP
  • HTTPS
  • TLS_PASSTHROUGH

--service-identifier (string)

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

--tags (map)

Теги для прослушивателя.

key -> (string)

Ключ тега.

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

value -> (string)

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное JSON значение, поскольку строка будет восприниматься буквально. Это нельзя указывать вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если не указано значение или указано значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном скелете JSON.

Глобальные параметры

--debug (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределить URL по умолчанию команды данным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию при проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическое разбиение на страницы. Если автоматическое разбиение на страницы отключено, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию — 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

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

Чтобы создать прослушиватель

Следующий пример create-listener создает прослушиватель HTTPS с правилом по умолчанию, которое пересылает трафик в указанную целевую группу VPC Lattice.

aws vpc-lattice create-listener \
    --name my-service-listener \
    --protocol HTTPS \
    --port 443 \
    --service-identifier svc-0285b53b2eEXAMPLE \
    --default-action file://listener-config.json

Содержимое listener-config.json:

{
    "forward": {
        "targetGroups": [
            {
                "targetGroupIdentifier": "tg-0eaa4b9ab4EXAMPLE"
            }
        ]
    }
}

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE/listener/listener-07cc7fb0abEXAMPLE",
    "defaultAction": {
        "forward": {
            "targetGroups": [
                {
                    "targetGroupIdentifier": "tg-0eaa4b9ab4EXAMPLE",
                    "weight": 100
                }
            ]
        }
    },
    "id": "listener-07cc7fb0abEXAMPLE",
    "name": "my-service-listener",
    "port": 443,
    "protocol": "HTTPS",
    "serviceArn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "serviceId": "svc-0285b53b2eEXAMPLE"
}

Для получения дополнительной информации см. раздел Прослушиватели в Руководстве пользователя Amazon VPC Lattice.

Вывод

arn -> (string)

The Amazon Resource Name (ARN) of the listener.

defaultAction -> (tagged union structure)

The action for the default rule.

Примечание

This is a Tagged Union structure. Only one of the following top level keys can be set: fixedResponse, forward.

fixedResponse -> (structure)

The fixed response action. The rule returns a custom HTTP response.

statusCode -> (integer)

The HTTP response code.

forward -> (structure)

The forward action. Traffic that matches the rule is forwarded to the specified target groups.

targetGroups -> (list)

The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

(structure)

Describes the weight of a target group.

targetGroupIdentifier -> (string)

The ID or ARN of the target group.

weight -> (integer)

Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there’s only one target group specified, then the default value is 100.

id -> (string)

The ID of the listener.

name -> (string)

The name of the listener.

port -> (integer)

The port number of the listener.

protocol -> (string)

The protocol of the listener.

serviceArn -> (string)

The Amazon Resource Name (ARN) of the service.

serviceId -> (string)

The ID of the service.

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

Spec-Zone.ru

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