Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

создать-группу-целей

Описание

Создаёт группу целей. Группа целей — это набор целей, или вычислительных ресурсов, которые выполняют ваше приложение или службу. Одна группа целей может использоваться только одной службой.

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

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

Синтаксис

  create-target-group
[--client-token <value>]
[--config <value>]
--name <value>
[--tags <value>]
--type <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 (строка)

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

--config (структура)

Конфигурация группы целей.

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

Конфигурация проверки работоспособности. Не поддерживается, если тип группы целей — LAMBDA или ALB.

enabled -> (булево)

Указывает, включена ли проверка работоспособности.

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

Приблизительное время в секундах между проверками работоспособности отдельной цели. Диапазон — 5–300 секунд. По умолчанию — 30 секунд.

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

Время в секундах ожидания перед маркировкой цели как неработоспособной. Диапазон — 1–120 секунд. По умолчанию — 5 секунд.

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

Количество последовательных успешных проверок работоспособности, необходимых для перехода от неработоспособного состояния к рабочему. Диапазон — 2–10. По умолчанию — 5.

matcher -> (структура помеченного союза)

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

Примечание

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

httpCode -> (строка)

HTTP-код, используемый для проверки успешного ответа от цели.

path -> (строка)

Место назначения для проверок работоспособности целей. Если версия протокола — HTTP/1.1 или HTTP/2, укажите допустимый URI (например, /path?query). Путь по умолчанию — /. Проверки работоспособности не поддерживаются, если версия протокола — gRPC, однако, вы можете выбрать HTTP/1.1 или HTTP/2 и указать допустимый URI.

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

Порт, используемый при выполнении проверок работоспособности целей. Значение по умолчанию — порт, на котором цель получает трафик.

protocol -> (строка)

Протокол, используемый при выполнении проверок работоспособности целей. Возможные протоколы — HTTP и HTTPS. По умолчанию — HTTP.

protocolVersion -> (строка)

Версия протокола, используемая при выполнении проверок работоспособности целей. Возможные версии протокола — HTTP1 и HTTP2.

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

Количество последовательных неудачных проверок работоспособности, необходимых для маркировки цели как неработоспособной. Диапазон — 2–10. По умолчанию — 2.

ipAddressType -> (строка)

Тип IP-адреса, используемого для группы целей. Поддерживается только если тип группы целей — IP. По умолчанию — IPV4.

lambdaEventStructureVersion -> (строка)

Версия структуры события, которую получает ваша функция Lambda. Поддерживается только если тип группы целей — LAMBDA. По умолчанию — V1.

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

Порт, на котором слушают цели. Для HTTP по умолчанию — 80. Для HTTPS по умолчанию — 443. Не поддерживается, если тип группы целей — LAMBDA.

protocol -> (строка)

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

protocolVersion -> (строка)

Версия протокола. По умолчанию — HTTP1. Не поддерживается, если тип группы целей — LAMBDA.

vpcIdentifier -> (строка)

Идентификатор VPC. Не поддерживается, если тип группы целей — LAMBDA.

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

healthCheck={enabled=boolean,healthCheckIntervalSeconds=integer,healthCheckTimeoutSeconds=integer,healthyThresholdCount=integer,matcher={httpCode=string},path=string,port=integer,protocol=string,protocolVersion=string,unhealthyThresholdCount=integer},ipAddressType=string,lambdaEventStructureVersion=string,port=integer,protocol=string,protocolVersion=string,vpcIdentifier=string

Синтаксис JSON:

{
  "healthCheck": {
    "enabled": true|false,
    "healthCheckIntervalSeconds": integer,
    "healthCheckTimeoutSeconds": integer,
    "healthyThresholdCount": integer,
    "matcher": {
      "httpCode": "string"
    },
    "path": "string",
    "port": integer,
    "protocol": "HTTP"|"HTTPS"|"TCP",
    "protocolVersion": "HTTP1"|"HTTP2",
    "unhealthyThresholdCount": integer
  },
  "ipAddressType": "IPV4"|"IPV6",
  "lambdaEventStructureVersion": "V1"|"V2",
  "port": integer,
  "protocol": "HTTP"|"HTTPS"|"TCP",
  "protocolVersion": "HTTP1"|"HTTP2"|"GRPC",
  "vpcIdentifier": "string"
}

--name (строка)

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

--tags (массив)

Теги для группы целей.

key -> (строка)

Ключ тега.

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

value -> (строка)

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--type (строка)

Тип группы целей.

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

  • IP
  • LAMBDA
  • INSTANCE
  • ALB

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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: Создание группы целевых серверов типа INSTANCE

Следующий create-target-group пример создает группу целевых серверов с указанным именем, типом и настройками.

aws vpc-lattice create-target-group \
    --name my-lattice-target-group-instance \
    --type INSTANCE \
    --config file://tg-config.json

Содержание tg-config.json:

{
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-instance",
    "status": "CREATE_IN_PROGRESS",
    "type": "INSTANCE"
}

Пример 2: Создание группы целевых серверов типа IP

Следующий create-target-group пример создает группу целевых серверов с указанным именем, типом и настройками.

aws vpc-lattice create-target-group \
    --name my-lattice-target-group-ip \
    --type IP \
    --config file://tg-config.json

Содержание tg-config.json:

{
    "ipAddressType": "IPV4",
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "ipAddressType": "IPV4",
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-ip",
    "status": "CREATE_IN_PROGRESS",
    "type": "IP"
}

Пример 3: Создание группы целевых серверов типа LAMBDA

Следующий create-target-group пример создает группу целевых серверов с указанным именем, типом и настройками.

aws vpc-lattice create-target-group \
    --name my-lattice-target-group-lambda \
    --type LAMBDA

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-lambda",
    "status": "CREATE_IN_PROGRESS",
    "type": "LAMBDA"
}

Пример 4: Создание группы целевых серверов типа ALB

Следующий create-target-group пример создает группу целевых серверов с указанным именем, типом и настройками.

aws vpc-lattice create-target-group \
    --name my-lattice-target-group-alb \
    --type ALB \
    --config file://tg-config.json

Содержание tg-config.json:

{
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-alb",
    "status": "CREATE_IN_PROGRESS",
    "type": "ALB"
}

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

Вывод

arn -> (строка)

Amazon Resource Name (ARN) группы целевых серверов.

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

Настройка группы целевых серверов.

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

Настройка проверки состояния. Не поддерживается, если тип группы целевых серверов — LAMBDA или ALB.

enabled -> (булево)

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

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

Приблизительное время (в секундах) между проверками состояния отдельного целевого сервера. Диапазон — от 5 до 300 секунд. По умолчанию — 30 секунд.

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

Время (в секундах) ожидания до отметки целевого сервера как неисправного. Диапазон — от 1 до 120 секунд. По умолчанию — 5 секунд.

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

Количество последовательных успешных проверок состояния, необходимых для перевода неисправного целевого сервера в исправное состояние. Диапазон — от 2 до 10. По умолчанию — 5.

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

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

Примечание

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

httpCode -> (строка)

HTTP-код, используемый для проверки успешного ответа от целевого сервера.

path -> (строка)

Место назначения проверок состояния на целевых серверах. Если версия протокола — HTTP/1.1 или HTTP/2, укажите допустимый URI (например, /path?query). Путь по умолчанию — /. Проверки состояния не поддерживаются, если версия протокола — gRPC, однако вы можете выбрать HTTP/1.1 или HTTP/2 и указать допустимый URI.

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

Порт, используемый при выполнении проверок состояния на целевых серверах. Значение по умолчанию — порт, на котором целевой сервер получает трафик.

protocol -> (строка)

Протокол, используемый при выполнении проверок состояния на целевых серверах. Возможные протоколы — HTTP и HTTPS. По умолчанию — HTTP.

protocolVersion -> (строка)

Версия протокола, используемая при выполнении проверок состояния на целевых серверах. Возможные версии протоколов — HTTP1 и HTTP2.

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

Количество последовательных неудачных проверок состояния, необходимых для перевода целевого сервера в неисправное состояние. Диапазон — от 2 до 10. По умолчанию — 2.

ipAddressType -> (строка)

Тип IP-адреса, используемого для группы целевых серверов. Поддерживается только если тип группы целевых серверов — IP. По умолчанию — IPV4.

lambdaEventStructureVersion -> (строка)

Версия структуры события, получаемого вашей функцией Lambda. Поддерживается только если тип группы целевых серверов — LAMBDA. По умолчанию — V1.

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

Порт, на котором слушают целевые серверы. Для HTTP по умолчанию 80. Для HTTPS по умолчанию 443. Не поддерживается, если тип группы целевых серверов — LAMBDA.

protocol -> (строка)

Протокол для маршрутизации трафика на целевые серверы. По умолчанию — протокол группы целевых серверов. Не поддерживается, если тип группы целевых серверов — LAMBDA.

protocolVersion -> (строка)

Версия протокола. По умолчанию — HTTP1. Не поддерживается, если тип группы целевых серверов — LAMBDA.

vpcIdentifier -> (строка)

Идентификатор VPC. Не поддерживается, если тип группы целевых серверов — LAMBDA.

id -> (строка)

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

name -> (строка)

Имя группы целевых серверов.

status -> (строка)

Состояние. Вы можете повторить операцию, если состояние — CREATE_FAILED. Однако, если вы повторите операцию, когда состояние — CREATE_IN_PROGRESS, состояние не изменится.

type -> (строка)

Тип группы целевых серверов.

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

Spec-Zone.ru

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