создать-базу-данных-кластер
Описание
Создаёт новый кластер Amazon DocumentDB.
См. также: Документацию API AWS
Синтаксис
create-db-cluster
[--availability-zones <value>]
[--backup-retention-period <value>]
--db-cluster-identifier <value>
[--db-cluster-parameter-group-name <value>]
[--vpc-security-group-ids <value>]
[--db-subnet-group-name <value>]
--engine <value>
[--engine-version <value>]
[--port <value>]
[--master-username <value>]
[--master-user-password <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--tags <value>]
[--storage-encrypted | --no-storage-encrypted]
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--enable-cloudwatch-logs-exports <value>]
[--deletion-protection | --no-deletion-protection]
[--global-cluster-identifier <value>]
[--storage-type <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--source-region <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]
Параметры
--availability-zones (список)
Список зон доступности Amazon EC2, в которых можно создавать экземпляры кластера.
(строка)
Синтаксис:
"string" "string" ...
--backup-retention-period (целое число)
Количество дней, в течение которых сохраняются автоматические резервные копии. Необходимо указать значение не меньше 1.
По умолчанию: 1
Ограничения:
- Должно быть значением от 1 до 35.
--db-cluster-identifier (строка)
Идентификатор кластера. Этот параметр хранится как строка в нижнем регистре.
Ограничения:
- Должен содержать от 1 до 63 букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не может заканчиваться дефисом или содержать два дефиса подряд.
Пример: my-cluster
--db-cluster-parameter-group-name (строка)
--vpc-security-group-ids (список)
Список групп безопасности EC2 VPC, которые нужно связать с этим кластером.
(строка)
Синтаксис:
"string" "string" ...
--db-subnet-group-name (строка)
Группа подсетей для связи с этим кластером.
Ограничения: Должен совпадать с именем существующей DBSubnetGroup . Не должен быть значением по умолчанию.
Пример: mySubnetgroup
--engine (строка)
Имя базы данных, которое нужно использовать для этого кластера.
Допустимые значения: docdb
--engine-version (строка)
--engine-version по умолчанию будет установлена на последнюю версию основного движка. Для рабочих нагрузок в производстве рекомендуется явно указывать этот параметр с предполагаемой основной версией движка.--port (целое число)
--master-username (строка)
Имя пользователя-мастера для кластера.
Ограничения:
- Должен состоять из 1-63 букв или цифр.
- Первый символ должен быть буквой.
- Не должен быть зарезервированным словом для выбранного движка базы данных.
--master-user-password (строка)
Пароль для пользователя-мастера базы данных. Этот пароль может содержать любые печатные символы ASCII, кроме слеша (/), двойной кавычки (“) или символа «@».
Ограничения: Должен содержать от 8 до 100 символов.
--preferred-backup-window (строка)
Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены с помощью параметра BackupRetentionPeriod.
По умолчанию используется 30-минутный интервал, случайным образом выбранный из 8-часового временного блока для каждой области Amazon Web Services.
Ограничения:
- Должен быть в формате
hh24:mi-hh24:mi. - Должен быть в формате Всемирного координированного времени (UTC).
- Не должен конфликтовать с предпочтительным временем обслуживания.
- Должен составлять не менее 30 минут.
--preferred-maintenance-window (строка)
Недельный интервал времени, в течение которого может происходить техническое обслуживание системы, в формате Всемирного координированного времени (UTC).
Формат: ddd:hh24:mi-ddd:hh24:mi
По умолчанию — 30-минутный интервал, случайным образом выбранный из 8-часового временного блока для каждой области Amazon Web Services, происходящий в случайный день недели.
Допустимые дни: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Ограничения: Минимальный интервал 30 минут.
--tags (список)
Теги, которые должны быть назначены кластеру.
(структура)
Метаданные, назначенные ресурсу Amazon DocumentDB, состоящие из пары «ключ-значение».
Ключ -> (строка)
aws: » или «rds: ». Строка может содержать только набор Unicode-букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).Значение -> (строка)
aws: » или «rds: ». Строка может содержать только набор Unicode-букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--storage-encrypted | --no-storage-encrypted (булево)
--kms-key-id (строка)
Идентификатор ключа KMS для зашифрованного кластера.
Идентификатор ключа KMS — это имя Amazon Resource Name (ARN) для ключа шифрования KMS. Если вы создаёте кластер с использованием той же учётной записи Amazon Web Services, что и ключ шифрования KMS, используемый для шифрования нового кластера, вы можете использовать псевдоним ключа KMS вместо ARN ключа шифрования KMS.
Если ключ шифрования не указан в KmsKeyId :
- Если параметр
StorageEncryptedравенtrue, Amazon DocumentDB использует ваш ключ шифрования по умолчанию.
KMS создаёт ключ шифрования по умолчанию для вашей учётной записи Amazon Web Services. У каждой области Amazon Web Services у вашей учётной записи Amazon Web Services есть свой ключ шифрования по умолчанию.
--pre-signed-url (строка)
--enable-cloudwatch-logs-exports (список)
Список типов журналов, которые нужно включить для экспорта в Amazon CloudWatch Logs. Можно включить журналы аудита или профилирования. Дополнительные сведения см. в разделах Аудит событий Amazon DocumentDB и Профилирование операций Amazon DocumentDB.
(строка)
Синтаксис:
"string" "string" ...
--deletion-protection | --no-deletion-protection (булево)
DeletionProtection включено, кластер нельзя удалить, пока он не будет изменён, а DeletionProtection выключено. DeletionProtection защищает кластеры от случайного удаления.--global-cluster-identifier (строка)
--storage-type (строка)
Тип хранилища, который нужно связать с кластером БД.
Дополнительную информацию о типах хранилища для кластеров Amazon DocumentDB см. в руководстве по разработке Amazon DocumentDB в разделе Настройки хранилища кластера.
Допустимые значения для типа хранилища - standard | iopt1
Значение по умолчанию — standard
Примечание
При создании кластера DocumentDB DB с типом хранилища, установленным наiopt1 , тип хранилища возвращается в ответе. Тип хранилища не возвращается при установке его на standard .--manage-master-user-password | --no-manage-master-user-password (булево)
--master-user-secret-kms-key-id (строка)
Идентификатор ключа KMS Amazon Web Services для шифрования секрета, который автоматически генерируется и управляется в Amazon Web Services Secrets Manager. Это значение действует только в том случае, если пароль пользователя-мастера управляется Amazon DocumentDB в Amazon Web Services Secrets Manager для кластера БД.
Идентификатор ключа KMS Amazon Web Services — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима ключа KMS. Чтобы использовать ключ KMS в другой учётной записи Amazon Web Services, укажите ARN ключа или ARN псевдонима.
Если вы не укажете MasterUserSecretKmsKeyId , то используется aws/secretsmanager ключ KMS для шифрования секрета. Если секрет находится в другой учётной записи Amazon Web Services, то вы не можете использовать aws/secretsmanager ключ KMS для шифрования секрета, и вам необходимо использовать управляемый клиентом ключ KMS.
У вашей учётной записи Amazon Web Services есть ключ KMS по умолчанию для каждой области Amazon Web Services.
--source-region (строка)
--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 (boolean)
Включить отладовую запись журнала.
--endpoint-url (string)
Переопределить URL по умолчанию команды на указанный URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования для вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут представлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить вывод пагинатора CLI.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров входных данных CLI.
Примеры
Примечание
Для использования следующих примеров, у вас должен быть установлен и настроен AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иное, во всех примерах используются правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для создания кластера Amazon DocumentDB
Следующий create-db-cluster пример создает кластер Amazon DocumentDB с именем sample-cluster с предпочтительным окном обслуживания по воскресеньям между 20:30 и 11:00.
aws docdb create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine docdb \
--master-username master-user \
--master-user-password password \
--preferred-maintenance-window Sun:20:30-Sun:21:00
Вывод:
{
"DBCluster": {
"DBClusterParameterGroup": "default.docdb3.6",
"AssociatedRoles": [],
"DBSubnetGroup": "default",
"ClusterCreateTime": "2019-03-18T18:06:34.616Z",
"Status": "creating",
"Port": 27017,
"PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
"HostedZoneId": "ZNKXH85TT8WVW",
"DBClusterMembers": [],
"Engine": "docdb",
"DBClusterIdentifier": "sample-cluster",
"PreferredBackupWindow": "10:12-10:42",
"AvailabilityZones": [
"us-west-2d",
"us-west-2f",
"us-west-2e"
],
"MasterUsername": "master-user",
"BackupRetentionPeriod": 1,
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"StorageEncrypted": false,
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
"MultiAZ": false,
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"EngineVersion": "3.6.0"
}
}
Для получения дополнительной информации см. раздел Создание кластера Amazon DocumentDB в Руководстве разработчика Amazon DocumentDB.
Вывод
DBCluster -> (структура)
Подробная информация о кластере.
AvailabilityZones -> (список)
Предоставляет список зон доступности Amazon EC2, в которых можно создавать экземпляры в кластере.
(строка)
BackupRetentionPeriod -> (целое число)
DBClusterIdentifier -> (строка)
DBClusterParameterGroup -> (строка)
DBSubnetGroup -> (строка)
Status -> (строка)
PercentProgress -> (строка)
EarliestRestorableTime -> (метка времени)
Endpoint -> (строка)
ReaderEndpoint -> (строка)
Конечная точка чтения для кластера. Конечная точка чтения для кластера балансирует подключения между репликами Amazon DocumentDB, доступными в кластере. По мере запроса клиентами новых подключений к конечной точке чтения Amazon DocumentDB распределяет запросы на подключение между репликами Amazon DocumentDB в кластере. Эта функция может помочь сбалансировать вашу рабочую нагрузку чтения между несколькими репликами Amazon DocumentDB в вашем кластере.
Если произойдет отказ, и реплика Amazon DocumentDB, к которой вы подключены, будет повышена до основного экземпляра, ваше подключение будет разорвано. Чтобы продолжить отправку вашей рабочей нагрузки чтения на другие реплики Amazon DocumentDB в кластере, вы можете повторно подключиться к конечной точке чтения.
MultiAZ -> (булево)
Engine -> (строка)
EngineVersion -> (строка)
LatestRestorableTime -> (метка времени)
Port -> (целое число)
MasterUsername -> (строка)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod.PreferredMaintenanceWindow -> (строка)
ReplicationSourceIdentifier -> (строка)
ReadReplicaIdentifiers -> (список)
Содержит один или несколько идентификаторов вторичных кластеров, связанных с этим кластером.
(строка)
DBClusterMembers -> (список)
Предоставляет список экземпляров, составляющих кластер.
(структура)
Содержит информацию об экземпляре, являющемся частью кластера.
DBInstanceIdentifier -> (строка)
IsClusterWriter -> (булево)
true, если член кластера является основным экземпляром для кластера, и false в противном случае.DBClusterParameterGroupStatus -> (строка)
PromotionTier -> (целое число)
VpcSecurityGroups -> (список)
Предоставляет список групп безопасности виртуальной частной сети (VPC), к которым принадлежит кластер.
(структура)
Используется в качестве элемента ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).
VpcSecurityGroupId -> (строка)
Status -> (строка)
HostedZoneId -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
StorageEncrypted равно true, идентификатор ключа KMS для зашифрованного кластера.DbClusterResourceId -> (строка)
DBClusterArn -> (строка)
AssociatedRoles -> (список)
Предоставляет список ролей управления доступом и идентификацией (IAM), связанных с кластером. Роли (IAM), связанные с кластером, предоставляют разрешение кластеру для доступа к другим службам Amazon Web Services от вашего имени.
(структура)
Описание роли управления доступом и идентификацией (IAM), связанной с кластером.
RoleArn -> (строка)
Status -> (строка)
Описание состояния связи между ролью IAM и кластером. Свойство Status возвращает одно из следующих значений:
-
ACTIVE- ARN роли IAM связан с кластером и может быть использован для доступа к другим службам Amazon Web Services от вашего имени. -
PENDING- ARN роли IAM связывается с кластером. -
INVALID- ARN роли IAM связан с кластером, но кластер не может принять роль IAM для доступа к другим службам Amazon Web Services от вашего имени.
CloneGroupId -> (строка)
ClusterCreateTime -> (метка времени)
EnabledCloudwatchLogsExports -> (список)
Список типов журналов, которые этот кластер настроен на экспорт в Amazon CloudWatch Logs.
(строка)
DeletionProtection -> (булево)
DeletionProtection включено, кластер нельзя удалить, пока он не будет изменён, и DeletionProtection не будет отключено. DeletionProtection защищает кластеры от случайного удаления.StorageType -> (строка)
Тип хранилища, связанный с вашим кластером
Тип хранилища, связанный с вашим кластером
Дополнительную информацию о типах хранилища для кластеров Amazon DocumentDB см. в разделе «Конфигурации хранилища кластеров» в «Руководстве разработчика Amazon DocumentDB».
Допустимые значения для типа хранилища - standard | iopt1
Значение по умолчанию - standard
MasterUserSecret -> (структура)
Секрет, управляемый Amazon DocumentDB в Amazon Web Services Secrets Manager для пароля пользователя мастера.
SecretArn -> (строка)
SecretStatus -> (строка)
Состояние секрета.
Возможные значения состояния включают:
- creating - Секрет создается.
- active - Секрет доступен для обычного использования и вращения.
- rotating - Секрет вращается.
- impaired - Секрет может быть использован для доступа к учетным данным базы данных, но не может быть изменён. Секрет может иметь это состояние, если, например, права изменены таким образом, что Amazon DocumentDB больше не может получить доступ к секрету или ключу KMS для секрета. Когда секрет имеет это состояние, вы можете исправить условие, вызвавшее это состояние. В качестве альтернативы измените экземпляр, чтобы отключить автоматическое управление учетными данными базы данных, а затем измените экземпляр снова, чтобы включить автоматическое управление учетными данными базы данных.
KmsKeyId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.