modify-db-proxy
Описание
Изменяет параметры существующего прокси-сервера БД.
См. также: Документацию API AWS
Синтаксис
modify-db-proxy
--db-proxy-name <value>
[--new-db-proxy-name <value>]
[--auth <value>]
[--require-tls | --no-require-tls]
[--idle-client-timeout <value>]
[--debug-logging | --no-debug-logging]
[--role-arn <value>]
[--security-groups <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]
Параметры
--db-proxy-name (строка)
DBProxy.--new-db-proxy-name (строка)
DBProxy. Идентификатор должен начинаться с буквы и содержать только ASCII буквы, цифры и дефисы; он не может заканчиваться дефисом или содержать два дефиса подряд.--auth (список)
Новые параметры аутентификации для прокси-сервера DBProxy.
(структура)
Указывает подробности аутентификации, используемые прокси для входа в систему как конкретный пользователь базы данных.
Описание -> (строка)
Имя пользователя -> (строка)
Схема аутентификации -> (строка)
SecretArn -> (строка)
IAMAuth -> (строка)
ENABLED применимо только для прокси с RDS для Microsoft SQL Server.ClientPasswordAuthType -> (строка)
Тип аутентификации, используемый прокси для подключений от клиентов. Следующие значения являются значениями по умолчанию для соответствующих движков:
- RDS для MySQL:
MYSQL_CACHING_SHA2_PASSWORD - RDS для SQL Server:
SQL_SERVER_AUTHENTICATION - RDS для PostgreSQL:
POSTGRES_SCRAM_SHA2_256
Сокращенный синтаксис:
Description=string,UserName=string,AuthScheme=string,SecretArn=string,IAMAuth=string,ClientPasswordAuthType=string ...
Синтаксис JSON:
[
{
"Description": "string",
"UserName": "string",
"AuthScheme": "SECRETS",
"SecretArn": "string",
"IAMAuth": "DISABLED"|"REQUIRED"|"ENABLED",
"ClientPasswordAuthType": "MYSQL_NATIVE_PASSWORD"|"MYSQL_CACHING_SHA2_PASSWORD"|"POSTGRES_SCRAM_SHA_256"|"POSTGRES_MD5"|"SQL_SERVER_AUTHENTICATION"
}
...
]
--require-tls | --no-require-tls (булево)
--idle-client-timeout (целое число)
--debug-logging | --no-debug-logging (булево)
--role-arn (строка)
--security-groups (список)
Новый список групп безопасности для прокси-сервера DBProxy.
(строка)
Синтаксис:
"string" "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 (булево)
Включить отладочную запись в журнал.
--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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Смотрите руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Смотрите Использование кавычек со строками в Руководстве пользователя AWS CLI.
Изменение прокси-сервера БД для базы данных RDS
Следующий modify-db-proxy пример изменяет прокси-сервер БД с именем proxyExample, чтобы потребовать SSL для подключений.
aws rds modify-db-proxy \
--db-proxy-name proxyExample \
--require-tls
Вывод:
{
"DBProxy":
{
"DBProxyName": "proxyExample",
"DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
"Status": "modifying"
"EngineFamily": "PostgreSQL",
"VpcId": "sg-1234567",
"VpcSecurityGroupIds": [
"sg-1234"
],
"VpcSubnetIds": [
"subnetgroup1",
"subnetgroup2"
],
"Auth": "[
{
"Description": "proxydescription1",
"AuthScheme": "SECRETS",
"SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e",
"IAMAuth": "DISABLED"
}
]",
"RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole",
"Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
"RequireTLS": true,
"IdleClientTimeout": 1800,
"DebuggingLogging": false,
"CreatedDate": "2023-04-05T16:09:33.452000+00:00",
"UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
}
}
Дополнительную информацию см. в разделе Изменение прокси-сервера RDS в Руководстве пользователя Amazon RDS и Создание прокси-сервера RDS в Руководстве пользователя Amazon Aurora.
Вывод
DBProxy -> (структура)
Объект DBProxy, представляющий новые параметры прокси-сервера.
DBProxyName -> (строка)
DBProxyArn -> (строка)
Статус -> (строка)
available означает, что прокси-сервер готов обрабатывать запросы. Другие значения указывают, что вам необходимо подождать, пока прокси-сервер будет готов, или предпринять какие-либо действия для решения проблемы.EngineFamily -> (строка)
MYSQL поддерживает базы данных Aurora MySQL, RDS for MariaDB и RDS for MySQL. POSTGRESQL поддерживает базы данных Aurora PostgreSQL и RDS for PostgreSQL. SQLSERVER поддерживает базы данных RDS for Microsoft SQL Server.VpcId -> (строка)
VpcSecurityGroupIds -> (список)
Предоставляет список групп безопасности VPC, к которым принадлежит прокси-сервер.
(строка)
VpcSubnetIds -> (список)
Идентификаторы подсетей EC2 для прокси-сервера.
(строка)
Auth -> (список)
Одна или несколько структур данных, определяющих механизм авторизации для подключения к соответствующему экземпляру базы данных RDS или кластеру Aurora DB.
(структура)
Возвращает сведения об авторизации, используемой прокси-сервером для входа в систему как определённый пользователь базы данных.
Описание -> (строка)
Имя пользователя -> (строка)
AuthScheme -> (строка)
SecretArn -> (строка)
IAMAuth -> (строка)
ClientPasswordAuthType -> (строка)
RoleArn -> (строка)
Endpoint -> (строка)
RequireTLS -> (булево)
IdleClientTimeout -> (целое число)
Количество секунд, в течение которого подключение к прокси-серверу может быть без активности, прежде чем прокси-сервер прервёт клиентское подключение. Прокси-сервер сохраняет базовое подключение к базе данных открытым и возвращает его в пул подключений для повторного использования последующими запросами на подключение.
По умолчанию: 1800 (30 минут)
Ограничения: от 1 до 28 800
DebugLogging -> (булево)
CreatedDate -> (метка времени)
UpdatedDate -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.