create-db-cluster
Описание
Создает новый кластер Amazon Neptune DB.
Вы можете использовать параметр ReplicationSourceIdentifier, чтобы создать кластер DB в качестве реплики чтения другого кластера DB или экземпляра Amazon Neptune DB.
Обратите внимание, что при создании нового кластера с помощью CreateDBCluster напрямую, защита от удаления отключена по умолчанию (при создании нового производственного кластера в консоли защита от удаления включена по умолчанию). Вы можете удалить кластер DB только если его поле DeletionProtection установлено в false.
См. также: Документация API AWS
Синтаксис
create-db-cluster
[--availability-zones <value>]
[--backup-retention-period <value>]
[--character-set-name <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--database-name <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>]
[--option-group-name <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--replication-source-identifier <value>]
[--tags <value>]
[--storage-encrypted | --no-storage-encrypted]
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--enable-cloudwatch-logs-exports <value>]
[--deletion-protection | --no-deletion-protection]
[--serverless-v2-scaling-configuration <value>]
[--global-cluster-identifier <value>]
[--storage-type <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 (список)
Список зон доступности EC2, в которых могут быть созданы экземпляры в кластере БД.
(строка)
Синтаксис:
"string" "string" ...
--backup-retention-period (целое число)
Количество дней, в течение которых сохраняются автоматические резервные копии. Необходимо указать минимальное значение 1.
По умолчанию: 1
Ограничения:
- Должно быть значением от 1 до 35
--character-set-name (строка)
--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)
--database-name (строка)
--db-cluster-identifier (строка)
Идентификатор кластера БД. Этот параметр хранится как строка в нижнем регистре.
Ограничения:
- Должно содержать от 1 до 63 букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не должно заканчиваться дефисом и не должно содержать два дефиса подряд.
Пример: my-cluster1
--db-cluster-parameter-group-name (строка)
Имя параметризованной группы кластера БД, которую нужно связать с этим кластером БД. Если этот аргумент опущен, используется значение по умолчанию.
Ограничения:
- При указании должно совпадать с именем существующей параметризованной группы кластера БД.
--vpc-security-group-ids (список)
Список групп безопасности EC2 VPC для связывания с этим кластером БД.
(строка)
Синтаксис:
"string" "string" ...
--db-subnet-group-name (строка)
Группа подсетей БД для связывания с этим кластером БД.
Ограничения: Должно соответствовать имени существующей группы подсетей БД. Не должно быть значением по умолчанию.
Пример: mySubnetgroup
--engine (строка)
Имя движка базы данных, используемого для этого кластера БД.
Допустимые значения: neptune
--engine-version (строка)
Версия движка базы данных для нового кластера БД.
Пример: 1.2.1.0
--port (целое число)
Номер порта, на котором экземпляры в кластере БД принимают подключения.
По умолчанию: 8182
--master-username (строка)
--master-user-password (строка)
--option-group-name (строка)
--preferred-backup-window (строка)
Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены с помощью параметра BackupRetentionPeriod.
По умолчанию — 30-минутный интервал, выбранный случайным образом из 8-часового блока времени для каждой зоны Amazon. Чтобы узнать доступные временные блоки, см. Раздел «Окно обслуживания Neptune» в Руководстве пользователя Amazon Neptune.
Ограничения:
- Должно быть в формате
hh24:mi-hh24:mi. - Должно быть в формате универсального времени координации (UTC).
- Не должно конфликтовать с предпочтительным временем обслуживания.
- Должно быть не менее 30 минут.
--preferred-maintenance-window (строка)
Еженедельный диапазон времени, в течение которого может происходить техническое обслуживание системы, в универсальном координированном времени (UTC).
Формат: ddd:hh24:mi-ddd:hh24:mi
По умолчанию — 30-минутный интервал, выбранный случайным образом из 8-часового блока времени для каждой зоны Amazon, происходящий в произвольный день недели. Чтобы узнать доступные временные блоки, см. Раздел «Окно обслуживания Neptune» в Руководстве пользователя Amazon Neptune.
Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс.
Ограничения: Минимальный интервал — 30 минут.
--replication-source-identifier (строка)
--tags (список)
Теги, которые нужно назначить новому кластеру БД.
(структура)
Метаданные, назначенные ресурсу Amazon Neptune, состоящие из пары ключ-значение.
Ключ -> (строка)
aws: или rds: . Строка может содержать только набор буквенно-цифровых символов Юникода, пробелов, «_», «.», «/», «=», «+», «-» (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).Значение -> (строка)
aws: или rds: . Строка может содержать только набор буквенно-цифровых символов Юникода, пробелов, «_», «.», «/», «=», «+», «-» (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--storage-encrypted | --no-storage-encrypted (логическое значение)
--kms-key-id (строка)
Идентификатор ключа Amazon KMS для зашифрованного кластера БД.
Идентификатор ключа KMS — это Amazon Resource Name (ARN) для ключа шифрования KMS. Если вы создаёте кластер БД с той же учётной записью Amazon, которая владеет ключом шифрования KMS, используемым для шифрования нового кластера БД, вы можете использовать псевдоним ключа KMS вместо ARN для ключа шифрования KMS.
Если ключ шифрования не указан в KmsKeyId:
- Если
ReplicationSourceIdentifierидентифицирует зашифрованный источник, Amazon Neptune использует ключ шифрования, использованный для шифрования источника. В противном случае Amazon Neptune использует ваш ключ шифрования по умолчанию. - Если параметр
StorageEncryptedимеет значение true иReplicationSourceIdentifierне указан, Amazon Neptune использует ваш ключ шифрования по умолчанию.
Amazon KMS создаёт ключ шифрования по умолчанию для вашей учётной записи Amazon. У каждой учётной записи Amazon есть отдельный ключ шифрования по умолчанию для каждой зоны Amazon.
Если вы создаёте реплику чтения зашифрованного кластера БД в другой зоне Amazon, вы должны установить KmsKeyId на идентификатор ключа KMS, действительный в целевой зоне Amazon. Этот ключ используется для шифрования реплики чтения в этой зоне Amazon.
--pre-signed-url (строка)
--enable-iam-database-authentication | --no-enable-iam-database-authentication (логическое значение)
Если установлено в true, включает аутентификацию Amazon Identity and Access Management (IAM) для всего кластера БД (это не может быть установлено на уровне экземпляра).
По умолчанию: false.
--enable-cloudwatch-logs-exports (список)
Список типов логов, которые этот кластер БД должен экспортировать в CloudWatch Logs. Допустимые типы логов: audit (для публикации аудиторских логов) и slowquery (для публикации логов медленных запросов). См. Публикация логов Neptune в Amazon CloudWatch logs.
(строка)
Синтаксис:
"string" "string" ...
--deletion-protection | --no-deletion-protection (логическое значение)
--serverless-v2-scaling-configuration (структура)
Содержит конфигурацию масштабирования кластера БД Neptune Serverless.
Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в Руководстве пользователя Amazon Neptune.
MinCapacity -> (двойное число)
MaxCapacity -> (двойное число)
Сокращённый синтаксис:
MinCapacity=double,MaxCapacity=double
Синтаксис JSON:
{
"MinCapacity": double,
"MaxCapacity": double
}
--global-cluster-identifier (строка)
--storage-type (строка)
Тип хранения для нового кластера БД.
Допустимые значения:
-
**
standard** – ( по умолчанию ) Настраивает экономически эффективный хранилище базы данных для приложений со средним или малым использованием ввода-вывода. При установке вstandardтип хранилища не возвращается в ответе. -
**
iopt1** – Включает оптимизированное хранилище ввода-вывода, предназначенное для удовлетворения потребностей I/O-нагруженных рабочих нагрузок графов, которые требуют предсказуемых цен с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Хранилище Neptune, оптимизированное для ввода-вывода, доступно только начиная с версии движка 1.3.0.0.
--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-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматический запрос параметров ввода CLI.
Вывод
DBCluster -> (структура)
Содержит данные об Amazon Neptune кластере БД.
Этот тип данных используется в качестве элемента ответа в операции DescribeDBClusters.
AllocatedStorage -> (целое число)
AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера Neptune БД не фиксирован, а автоматически подстраивается по мере необходимости.AvailabilityZones -> (список)
Предоставляет список зон доступности EC2, в которых можно создавать экземпляры в кластере БД.
(строка)
BackupRetentionPeriod -> (целое число)
CharacterSetName -> (строка)
DatabaseName -> (строка)
DBClusterIdentifier -> (строка)
DBClusterParameterGroup -> (строка)
DBSubnetGroup -> (строка)
Status -> (строка)
PercentProgress -> (строка)
EarliestRestorableTime -> (временная метка)
Endpoint -> (строка)
ReaderEndpoint -> (строка)
Конечная точка чтения для кластера БД. Конечная точка чтения кластера БД распределяет подключения по всем доступным репликам чтения в кластере БД. По мере запроса клиентами новых подключений к конечной точке чтения Neptune распределяет запросы на подключение между репликами чтения в кластере БД. Эта функциональность помогает сбалансировать рабочую нагрузку чтения по нескольким репликам чтения в вашем кластере БД.
Если произошел сбой и реплика чтения, к которой вы подключены, была повышена до первичного экземпляра, ваше подключение прерывается. Чтобы продолжить отправку рабочей нагрузки чтения другим репликам чтения в кластере, вы можете повторно подключиться к конечной точке чтения.
MultiAZ -> (булево)
Engine -> (строка)
EngineVersion -> (строка)
LatestRestorableTime -> (временная метка)
Port -> (целое число)
MasterUsername -> (строка)
DBClusterOptionGroupMemberships -> (список)
Не поддерживается Neptune.
(структура)
Не поддерживается Neptune.
DBClusterOptionGroupName -> (строка)
Status -> (строка)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod.PreferredMaintenanceWindow -> (строка)
ReplicationSourceIdentifier -> (строка)
ReadReplicaIdentifiers -> (список)
Содержит один или несколько идентификаторов реплик чтения, связанных с этим кластером БД.
(строка)
DBClusterMembers -> (список)
Предоставляет список экземпляров, составляющих кластер БД.
(структура)
Содержит информацию об экземпляре, являющемся частью кластера БД.
DBInstanceIdentifier -> (строка)
IsClusterWriter -> (булево)
true, если член кластера является первичным экземпляром для кластера БД, и false в противном случае.DBClusterParameterGroupStatus -> (строка)
PromotionTier -> (целое число)
VpcSecurityGroups -> (список)
Предоставляет список групп безопасности VPC, к которым принадлежит кластер БД.
(структура)
Этот тип данных используется в качестве элемента ответа для запросов о членстве в группах безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
HostedZoneId -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
StorageEncrypted имеет значение true, то это идентификатор ключа Amazon KMS для зашифрованного кластера БД.DbClusterResourceId -> (строка)
DBClusterArn -> (строка)
AssociatedRoles -> (список)
Предоставляет список ролей управления доступом и идентификацией (IAM) Amazon, связанных с кластером БД. Роли IAM, связанные с кластером БД, предоставляют разрешения кластеру БД на доступ к другим службам Amazon от вашего имени.
(структура)
Описание роли управления доступом и идентификацией (IAM) Amazon, связанной с кластером БД.
RoleArn -> (строка)
Status -> (строка)
Описывает состояние связи между ролью IAM и кластером БД. Свойство Status возвращает одно из следующих значений:
-
ACTIVE- ARN роли IAM связан с кластером БД и может использоваться для доступа к другим службам Amazon от вашего имени. -
PENDING- ARN роли IAM связывается с кластером БД. -
INVALID- ARN роли IAM связан с кластером БД, но кластер БД не может принять роль IAM для доступа к другим службам Amazon от вашего имени.
FeatureName -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево)
CloneGroupId -> (строка)
ClusterCreateTime -> (временная метка)
CopyTagsToSnapshot -> (булево)
EnabledCloudwatchLogsExports -> (список)
Список типов журналов, которые этот кластер БД настроен экспортировать в CloudWatch Logs. Допустимые типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Публикация журналов Neptune в журналы Amazon CloudWatch.
(строка)
PendingModifiedValues -> (структура)
Этот тип данных используется в качестве элемента ответа в операции ModifyDBCluster и содержит изменения, которые будут применены в течение следующего окна технического обслуживания.
PendingCloudwatchLogsExports -> (структура)
Эта PendingCloudwatchLogsExports структура указывает предстоящие изменения, по которым включены и отключены журналы CloudWatch.
LogTypesToEnable -> (список)
Типы журналов, которые находятся в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы журналов, которые находятся в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.
(строка)
DBClusterIdentifier -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево)
EngineVersion -> (строка)
BackupRetentionPeriod -> (целое число)
StorageType -> (строка)
Предстоящее изменение типа хранилища для кластера БД. Допустимые значения:
-
**
standard** – ( по умолчанию ) Настраивает экономически эффективные хранилища базы данных для приложений с умеренным или небольшим использованием ввода/вывода. -
**
iopt1** – Включает оптимизированное по вводу/выводу хранилище, предназначенное для удовлетворения потребностей ресурсоемких графических рабочих нагрузок, которые требуют предсказуемой стоимости с низкой задержкой ввода/вывода и постоянной пропускной способностью ввода/вывода. Оптимизированное хранилище Neptune по вводу/выводу доступно только начиная с версии движка 1.3.0.0.
AllocatedStorage -> (целое число)
AllocatedStorage всегда возвращает 1, поскольку размер хранилища кластера Neptune БД не фиксирован, а автоматически подстраивается по мере необходимости.Iops -> (целое число)
DeletionProtection -> (булево)
CrossAccountClone -> (булево)
true , кластер БД может быть клонирован между учетными записями.AutomaticRestartTime -> (временная метка)
ServerlessV2ScalingConfiguration -> (структура)
Отображает конфигурацию масштабирования для кластера серверного БД Neptune.
Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в руководстве пользователя Amazon Neptune.
MinCapacity -> (double)
MaxCapacity -> (double)
GlobalClusterIdentifier -> (string)
IOOptimizedNextAllowedModificationTime -> (timestamp)
iopt1.StorageType -> (string)
Тип хранения, используемый кластером БД.
Допустимые значения:
-
**
standard** – (по умолчанию) Предоставляет экономичное хранилище базы данных для приложений с умеренным или малым использованием ввода-вывода. -
**
iopt1** – Включает оптимизированное хранилище ввода-вывода, предназначенное для удовлетворения потребностей многозадачных графических рабочих нагрузок, требующих прогнозируемых цен с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Оптимизированное хранилище ввода-вывода Neptune доступно только начиная с версии движка 1.3.0.0.
© Copyright 2025, Amazon Web Services. Created using Sphinx.