[ aws . docdb-elastic ]
create-cluster
Описание
Создаёт новый Amazon DocumentDB эластичный кластер и возвращает его структуру.
См. также: Документация AWS API
Синтаксис
create-cluster
--admin-user-name <value>
--admin-user-password <value>
--auth-type <value>
[--backup-retention-period <value>]
[--client-token <value>]
--cluster-name <value>
[--kms-key-id <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
--shard-capacity <value>
--shard-count <value>
[--shard-instance-count <value>]
[--subnet-ids <value>]
[--tags <value>]
[--vpc-security-group-ids <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]
Параметры
--admin-user-name (строка)
Имя администратора Amazon DocumentDB эластичного кластера.
- Должно состоять из 1–63 букв или цифр.
- Первый символ должен быть буквой.
- Не должно быть зарезервированным словом.
--admin-user-password (строка)
Пароль администратора Amazon DocumentDB эластичного кластера. Пароль может содержать любые печатные символы ASCII.
- Должно содержать от 8 до 100 символов.
- Не должно содержать слеш (/), двойные кавычки (“) или символ «@».
--auth-type (строка)
Тип аутентификации, используемый для определения места получения пароля для доступа к эластичному кластеру. Допустимые типы — PLAIN_TEXT или SECRET_ARN.
Возможные значения:
PLAIN_TEXTSECRET_ARN
--backup-retention-period (целое число)
--client-token (строка)
--cluster-name (строка)
Имя нового эластичного кластера. Этот параметр хранится как строка в нижнем регистре.
- Должно содержать от 1 до 63 букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не должно заканчиваться на дефис или содержать два дефиса подряд.
my-cluster
--kms-key-id (строка)
Идентификатор ключа KMS, используемый для шифрования нового эластичного кластера.
Идентификатор ключа KMS — это Amazon Resource Name (ARN) ключа шифрования KMS. Если вы создаёте кластер с использованием той же учётной записи Amazon, которая владеет этим ключом шифрования KMS, вы можете использовать псевдоним ключа KMS вместо ARN в качестве ключа шифрования KMS.
Если ключ шифрования не указан, Amazon DocumentDB использует стандартный ключ шифрования, созданный KMS для вашей учётной записи. Для каждой области Amazon Web Services у вашей учётной записи есть отдельный стандартный ключ шифрования.
--preferred-backup-window (строка)
backupRetentionPeriod.--preferred-maintenance-window (строка)
Диапазон времени в течение недели, в который может выполняться техническое обслуживание системы в формате UTC.
Формат : ddd:hh24:mi-ddd:hh24:mi
По умолчанию : 30-минутный интервал, случайным образом выбранный из 8-часового блока времени для каждой области Amazon Web Services, происходящий в случайный день недели.
Допустимые дни : Пн, Вт, Ср, Чт, Пт, Сб, Вс
Ограничения : Минимальный 30-минутный интервал.
--shard-capacity (целое число)
--shard-count (целое число)
--shard-instance-count (целое число)
shardInstanceCount равное 1 означает, что есть один экземпляр записи, и любые дополнительные экземпляры являются репликами, которые могут использоваться для чтения и повышения доступности.--subnet-ids (список)
Идентификаторы подсетей Amazon EC2 для нового эластичного кластера.
(строка)
Синтаксис:
"string" "string" ...
--tags (карта)
Теги, которые должны быть назначены новому эластичному кластеру.
ключ -> (строка)
значение -> (строка)
Упрощённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--vpc-security-group-ids (список)
Список групп безопасности EC2 VPC для ассоциации с новым эластичным кластером.
(строка)
Синтаксис:
"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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
cluster -> (структура)
Созданный новый эластичный кластер.
adminUserName -> (строка)
authType -> (строка)
backupRetentionPeriod -> (целое число)
clusterArn -> (строка)
clusterEndpoint -> (строка)
clusterName -> (строка)
createTime -> (строка)
kmsKeyId -> (строка)
preferredBackupWindow -> (строка)
backupRetentionPeriod.preferredMaintenanceWindow -> (строка)
Диапазон времени в течение недели, в который может выполняться техническое обслуживание системы в формате UTC.
ddd:hh24:mi-ddd:hh24:mi
shardCapacity -> (целое число)
shardCount -> (целое число)
shardInstanceCount -> (целое число)
shardInstanceCount равное 1 означает, что есть один экземпляр записи, и любые дополнительные экземпляры являются репликами, которые могут использоваться для чтения и повышения доступности.shards -> (список)
Общее количество фрагментов в кластере.
(структура)
Имя фрагмента.
createTime -> (строка)
shardId -> (строка)
status -> (строка)
status -> (строка)
subnetIds -> (список)
Идентификаторы подсетей Amazon EC2 для эластичного кластера.
(строка)
vpcSecurityGroupIds -> (список)
Список групп безопасности EC2 VPC, связанных с этим эластичным кластером.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.