Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

создание-точки-доступа-прокси-бд

Описание

Создаёт DBProxyEndpoint. Применимо только к прокси, связанным с кластерами баз данных Aurora. Точки доступа к прокси БД позволяют указать доступ для чтения/записи или только для чтения к кластеру БД. Также точки доступа к прокси БД позволяют получить доступ к прокси через другую VPC, отличную от стандартной VPC прокси.

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

Синтаксис

  create-db-proxy-endpoint
--db-proxy-name <value>
--db-proxy-endpoint-name <value>
--vpc-subnet-ids <value>
[--vpc-security-group-ids <value>]
[--target-role <value>]
[--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 (строка)

Имя прокси БД, связанного с создаваемой точкой доступа к прокси БД.

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

Имя создаваемой точки доступа к прокси БД.

--vpc-subnet-ids (список)

Идентификаторы подсетей VPC для создаваемой точки доступа к прокси БД. Можно указать другой набор идентификаторов подсетей, чем для исходного прокси БД.

(строка)

Синтаксис:

"string" "string" ...

--vpc-security-group-ids (список)

Идентификаторы групп безопасности VPC для создаваемой точки доступа к прокси БД. Можно указать другой набор идентификаторов групп безопасности, чем для исходного прокси БД. По умолчанию используется группа безопасности по умолчанию для VPC.

(строка)

Синтаксис:

"string" "string" ...

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

Роль точки доступа к прокси БД. Роль определяет, может ли точка доступа использоваться для операций чтения/записи или только для чтения. По умолчанию READ_WRITE. Единственная роль, поддерживаемая прокси для RDS для Microsoft SQL Server, — READ_WRITE.

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

  • READ_WRITE
  • READ_ONLY

--tags (список)

Список тегов.

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

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.

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

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

Ключ — это требуемое имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только символы Unicode, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$»).

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

Значение — это необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только символы Unicode, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: «^([\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
  • текст
  • таблица
  • 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

Следующий create-db-proxy-endpoint пример создаёт точку доступа к прокси БД.

aws rds create-db-proxy-endpoint \
    --db-proxy-name proxyExample \
    --db-proxy-endpoint-name "proxyep1" \
    --vpc-subnet-ids subnetgroup1 subnetgroup2

Вывод:

{
"DBProxyEndpoint": {
        "DBProxyEndpointName": "proxyep1",
        "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "creating",
        "VpcId": "vpc-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234",
            "sg-5678"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Endpoint": "proxyep1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "TargetRole": "READ_WRITE",
        "IsDefault": false
    }
}

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

Вывод

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

DBProxyEndpoint объект, созданный операцией API. Создаваемая точка доступа к прокси БД может предоставлять такие возможности, как операции чтения/записи или только чтения, или использование другой VPC, отличной от стандартной VPC прокси.

DBProxyEndpointName -> (строка)

Имя точки доступа к прокси БД. Идентификатор должен начинаться с буквы и содержать только ASCII-буквы, цифры и дефисы; он не может оканчиваться на дефис или содержать два дефиса подряд.

DBProxyEndpointArn -> (строка)

Amazon Resource Name (ARN) для точки доступа к прокси БД.

DBProxyName -> (строка)

Идентификатор прокси БД, связанного с данной точкой доступа к прокси БД.

Статус -> (строка)

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

VpcId -> (строка)

Предоставляет идентификатор VPC точки доступа к прокси БД.

VpcSecurityGroupIds -> (список)

Предоставляет список групп безопасности VPC, к которым принадлежит точка доступа к прокси БД.

(строка)

VpcSubnetIds -> (список)

Идентификаторы подсетей EC2 для точки доступа к прокси БД.

(строка)

Endpoint -> (строка)

Точка доступа, которую можно использовать для подключения к прокси БД. Значение точки доступа включается в строку подключения для приложения-клиента базы данных.

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

Дата и время создания точки доступа к прокси БД.

TargetRole -> (строка)

Значение, указывающее, может ли точка доступа к прокси БД использоваться для операций чтения/записи или только чтения.

IsDefault -> (логическое значение)

Указывает, является ли данная точка доступа стандартной точкой доступа для связанного прокси БД. Стандартные точки доступа прокси БД всегда имеют возможность чтения/записи. Другие точки доступа, которые вы связываете с прокси БД, могут быть либо чтения/записи, либо только чтения.

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

Spec-Zone.ru

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