create-db-proxy
Описание
Создает новый прокси-сервер базы данных.
См. также: Документацию API AWS
Синтаксис
create-db-proxy
--db-proxy-name <value>
--engine-family <value>
--auth <value>
--role-arn <value>
--vpc-subnet-ids <value>
[--vpc-security-group-ids <value>]
[--require-tls | --no-require-tls]
[--idle-client-timeout <value>]
[--debug-logging | --no-debug-logging]
[--tags <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 (строка)
--engine-family (строка)
Типы баз данных, к которым может подключиться прокси-сервер. Это значение определяет, какой сетевой протокол базы данных прокси-сервер распознает при интерпретации сетевого трафика к базе данных и от нее. Для баз данных Aurora MySQL, RDS for MariaDB и RDS for MySQL укажите MYSQL. Для баз данных Aurora PostgreSQL и RDS for PostgreSQL укажите POSTGRESQL. Для баз данных RDS for Microsoft SQL Server укажите SQLSERVER.
Возможные значения:
MYSQLPOSTGRESQLSQLSERVER
--auth (список)
Механизм авторизации, используемый прокси-сервером.
(структура)
Указывает подробности аутентификации, используемой прокси-сервером для входа в систему как определенный пользователь базы данных.
Описание -> (строка)
Имя пользователя -> (строка)
Схема аутентификации -> (строка)
SecretArn -> (строка)
IAMAuth -> (строка)
ENABLED допустимо только для прокси-серверов с RDS для Microsoft SQL Server.Тип аутентификации пароля клиента -> (строка)
Тип аутентификации, используемый прокси-сервером для подключений от клиентов. Следующие значения являются значениями по умолчанию для соответствующих движков:
- 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"
}
...
]
--role-arn (строка)
--vpc-subnet-ids (список)
Один или несколько идентификаторов подсетей VPC, которые необходимо связать с новым прокси-сервером.
(строка)
Синтаксис:
"string" "string" ...
--vpc-security-group-ids (список)
Один или несколько идентификаторов групп безопасности VPC, которые необходимо связать с новым прокси-сервером.
(строка)
Синтаксис:
"string" "string" ...
--require-tls | --no-require-tls (булево)
--idle-client-timeout (целое число)
--debug-logging | --no-debug-logging (булево)
--tags (список)
Необязательный набор пар ключ-значение для присвоения произвольных данных по вашему выбору прокси-серверу.
(структура)
Метки, назначенные ресурсу Amazon RDS, состоящие из пары ключ-значение.
Дополнительную информацию см. в разделе Маркирование ресурсов Amazon RDS в Руководстве пользователя Amazon RDS или Маркирование ресурсов Amazon Aurora и Amazon RDS в Руководстве пользователя Amazon Aurora.
Ключ -> (строка)
aws: или rds:. Строка может содержать только набор символов Unicode, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Значение -> (строка)
aws: или rds:. Строка может содержать только набор символов Unicode, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Сокращенный синтаксис:
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 (булево)
Включить отладочную регистрацию.
--endpoint-url (строка)
Переопределить URL по умолчанию команды на предоставленный URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--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
Следующий create-db-proxy пример создает прокси-сервер базы данных.
aws rds create-db-proxy \
--db-proxy-name proxyExample \
--engine-family MYSQL \
--auth Description="proxydescription1",AuthScheme="SECRETS",SecretArn="arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",IAMAuth="DISABLED",ClientPasswordAuthType="MYSQL_NATIVE_PASSWORD" \
--role-arn arn:aws:iam::123456789123:role/ProxyRole \
--vpc-subnet-ids subnetgroup1 subnetgroup2
Вывод:
{
"DBProxy": {
"DBProxyName": "proxyExample",
"DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
"EngineFamily": "MYSQL",
"VpcId": "vpc-1234567",
"VpcSecuritytGroupIds": [
"sg-1234",
"sg-5678",
"sg-9101"
],
"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/ProxyRole",
"Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
"RequireTLS": false,
"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 -> (строка)
Status -> (строка)
available означает, что прокси-сервер готов обрабатывать запросы. Другие значения указывают, что необходимо подождать, пока прокси-сервер будет готов, или предпринять действия для решения проблемы.EngineFamily -> (строка)
MYSQL поддерживает базы данных Aurora MySQL, RDS для MariaDB и RDS для MySQL. POSTGRESQL поддерживает базы данных Aurora PostgreSQL и RDS для PostgreSQL. SQLSERVER поддерживает базы данных RDS для Microsoft SQL Server.VpcId -> (строка)
VpcSecurityGroupIds -> (список)
Предоставляет список групп безопасности VPC, к которым принадлежит прокси-сервер.
(строка)
VpcSubnetIds -> (список)
Идентификаторы подсетей EC2 для прокси-сервера.
(строка)
Auth -> (список)
Одна или несколько структур данных, определяющих механизм авторизации для подключения к связанному экземпляру RDS DB или кластеру Aurora DB.
(структура)
Возвращает подробности аутентификации, используемой прокси-сервером для входа в систему как определённому пользователю базы данных.
Description -> (строка)
UserName -> (строка)
AuthScheme -> (строка)
SecretArn -> (строка)
IAMAuth -> (строка)
ClientPasswordAuthType -> (строка)
RoleArn -> (строка)
Endpoint -> (строка)
RequireTLS -> (булево)
IdleClientTimeout -> (целое число)
Количество секунд, в течение которых подключение к прокси-серверу может не иметь активности, прежде чем прокси-сервер разорвёт подключение клиента. Прокси-сервер держит основное соединение с базой данных открытым и возвращает его в пул соединений для повторного использования последующими запросами на подключение.
По умолчанию: 1800 (30 минут)
Ограничения: от 1 до 28800
DebugLogging -> (булево)
CreatedDate -> (метка времени)
UpdatedDate -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.