Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

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

Описание

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

Примечание

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

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

Синтаксис

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

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

--db-cluster-endpoint-identifier (строка)

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

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Теги, которые необходимо назначить ресурсу Amazon RDS.

(структура)

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

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

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

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

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

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

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

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

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

aws rds create-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --endpoint-type reader \
    --db-cluster-identifier mydbcluster \
    --static-members dbinstance1 dbinstance2

Вывод:

{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "creating",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2"
    ],
    "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