Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

create-target-group

Описание

Создаёт группу целевых серверов.

Для получения дополнительной информации, см.:

  • Целевые группы для ваших балансировщиков нагрузки приложений
  • Целевые группы для ваших балансировщиков сети
  • Целевые группы для ваших балансировщиков шлюзов

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

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

Синтаксис

  create-target-group
--name <value>
[--protocol <value>]
[--protocol-version <value>]
[--port <value>]
[--vpc-id <value>]
[--health-check-protocol <value>]
[--health-check-port <value>]
[--health-check-enabled | --no-health-check-enabled]
[--health-check-path <value>]
[--health-check-interval-seconds <value>]
[--health-check-timeout-seconds <value>]
[--healthy-threshold-count <value>]
[--unhealthy-threshold-count <value>]
[--matcher <value>]
[--target-type <value>]
[--tags <value>]
[--ip-address-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]

Параметры

--name (строка)

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

Это имя должно быть уникальным для каждого региона и учётной записи, может содержать не более 32 символов, должно содержать только буквенно-цифровые символы или дефисы, и не должно начинаться или заканчиваться дефисом.

--protocol (строка)

Протокол, используемый для маршрутизации трафика к целевым серверам. Для балансировщиков приложений поддерживаются протоколы HTTP и HTTPS. Для балансировщиков сети поддерживаются протоколы TCP, TLS, UDP или TCP_UDP. Для балансировщиков шлюзов поддерживается протокол GENEVE. Слушатель TCP_UDP должен быть связан с целевой группой TCP_UDP. Если целевой сервер — функция Lambda, этот параметр не применяется.

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

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

--protocol-version (строка)

[Протокол HTTP/HTTPS] Версия протокола. Укажите GRPC, чтобы отправлять запросы целевым серверам с помощью gRPC. Укажите HTTP2, чтобы отправлять запросы целевым серверам с помощью HTTP/2. По умолчанию значение HTTP1, которое отправляет запросы целевым серверам с помощью HTTP/1.1.

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

Порт, на котором целевые серверы принимают трафик. Этот порт используется, если вы не указали переопределение порта при регистрации целевого сервера. Если целевой сервер — функция Lambda, этот параметр не применяется. Если протокол GENEVE, поддерживаемый порт — 6081.

--vpc-id (строка)

Идентификатор виртуальной частной сети (VPC). Если целевой сервер — функция Lambda, этот параметр не применяется. В противном случае этот параметр является обязательным.

--health-check-protocol (строка)

Протокол, используемый балансировщиком нагрузки при выполнении проверки состояния целевых серверов. Для балансировщиков приложений по умолчанию используется HTTP. Для балансировщиков сети и балансировщиков шлюзов по умолчанию используется TCP. Протокол TCP не поддерживается для проверок состояния, если протокол целевой группы — HTTP или HTTPS. Протоколы GENEVE, TLS, UDP и TCP_UDP не поддерживаются для проверок состояния.

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

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

--health-check-port (строка)

Порт, используемый балансировщиком нагрузки при выполнении проверок состояния целевых серверов. Если протокол HTTP, HTTPS, TCP, TLS, UDP или TCP_UDP, по умолчанию используется traffic-port, который является портом, на котором каждый целевой сервер получает трафик от балансировщика нагрузки. Если протокол GENEVE, по умолчанию используется порт 80.

--health-check-enabled | --no-health-check-enabled (булево)

Указывает, включены ли проверки состояния. Если тип целевого сервера — lambda, проверки состояния по умолчанию отключены, но могут быть включены. Если тип целевого сервера — instance, ip или alb, проверки состояния всегда включены и отключить их нельзя.

--health-check-path (строка)

[Проверки состояния HTTP/HTTPS] Путь назначения для проверок состояния целевых серверов.

[Протокол HTTP1 или HTTP2] Путь ping. По умолчанию это /.

[Протокол GRPC] Путь пользовательского метода проверки состояния в формате /package.service/method. По умолчанию это /Amazon Web Services.ALB/healthcheck.

--health-check-interval-seconds (целое число)

Приблизительное время в секундах между проверками состояния отдельного целевого сервера. Диапазон от 5 до 300. Если протокол целевой группы — TCP, TLS, UDP, TCP_UDP, HTTP или HTTPS, по умолчанию 30 секунд. Если протокол целевой группы — GENEVE, по умолчанию 10 секунд. Если тип целевого сервера — lambda, по умолчанию 35 секунд.

--health-check-timeout-seconds (целое число)

Время в секундах, в течение которого отсутствие ответа от целевого сервера означает проваленную проверку состояния. Диапазон от 2 до 120 секунд. Для целевых групп с протоколом HTTP по умолчанию 6 секунд. Для целевых групп с протоколом TCP, TLS или HTTPS по умолчанию 10 секунд. Для целевых групп с протоколом GENEVE по умолчанию 5 секунд. Если тип целевого сервера — lambda, по умолчанию 30 секунд.

--healthy-threshold-count (целое число)

Количество последовательных успешных проверок состояния, необходимых для определения целевого сервера как активного. Диапазон от 2 до 10. Если протокол целевой группы — TCP, TCP_UDP, UDP, TLS, HTTP или HTTPS, по умолчанию 5. Для целевых групп с протоколом GENEVE по умолчанию 5. Если тип целевого сервера — lambda, по умолчанию 5.

--unhealthy-threshold-count (целое число)

Количество последовательных неудачных проверок состояния, необходимых для определения целевого сервера как неактивного. Диапазон от 2 до 10. Если протокол целевой группы — TCP, TCP_UDP, UDP, TLS, HTTP или HTTPS, по умолчанию 2. Для целевых групп с протоколом GENEVE по умолчанию 2. Если тип целевого сервера — lambda, по умолчанию 5.

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

[Проверки состояния HTTP/HTTPS] Коды HTTP или gRPC, используемые при проверке успешного ответа от целевого сервера. Для целевых групп с протоколом TCP, TCP_UDP, UDP или TLS диапазон 200-599. Для целевых групп с протоколом HTTP или HTTPS диапазон 200-499. Для целевых групп с протоколом GENEVE диапазон 200-399.

HttpCode -> (строка)

Для балансировщиков приложений вы можете указать значения от 200 до 499, по умолчанию 200. Вы можете указать несколько значений (например, «200,202») или диапазон значений (например, «200-299»).

Для балансировщиков сети вы можете указать значения от 200 до 599, по умолчанию 200-399. Вы можете указать несколько значений (например, «200,202») или диапазон значений (например, «200-299»).

Для балансировщиков шлюзов это должно быть «200–399».

Обратите внимание, что при использовании сокращённого синтаксиса некоторые значения, такие как запятые, необходимо экранировать.

GrpcCode -> (строка)

Вы можете указать значения от 0 до 99. Вы можете указать несколько значений (например, «0,1») или диапазон значений (например, «0-5»). По умолчанию 12.

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

HttpCode=string,GrpcCode=string

Синтаксис JSON:

{
  "HttpCode": "string",
  "GrpcCode": "string"
}

--target-type (строка)

Тип целевого сервера, который необходимо указать при регистрации целевых серверов в этой целевой группе. Нельзя указывать целевые серверы для целевой группы, используя более одного типа целевого сервера.

  • instance - Регистрация целевых серверов по идентификатору экземпляра. Это значение по умолчанию.
  • ip - Регистрация целевых серверов по IP-адресу. Вы можете указать IP-адреса из подсетей виртуальной частной сети (VPC) для целевой группы, диапазон RFC 1918 (10.0.0.0/8, 172.16.0.0/12 и 192.168.0.0/16) и диапазон RFC 6598 (100.64.0.0/10). Нельзя указывать публично доступные IP-адреса.
  • lambda - Регистрация одной функции Lambda как целевого сервера.
  • alb - Регистрация одного балансировщика приложений как целевого сервера.

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

  • instance
  • ip
  • lambda
  • alb

--tags (список)

Теги, которые нужно назначить целевой группе.

(структура)

Информация о теге.

Ключ -> (строка)

Ключ тега.

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--ip-address-type (строка)

Тип IP-адреса. Значение по умолчанию — ipv4.

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

  • ipv4
  • ipv6

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

Пример 1: Создание группы целей для балансировщика нагрузки приложений

Следующий create-target-group пример создаёт группу целей для балансировщика нагрузки приложений, где вы регистрируете цели по идентификатору экземпляра (тип цели — instance). Эта группа целей использует протокол HTTP, порт 80 и стандартные параметры проверки состояния для группы целей HTTP.

aws elbv2 create-target-group \
    --name my-targets \
    --protocol HTTP \
    --port 80 \
    --target-type instance \
    --vpc-id vpc-3ac0fb5f

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
            "TargetGroupName": "my-targets",
            "Protocol": "HTTP",
            "Port": 80,
            "VpcId": "vpc-3ac0fb5f",
            "HealthCheckProtocol": "HTTP",
            "HealthCheckPort": "traffic-port",
            "HealthCheckEnabled": true,
            "HealthCheckIntervalSeconds": 30,
            "HealthCheckTimeoutSeconds": 5,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "HealthCheckPath": "/",
            "Matcher": {
                "HttpCode": "200"
            },
            "TargetType": "instance",
            "ProtocolVersion": "HTTP1",
            "IpAddressType": "ipv4"
        }
    ]
}

Дополнительную информацию см. в разделе "Создание группы целей" в руководстве пользователя балансировщиков нагрузки приложений.

Пример 2: Создание группы целей для перенаправления трафика с балансировщика нагрузки приложений на функцию Lambda

Следующий create-target-group пример создаёт группу целей для балансировщика нагрузки приложений, где целевым ресурсом является функция Lambda (тип цели — lambda). Проверки состояния по умолчанию отключены для этой группы целей.

aws elbv2 create-target-group \
    --name my-lambda-target \
    --target-type lambda

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-lambda-target/a3003e085dbb8ddc",
            "TargetGroupName": "my-lambda-target",
            "HealthCheckEnabled": false,
            "HealthCheckIntervalSeconds": 35,
            "HealthCheckTimeoutSeconds": 30,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "HealthCheckPath": "/",
            "Matcher": {
                "HttpCode": "200"
            },
            "TargetType": "lambda",
            "IpAddressType": "ipv4"
        }
    ]
}

Дополнительную информацию см. в разделе "Функции Lambda в качестве целей" в руководстве пользователя балансировщиков нагрузки приложений.

Пример 3: Создание группы целей для балансировщика сетевой нагрузки

Следующий create-target-group пример создаёт группу целей для балансировщика сетевой нагрузки, где вы регистрируете цели по IP-адресу (тип цели — ip). Эта группа целей использует протокол TCP, порт 80 и стандартные параметры проверки состояния для группы целей TCP.

aws elbv2 create-target-group \
    --name my-ip-targets \
    --protocol TCP \
    --port 80 \
    --target-type ip \
    --vpc-id vpc-3ac0fb5f

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ip-targets/b6bba954d1361c78",
            "TargetGroupName": "my-ip-targets",
            "Protocol": "TCP",
            "Port": 80,
            "VpcId": "vpc-3ac0fb5f",
            "HealthCheckEnabled": true,
            "HealthCheckProtocol": "TCP",
            "HealthCheckPort": "traffic-port",
            "HealthCheckIntervalSeconds": 30,
            "HealthCheckTimeoutSeconds": 10,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "TargetType": "ip",
            "IpAddressType": "ipv4"
        }
    ]
}

Дополнительную информацию см. в разделе "Создание группы целей" в руководстве пользователя балансировщиков сетевой нагрузки.

Пример 4: Создание группы целей для перенаправления трафика с балансировщика сетевой нагрузки на балансировщик нагрузки приложений

Следующий create-target-group пример создаёт группу целей для балансировщика сетевой нагрузки, где вы регистрируете балансировщик нагрузки приложений как цель (тип цели — alb).

aws elbv2 create-target-group
–name my-alb-target –protocol TCP –port 80 –target-type alb –vpc-id vpc-3ac0fb5f

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-alb-target/a3003e085dbb8ddc",
            "TargetGroupName": "my-alb-target",
            "Protocol": "TCP",
            "Port": 80,
            "VpcId": "vpc-838475fe",
            "HealthCheckProtocol": "HTTP",
            "HealthCheckPort": "traffic-port",
            "HealthCheckEnabled": true,
            "HealthCheckIntervalSeconds": 30,
            "HealthCheckTimeoutSeconds": 6,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "HealthCheckPath": "/",
            "Matcher": {
                "HttpCode": "200-399"
            },
            "TargetType": "alb",
            "IpAddressType": "ipv4"
        }
    ]
}

Дополнительную информацию см. в разделе "Создание группы целей с балансировщиком нагрузки приложений в качестве цели" в руководстве пользователя балансировщиков сетевой нагрузки.

Пример 5: Создание группы целей для балансировщика шлюза

Следующий create-target-group пример создаёт группу целей для балансировщика шлюза, где целевым ресурсом является экземпляр, а протокол группы целей — GENEVE.

aws elbv2 create-target-group \
    --name my-glb-targetgroup \
    --protocol GENEVE \
    --port 6081 \
    --target-type instance \
    --vpc-id vpc-838475fe

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-glb-targetgroup/00c3d57eacd6f40b6f",
            "TargetGroupName": "my-glb-targetgroup",
            "Protocol": "GENEVE",
            "Port": 6081,
            "VpcId": "vpc-838475fe",
            "HealthCheckProtocol": "TCP",
            "HealthCheckPort": "80",
            "HealthCheckEnabled": true,
            "HealthCheckIntervalSeconds": 10,
            "HealthCheckTimeoutSeconds": 5,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "TargetType": "instance"
        }
    ]
}

Дополнительную информацию см. в разделе "Создание группы целей" `__ в руководстве пользователя балансировщиков шлюза.

Вывод

TargetGroups -> (список)

Информация о группе целей.

(структура)

Информация о группе целей.

TargetGroupArn -> (строка)

Amazon Resource Name (ARN) группы целей.

TargetGroupName -> (строка)

Имя группы целей.

Protocol -> (строка)

Протокол для маршрутизации трафика к целям.

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

Порт, на котором слушают цели. Этот параметр не используется, если целевым ресурсом является функция Lambda.

VpcId -> (строка)

Идентификатор VPC для целей.

HealthCheckProtocol -> (строка)

Протокол для соединения с целью. Протоколы GENEVE, TLS, UDP и TCP_UDP не поддерживаются для проверок состояния.

HealthCheckPort -> (строка)

Порт для соединения с целью.

HealthCheckEnabled -> (булево)

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

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

Приблизительное время в секундах между проверками состояния отдельной цели.

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

Время в секундах, по истечении которого отсутствие ответа означает неудачную проверку состояния.

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

Количество последовательных успешных проверок состояния, необходимых для перевода неустойчивой цели в состояние устойчивости.

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

Количество последовательных неудачных проверок состояния, необходимых для перевода цели в состояние неустойчивости.

HealthCheckPath -> (строка)

Адрес назначения для проверок состояния на целях.

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

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

HttpCode -> (строка)

Для балансировщиков нагрузки приложений можно указывать значения от 200 до 499, по умолчанию 200. Можно указывать несколько значений (например, "200,202") или диапазон значений (например, "200-299").

Для балансировщиков сетевой нагрузки можно указывать значения от 200 до 599, по умолчанию 200-399. Можно указывать несколько значений (например, "200,202") или диапазон значений (например, "200-299").

Для балансировщиков шлюза это должно быть "200–399".

Обратите внимание, что при использовании сокращённого синтаксиса некоторые значения, такие как запятые, необходимо экранировать.

GrpcCode -> (строка)

Можно указывать значения от 0 до 99. Можно указывать несколько значений (например, "0,1") или диапазон значений (например, "0-5"). Значение по умолчанию — 12.

LoadBalancerArns -> (список)

Amazon Resource Name (ARN) балансировщика нагрузки, который маршрутизирует трафик в эту группу целей. Вы можете использовать каждую группу целей только с одним балансировщиком нагрузки.

(строка)

TargetType -> (строка)

Тип цели, который необходимо указать при регистрации целей в этой группе целей. Возможные значения: instance (регистрация целей по идентификатору экземпляра), ip (регистрация целей по IP-адресу), lambda (регистрация одной функции Lambda в качестве цели) или alb (регистрация одного балансировщика нагрузки приложений в качестве цели).

ProtocolVersion -> (строка)

[Протокол HTTP/HTTPS] Версия протокола. Возможные значения: GRPC, HTTP1 и HTTP2.

IpAddressType -> (строка)

Тип IP-адреса. Значение по умолчанию — ipv4.

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

Spec-Zone.ru

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