Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

изменить-атрибуты-группы-целей

Описание

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

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

Синтаксис

  modify-target-group-attributes
--target-group-arn <value>
--attributes <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]

Параметры

--target-group-arn (строка)

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

--attributes (список)

Атрибуты целевой группы.

(структура)

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

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

Имя атрибута.

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

  • deregistration_delay.timeout_seconds - Время в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние дерегистрируемого целевого сервера из состояния draining в состояние unused. Диапазон значений: 0-3600 секунд. Значение по умолчанию: 300 секунд. Если целевой сервер — функция Lambda, этот атрибут не поддерживается.
  • stickiness.enabled - Указывает, включена ли настройка «липкости» целей. Значение равно true или false. Значение по умолчанию: false.
  • stickiness.type - Указывает тип «липкости». Возможные значения:
    • lb_cookie и app_cookie для балансировщиков приложения.
    • source_ip для балансировщиков сети.
    • source_ip_dest_ip и source_ip_dest_ip_proto для балансировщиков шлюзов.

Следующие атрибуты поддерживаются балансировщиками приложения и балансировщиками сети:

  • load_balancing.cross_zone.enabled - Указывает, включен ли межзонный балансировка нагрузки. Значение равно true , false или use_load_balancer_configuration. Значение по умолчанию: use_load_balancer_configuration.
  • target_group_health.dns_failover.minimum_healthy_targets.count - Минимальное количество работоспособных целевых серверов. Если количество работоспособных целевых серверов ниже этого значения, зона помечается как неработоспособная в DNS, и трафик маршрутизируется только по работоспособным зонам. Возможные значения: off или целое число от 1 до максимального количества целевых серверов. Значение по умолчанию: off.
  • target_group_health.dns_failover.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых серверов. Если процент работоспособных целевых серверов ниже этого значения, зона помечается как неработоспособная в DNS, и трафик маршрутизируется только по работоспособным зонам. Возможные значения: off или целое число от 1 до 100. Значение по умолчанию: off.
  • target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - Минимальное количество работоспособных целевых серверов. Если количество работоспособных целевых серверов ниже этого значения, трафик направляется ко всем целевым серверам, включая неработоспособные. Возможные значения: от 1 до максимального количества целевых серверов. Значение по умолчанию: 1.
  • target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых серверов. Если процент работоспособных целевых серверов ниже этого значения, трафик направляется ко всем целевым серверам, включая неработоспособные. Возможные значения: off или целое число от 1 до 100. Значение по умолчанию: off.

Следующие атрибуты поддерживаются только если балансировщик нагрузки — балансировщик приложения, а целевой сервер — экземпляр или IP-адрес:

  • load_balancing.algorithm.type - Алгоритм балансировки нагрузки определяет, как балансировщик выбирает целевые серверы при маршрутизации запросов. Значение равно round_robin , least_outstanding_requests или weighted_random . Значение по умолчанию: round_robin.
  • load_balancing.algorithm.anomaly_mitigation - Доступен только когда load_balancing.algorithm.type равен weighted_random. Указывает, включена ли защита от аномалий. Значение равно on или off. Значение по умолчанию: off.
  • slow_start.duration_seconds - Период времени в секундах, в течение которого новый зарегистрированный целевой сервер получает увеличивающуюся долю трафика в целевую группу. По истечении этого периода целевой сервер получает свою полную долю трафика. Диапазон значений: 30-900 секунд (15 минут). Значение по умолчанию: 0 секунд (отключено).
  • stickiness.app_cookie.cookie_name - Указывает имя куки на основе приложения. Имена, начинающиеся со следующих префиксов, не допускаются: AWSALB , AWSALBAPP и AWSALBTG; они зарезервированы для использования балансировщиком.
  • stickiness.app_cookie.duration_seconds - Период времени в секундах, в течение которого запросы от клиента должны маршрутизироваться к одному и тому же целевому серверу. По истечении этого периода куки на основе приложения считается устаревшим. Диапазон значений: от 1 секунды до 1 недели (604800 секунд). Значение по умолчанию: 1 день (86400 секунд).
  • stickiness.lb_cookie.duration_seconds - Период времени в секундах, в течение которого запросы от клиента должны маршрутизироваться к одному и тому же целевому серверу. По истечении этого периода куки, сгенерированный балансировщиком, считается устаревшим. Диапазон значений: от 1 секунды до 1 недели (604800 секунд). Значение по умолчанию: 1 день (86400 секунд).

Следующий атрибут поддерживается только если балансировщик нагрузки — балансировщик приложения, а целевой сервер — функция Lambda:

  • lambda.multi_value_headers.enabled - Указывает, включают ли обмен заголовками запроса и ответа между балансировщиком и функцией Lambda массивы значений или строки. Значение равно true или false . Значение по умолчанию: false. Если значение равно false, а запрос содержит дублирующее имя поля заголовка или ключ параметра запроса, балансировщик использует последнее значение, отправленное клиентом.

Следующие атрибуты поддерживаются только балансировщиками сети:

  • deregistration_delay.connection_termination.enabled - Указывает, завершает ли балансировщик соединения в конце таймаута дерегистрации. Значение равно true или false. Для новых UDP/TCP_UDP групп целей значение по умолчанию — true. В противном случае значение по умолчанию — false.
  • preserve_client_ip.enabled - Указывает, включена ли сохранённость IP-адреса клиента. Значение равно true или false. Значение по умолчанию — отключено, если тип целевой группы — IP-адрес, а протокол целевой группы — TCP или TLS. В противном случае значение по умолчанию — включено. Сохранение IP-адреса клиента не может быть отключено для UDP и TCP_UDP целевых групп.
  • proxy_protocol_v2.enabled - Указывает, включена ли версия 2 протокола Proxy. Значение равно true или false . Значение по умолчанию: false.
  • target_health_state.unhealthy.connection_termination.enabled - Указывает, прерывает ли балансировщик соединения с неработоспособными целевыми серверами. Значение равно true или false. Значение по умолчанию: true. Этот атрибут не может быть включен для UDP и TCP_UDP целевых групп.
  • target_health_state.unhealthy.draining_interval_seconds - Время в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние неработоспособного целевого сервера из состояния unhealthy.draining в состояние unhealthy. Диапазон значений: 0-360000 секунд. Значение по умолчанию: 0 секунд. Примечание: этот атрибут может быть настроен только когда target_health_state.unhealthy.connection_termination.enabled равно false.

Следующие атрибуты поддерживаются только балансировщиками шлюзов:

  • target_failover.on_deregistration - Указывает, как балансировщик шлюзов обрабатывает существующие потоки при дерегистрации целевого сервера. Возможные значения: rebalance и no_rebalance. Значение по умолчанию: no_rebalance. Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) не могут быть установлены независимо. Установленное значение для обоих атрибутов должно быть одинаковым.
  • target_failover.on_unhealthy - Указывает, как балансировщик шлюзов обрабатывает существующие потоки при неработоспособности целевого сервера. Возможные значения: rebalance и no_rebalance. Значение по умолчанию: no_rebalance. Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) не могут быть установлены независимо. Установленное значение для обоих атрибутов должно быть одинаковым.

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

Значение атрибута.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 (boolean)

Включить отладочную запись журнала.

--endpoint-url (string)

Заменить стандартный 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.

Изменение таймаута задержки дерегистрации

В этом примере устанавливается таймаут задержки дерегистрации для указанного целевого группы.

Команда:

aws elbv2 modify-target-group-attributes --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 --attributes Key=deregistration_delay.timeout_seconds,Value=600

Вывод:

{
  "Attributes": [
      {
          "Value": "false",
          "Key": "stickiness.enabled"
      },
      {
          "Value": "600",
          "Key": "deregistration_delay.timeout_seconds"
      },
      {
          "Value": "lb_cookie",
          "Key": "stickiness.type"
      },
      {
          "Value": "86400",
          "Key": "stickiness.lb_cookie.duration_seconds"
      }
  ]
}

Вывод

Атрибуты -> (список)

Информация об атрибутах целевой группы.

(структура)

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

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

Название атрибута.

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

  • deregistration_delay.timeout_seconds - Время в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние удаляемого целевого объекта из состояния draining в состояние unused . Диапазон от 0 до 3600 секунд. Значение по умолчанию составляет 300 секунд. Если целевой объект является функцией Lambda, этот атрибут не поддерживается.
  • stickiness.enabled - Указывает, включена ли настройка привязки к целевому объекту. Значение равно true или false . По умолчанию значение равно false .
  • stickiness.type - Указывает тип привязки. Возможные значения:
    • lb_cookie и app_cookie для балансировщиков прикладной нагрузки.
    • source_ip для балансировщиков сетевой нагрузки.
    • source_ip_dest_ip и source_ip_dest_ip_proto для балансировщиков шлюза.

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

  • load_balancing.cross_zone.enabled - Указывает, включено ли распределение нагрузки по зонам. Значение равно true , false или use_load_balancer_configuration . Значение по умолчанию - use_load_balancer_configuration .
  • target_group_health.dns_failover.minimum_healthy_targets.count - Минимальное количество работоспособных целевых объектов. Если количество работоспособных целевых объектов ниже этого значения, зона помечается как неработоспособная в DNS, поэтому трафик будет направляться только в работоспособные зоны. Возможные значения: off или целое число от 1 до максимального числа целевых объектов. Значение по умолчанию - off .
  • target_group_health.dns_failover.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых объектов. Если процент работоспособных целевых объектов ниже этого значения, зона помечается как неработоспособная в DNS, поэтому трафик будет направляться только в работоспособные зоны. Возможные значения: off или целое число от 1 до 100. Значение по умолчанию - off .
  • target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - Минимальное количество работоспособных целевых объектов. Если количество работоспособных целевых объектов ниже этого значения, трафик направляется ко всем целевым объектам, включая неработоспособные. Возможные значения - от 1 до максимального числа целевых объектов. Значение по умолчанию - 1.
  • target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых объектов. Если процент работоспособных целевых объектов ниже этого значения, трафик направляется ко всем целевым объектам, включая неработоспособные. Возможные значения - off или целое число от 1 до 100. Значение по умолчанию - off .

Следующие атрибуты поддерживаются только если балансировщик нагрузки является балансировщиком прикладной нагрузки, а целевой объект - экземпляром или IP-адресом:

  • load_balancing.algorithm.type - Алгоритм распределения нагрузки определяет, как балансировщик нагрузки выбирает целевые объекты при маршрутизации запросов. Значение равно round_robin , least_outstanding_requests или weighted_random . Значение по умолчанию - round_robin .
  • load_balancing.algorithm.anomaly_mitigation - Доступно только когда load_balancing.algorithm.type равно weighted_random . Указывает, включена ли смягчение аномалий. Значение равно on или off . Значение по умолчанию - off .
  • slow_start.duration_seconds - Период времени в секундах, в течение которого новый зарегистрированный целевой объект получает увеличение доли трафика в группе целевых объектов. По истечении этого периода целевой объект получает свою полную долю трафика. Диапазон - 30-900 секунд (15 минут). Значение по умолчанию - 0 секунд (отключено).
  • stickiness.app_cookie.cookie_name - Указывает имя куки, основанной на приложении. Имена, начинающиеся со следующих префиксов, не допускаются: AWSALB , AWSALBAPP и AWSALBTG ; они зарезервированы для использования балансировщиком нагрузки.
  • stickiness.app_cookie.duration_seconds - Период времени в секундах, в течение которого запросы от клиента должны маршрутизироваться к одному и тому же целевому объекту. По истечении этого периода куки, основанная на приложении, считается устаревшей. Диапазон - 1 секунда до 1 недели (604800 секунд). Значение по умолчанию - 1 день (86400 секунд).
  • stickiness.lb_cookie.duration_seconds - Период времени в секундах, в течение которого запросы от клиента должны маршрутизироваться к одному и тому же целевому объекту. По истечении этого периода куки, сгенерированная балансировщиком нагрузки, считается устаревшей. Диапазон - 1 секунда до 1 недели (604800 секунд). Значение по умолчанию - 1 день (86400 секунд).

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

  • lambda.multi_value_headers.enabled - Указывает, включают ли обмен заголовками запросов и ответов между балансировщиком нагрузки и функцией Lambda массивы значений или строки. Значение равно true или false . Значение по умолчанию - false . Если значение равно false, а запрос содержит дублирующее имя поля заголовка или ключ параметра запроса, балансировщик нагрузки использует последнее значение, отправленное клиентом.

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

  • deregistration_delay.connection_termination.enabled - Указывает, завершает ли балансировщик соединения в конце таймаута удаления. Значение равно true или false . Для новых групп целевых объектов UDP/TCP_UDP значение по умолчанию - true . В противном случае значение по умолчанию - false .
  • preserve_client_ip.enabled - Указывает, включено ли сохранение IP-адреса клиента. Значение равно true или false . Значение по умолчанию - отключено, если тип группы целевых объектов - IP-адрес, а протокол группы целевых объектов - TCP или TLS. В противном случае значение по умолчанию - включено. Сохранение IP-адреса клиента не может быть отключено для групп целевых объектов UDP и TCP_UDP.
  • proxy_protocol_v2.enabled - Указывает, включена ли версия 2 протокола Proxy. Значение равно true или false . Значение по умолчанию - false .
  • target_health_state.unhealthy.connection_termination.enabled - Указывает, завершает ли балансировщик соединения с неработоспособными целевыми объектами. Значение равно true или false . Значение по умолчанию - true . Этот атрибут не может быть включен для групп целевых объектов UDP и TCP_UDP.
  • target_health_state.unhealthy.draining_interval_seconds - Время ожидания Elastic Load Balancing, прежде чем изменить состояние неработоспособного целевого объекта со состояния unhealthy.draining в состояние unhealthy . Диапазон от 0 до 360000 секунд. Значение по умолчанию - 0 секунд. Примечание: этот атрибут может быть настроен только когда target_health_state.unhealthy.connection_termination.enabled равно false .

Следующие атрибуты поддерживаются только балансировщиками шлюза:

  • target_failover.on_deregistration - Указывает, как балансировщик шлюза обрабатывает существующие потоки при удалении целевого объекта. Возможные значения - rebalance и no_rebalance . Значение по умолчанию - no_rebalance . Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) нельзя устанавливать независимо. Значение, которое вы установите для обоих атрибутов, должно быть одинаковым.
  • target_failover.on_unhealthy - Указывает, как балансировщик шлюза обрабатывает существующие потоки при неработоспособности целевого объекта. Возможные значения - rebalance и no_rebalance . Значение по умолчанию - no_rebalance . Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) нельзя устанавливать независимо. Значение, которое вы установите для обоих атрибутов, должно быть одинаковым.

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

Значение атрибута.

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

Spec-Zone.ru

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