start-db-cluster
Описание
Перезапускает остановленный кластер, указанный в DBClusterIdentifier. Дополнительную информацию см. в разделе Остановка и запуск кластера Amazon DocumentDB.
См. также: Документация API AWS
Синтаксис
start-db-cluster
--db-cluster-identifier <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 (строка)
docdb-2019-05-28-15-24-52
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.
Для запуска остановленного кластера Amazon DocumentDB
Следующий start-db-cluster пример запускает указанный кластер Amazon DocumentDB.
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
Вывод:
{
"DBCluster": {
"ClusterCreateTime": "2019-03-19T18:45:01.857Z",
"HostedZoneId": "ZNKXH85TT8WVW",
"Engine": "docdb",
"DBClusterMembers": [],
"MultiAZ": false,
"AvailabilityZones": [
"us-east-1a",
"us-east-1c",
"us-east-1f"
],
"StorageEncrypted": false,
"ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Port": 27017,
"PreferredBackupWindow": "00:00-00:30",
"DBSubnetGroup": "default",
"DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
"DBClusterParameterGroup": "default.docdb3.6",
"DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
"MasterUsername": "master-user",
"EngineVersion": "3.6.0",
"BackupRetentionPeriod": 3,
"AssociatedRoles": [],
"Status": "creating",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
]
}
}
Дополнительную информацию см. в разделе Остановка и запуск кластера 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.