Spec-Zone.ru › AWS CLI v2

[ aws . dsql ]

создать-кластер

Описание

API CreateCluster позволяет создавать кластеры как в одной области, так и в нескольких регионах. С помощью параметра multiRegionProperties можно создать кластер с поддержкой свидетельских регионов и установить отношения между кластерами в других регионах во время создания.

Примечание

Создание кластеров в нескольких регионах требует дополнительных разрешений IAM, помимо необходимых для кластеров в одной области, как подробно описано в разделе Необходимые разрешения ниже.

Необходимые разрешения

dsql:CreateCluster

Требуется для создания кластера.

Ресурсы: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Разрешение на добавление тегов к ресурсу.

Ресурсы: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Разрешение на настройку свойств для нескольких регионов кластера.

Ресурсы: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

При указании multiRegionProperties.clusters, разрешение на добавление кластеров-партнёров.

Ресурсы:

  • Локальный кластер: arn:aws:dsql:region:account-id:cluster/*

  • Каждый кластер-партнёр: точный ARN каждого указанного кластера-партнёра

    dsql:PutWitnessRegion

При указании multiRegionProperties.witnessRegion, разрешение на установку свидетельского региона. Это разрешение проверяется как в регионе кластера, так и в свидетельском регионе.

Ресурсы: arn:aws:dsql:region:account-id:cluster/*

Ключи условия: dsql:WitnessRegion (соответствующий указанному свидетельскому региону)

Предупреждение

  • Указанный в multiRegionProperties.witnessRegion свидетельский регион не может совпадать с регионом кластера.

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

Синтаксис

  create-cluster
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--kms-encryption-key <value>]
[--tags <value>]
[--client-token <value>]
[--multi-region-properties <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]

Параметры

--deletion-protection-enabled | --no-deletion-protection-enabled (логическое значение)

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

--kms-encryption-key (строка)

Ключ KMS, который шифрует и защищает данные в кластере. Можно указать ARN, идентификатор или псевдоним существующего ключа или попросить Amazon Web Services создать для вас ключ по умолчанию.

--tags (массив)

Массив пар ключ-значение для тегов кластера.

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

Уникальный ключ тега, максимальная длина 128 Unicode символов в UTF-8.

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

Значение тега, максимальная длина 256 Unicode символов в UTF-8.

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

Уникальный, регистрозависимый идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Идемпотентность гарантирует, что запрос API выполняется только один раз. При идемпотентном запросе, если исходный запрос выполняется успешно, последующие повторы с тем же маркёром клиента возвращают результат от исходного успешного запроса и не имеют дополнительного эффекта.

Если маркер клиента не указан, Amazon Web Services SDK автоматически сгенерирует его.

--multi-region-properties (структура)

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

witnessRegion -> (строка)

Регион, который служит свидетельским регионом для кластера в нескольких регионах. Свидетельский регион помогает поддерживать согласованность и кворум кластера.

clusters -> (список)

Набор связанных кластеров, формирующих конфигурацию кластера в нескольких регионах. Каждый связанный кластер представляет базу данных в другом регионе.

(строка)

Amazon Resource Name кластера.

Сокращённый синтаксис:

witnessRegion=string,clusters=string,string

Синтаксис JSON:

{
  "witnessRegion": "string",
  "clusters": ["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 (логическое значение)

Отключить вывод страницы AWS CLI.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

identifier -> (строка)

Идентификатор созданного кластера.

arn -> (строка)

ARN созданного кластера.

status -> (строка)

Статус созданного кластера.

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

Время создания кластера.

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

Подробная информация о конфигурации кластера в нескольких регионах, заданная при создании кластера

witnessRegion -> (строка)

Регион, который служит свидетельским регионом для кластера в нескольких регионах. Свидетельский регион помогает поддерживать согласованность и кворум кластера.

clusters -> (список)

Набор связанных кластеров, формирующих конфигурацию кластера в нескольких регионах. Каждый связанный кластер представляет базу данных в другом регионе.

(строка)

Amazon Resource Name кластера.

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

Настройки шифрования для кластера, заданные при создании, включая идентификатор ключа KMS и состояние шифрования.

encryptionType -> (строка)

Тип шифрования, защищающего данные в кластере.

kmsKeyArn -> (строка)

ARN ключа KMS, который шифрует данные в кластере.

encryptionStatus -> (строка)

Статус шифрования для кластера.

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

Включена ли защита от удаления для этого кластера.

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

Spec-Zone.ru

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