Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

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

Описание

Изменяет свойства точки доступа в кластере баз данных Amazon Aurora.

Примечание

Данная операция применима только к кластерам баз данных Aurora.

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

Синтаксис

  modify-db-cluster-endpoint
--db-cluster-endpoint-identifier <value>
[--endpoint-type <value>]
[--static-members <value>]
[--excluded-members <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-cluster-endpoint-identifier (строка)

Идентификатор точки доступа для изменения. Этот параметр хранится в виде строчной строки.

--endpoint-type (строка)

Тип точки доступа. Один из: READER , WRITER , ANY .

--static-members (список)

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

(строка)

Синтаксис:

"string" "string" ...

--excluded-members (список)

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

(строка)

Синтаксис:

"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.

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

Следующий modify-db-cluster-endpoint пример изменяет указанную пользовательскую точку доступа к кластеру БД.

aws rds modify-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --static-members dbinstance1 dbinstance2 dbinstance3

Вывод:

{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "modifying",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2",
        "dbinstance3"
    ],
    "ExcludedMembers": [],
    "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint"
}

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

Вывод

DBClusterEndpointIdentifier -> (строка)

Идентификатор, связанный с точкой доступа. Этот параметр хранится в виде строчной строки.

DBClusterIdentifier -> (строка)

Идентификатор кластера БД, связанный с точкой доступа. Этот параметр хранится в виде строчной строки.

DBClusterEndpointResourceIdentifier -> (строка)

Уникальный системный идентификатор точки доступа. Он остаётся неизменным на протяжении всего срока службы точки доступа.

Endpoint -> (строка)

DNS-адрес точки доступа.

Status -> (строка)

Текущий статус точки доступа. Один из: creating , available , deleting , inactive , modifying . Состояние inactive относится к точке доступа, которая не может быть использована для определённого типа кластера, например, точка доступа writer для вторичного кластера чтения в глобальной базе данных.

EndpointType -> (строка)

Тип точки доступа. Один из: READER , WRITER , CUSTOM .

CustomEndpointType -> (строка)

Тип, связанный с пользовательской точкой доступа. Один из: READER , WRITER , ANY .

StaticMembers -> (список)

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

(строка)

ExcludedMembers -> (список)

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

(строка)

DBClusterEndpointArn -> (строка)

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

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

Spec-Zone.ru

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