Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

modify-db-proxy-target-group

Описание

Изменяет свойства DBProxyTargetGroup .

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

Синтаксис

  modify-db-proxy-target-group
--target-group-name <value>
--db-proxy-name <value>
[--connection-pool-config <value>]
[--new-name <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-name (строка)

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

--db-proxy-name (строка)

Имя прокси.

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

Настройки, определяющие размер и поведение пула соединений для целевой группы.

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

Максимальный размер пула соединений для каждого целевого сервера в группе. Значение выражается в процентах от настройки max_connections для экземпляра RDS DB или кластера Aurora DB, используемого целевой группой.

Если вы указываете MaxIdleConnectionsPercent, то также должны указать значение для этого параметра.

По умолчанию: 10 для RDS для Microsoft SQL Server и 100 для всех остальных типов баз данных.

Ограничения:

  • Должно быть от 1 до 100.

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

Значение, контролирующее активность закрытия прокси сервером неактивных баз данных в пуле соединений. Значение выражается в процентах от настройки max_connections для экземпляра RDS DB или кластера Aurora DB, используемого целевой группой. Высокое значение означает, что прокси оставляет открытым высокий процент неактивных соединений. Низкое значение заставляет прокси закрывать больше неактивных соединений и возвращать их базе данных.

Если вы указываете этот параметр, то должны также указать значение для MaxConnectionsPercent.

По умолчанию: значение по умолчанию составляет половину значения MaxConnectionsPercent. Например, если MaxConnectionsPercent равно 80, то значение по умолчанию MaxIdleConnectionsPercent равно 40. Если значение MaxConnectionsPercent не указано, то для SQL Server, MaxIdleConnectionsPercent равно 5, а для всех остальных баз данных значение по умолчанию равно 50.

Ограничения:

  • Должно быть от 0 до значения MaxConnectionsPercent.

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

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

По умолчанию: 120

Ограничения:

  • Должно быть от 0 до 3600.

SessionPinningFilters -> (список)

Каждый элемент списка представляет собой класс SQL-операций, которые обычно приводят к закреплению всех последующих операторов в сессии, использующей прокси, к одному и тому же подключению к базе данных. Включение элемента в список исключает этот класс SQL-операций из поведения закрепления.

По умолчанию: нет фильтров закрепления сессии

(строка)

InitQuery -> (строка)

Добавление или изменение начального запроса. Вы можете указать один или несколько SQL-запросов, которые прокси будет выполнять при открытии каждого нового подключения к базе данных. Эта настройка обычно используется с SET операторами, чтобы убедиться, что каждое подключение имеет идентичные настройки. Убедитесь, что добавляемый запрос корректен. Чтобы включить несколько переменных в один SET оператор, используйте разделители запятыми.

Например: SET variable1=value1, variable2=value2

Для нескольких операторов используйте точки с запятой в качестве разделителей.

По умолчанию: нет начального запроса

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

MaxConnectionsPercent=integer,MaxIdleConnectionsPercent=integer,ConnectionBorrowTimeout=integer,SessionPinningFilters=string,string,InitQuery=string

Синтаксис JSON:

{
  "MaxConnectionsPercent": integer,
  "MaxIdleConnectionsPercent": integer,
  "ConnectionBorrowTimeout": integer,
  "SessionPinningFilters": ["string", ...],
  "InitQuery": "string"
}

--new-name (строка)

Новое имя изменённого DBProxyTarget. Идентификатор должен начинаться с буквы и содержать только буквы ASCII, цифры и дефисы; он не может заканчиваться дефисом или содержать два дефиса подряд.

Вы не можете переименовать целевую группу default.

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод кли-пагинатора.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Изменение точек доступа прокси базы данных

Следующий пример изменяет целевую группу прокси базы данных, чтобы установить максимальное количество подключений до 80 процентов и максимальное количество неактивных подключений до 10 процентов.

aws rds modify-db-proxy-target-group \
    --target-group-name default \
    --db-proxy-name proxyExample \
    --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10

Вывод:

{
"DBProxyTargetGroup":
    {
        "DBProxyName": "proxyExample",
        "TargetGroupName": "default",
        "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab",
        "IsDefault": true,
        "Status": "available",
        "ConnectionPoolConfig": {
            "MaxConnectionsPercent": 80,
            "MaxIdleConnectionsPercent": 10,
            "ConnectionBorrowTimeout": 120,
            "SessionPinningFilters": []
        },
        "CreatedDate": "2023-05-02T18:41:19.495000+00:00",
        "UpdatedDate": "2023-05-02T18:41:21.762000+00:00"
    }
}

Дополнительную информацию можно найти в разделе Изменение прокси RDS в руководстве пользователя Amazon RDS и Изменение прокси RDS в руководстве пользователя Amazon Aurora.

Вывод

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

Настройки изменённого DBProxyTarget.

DBProxyName -> (строка)

Идентификатор прокси RDS, связанного с этой группой целей.

TargetGroupName -> (строка)

Идентификатор группы целей. Это имя должно быть уникальным для всех групп целей, принадлежащих вашей учётной записи Amazon Web Services в указанном регионе Amazon Web Services.

TargetGroupArn -> (строка)

Amazon Resource Name (ARN), представляющий группу целей.

IsDefault -> (булево)

Указывает, является ли эта группа целей первой, используемой для запросов подключения связанным прокси. Поскольку каждое прокси в настоящее время связано с одной группой целей, в настоящее время это значение всегда true.

Status -> (строка)

Текущий статус этой группы целей. Статус available означает, что группа целей правильно связана с базой данных. Другие значения указывают, что необходимо дождаться готовности группы целей или выполнить какие-либо действия для решения проблемы.

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

Настройки, определяющие размер и поведение пула подключений для группы целей.

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

Максимальный размер пула подключений для каждой цели в группе целей. Значение выражается в процентах от значения max_connections для экземпляра базы данных RDS или кластера базы данных Aurora, используемого группой целей.

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

Управляет активностью закрытия прокси неактивных подключений к базе данных в пуле подключений. Значение выражается в процентах от значения max_connections для экземпляра базы данных RDS или кластера базы данных Aurora, используемого группой целей. Высокое значение означает, что прокси оставляет открытым большой процент неактивных подключений к базе данных. Низкое значение заставляет прокси закрывать больше неактивных подключений и возвращать их в базу данных.

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

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

SessionPinningFilters -> (список)

Каждый элемент в списке представляет класс SQL-операций, которые обычно приводят к привязке всех последующих операторов в сеансе, использующем прокси, к одному и тому же подключению к базе данных. Включение элемента в список исключает этот класс SQL-операций из поведения привязки. Эта настройка поддерживается только для баз данных семейства MySQL. В настоящее время единственное разрешённое значение — EXCLUDE_VARIABLE_SETS.

(строка)

InitQuery -> (строка)

Одна или несколько SQL-команд, которые прокси выполняет при открытии каждого нового подключения к базе данных. Обычно используется с SET-командами, чтобы убедиться, что каждое подключение имеет одинаковые настройки, такие как часовой пояс и кодировка символов. По умолчанию это значение пустое. Для нескольких операторов используйте точки с запятой в качестве разделителя. Вы также можете включать несколько переменных в одном SET-операторе, например, SET x=1, y=2.

CreatedDate -> (временная метка)

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

UpdatedDate -> (временная метка)

Дата и время последнего обновления группы целей.

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

Spec-Zone.ru

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