Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

восстановление-кластера-db-из-снэпшота

Описание

Создает новый кластер из снимка или снимка кластера.

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

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

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

Синтаксис

  restore-db-cluster-from-snapshot
[--availability-zones <value>]
--db-cluster-identifier <value>
--snapshot-identifier <value>
--engine <value>
[--engine-version <value>]
[--port <value>]
[--db-subnet-group-name <value>]
[--vpc-security-group-ids <value>]
[--tags <value>]
[--kms-key-id <value>]
[--enable-cloudwatch-logs-exports <value>]
[--deletion-protection | --no-deletion-protection]
[--db-cluster-parameter-group-name <value>]
[--storage-type <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" ...

--db-cluster-identifier (строка)

Имя создаваемого кластера из снимка или снимка кластера. Этот параметр не чувствителен к регистру.

Ограничения:

  • Должен содержать от 1 до 63 букв, цифр или дефисов.
  • Первый символ должен быть буквой.
  • Не может заканчиваться дефисом или содержать два дефиса подряд.

Пример: my-snapshot-id

--snapshot-identifier (строка)

Идентификатор снимка или снимка кластера для восстановления.

Для указания снимка кластера можно использовать имя или Amazon Resource Name (ARN). Однако для указания снимка можно использовать только ARN.

Ограничения:

  • Должен соответствовать идентификатору существующего снимка.

--engine (строка)

База данных для использования в новом кластере.

Значение по умолчанию: такое же, как у источника.

Ограничение: должно быть совместимо с базой данных источника.

--engine-version (строка)

Версия базы данных для использования в новом кластере.

--port (целое число)

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

Ограничения: должно быть значением от 1150 до 65535 .

Значение по умолчанию: тот же порт, что и в исходном кластере.

--db-subnet-group-name (строка)

Имя группы подсетей для использования в новом кластере.

Ограничения: если указано, должно совпадать с именем существующей DBSubnetGroup .

Пример: mySubnetgroup

--vpc-security-group-ids (список)

Список групп безопасности виртуальной частной сети (VPC), к которым будет принадлежать новый кластер.

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Теги, которые должны быть назначены восстановленному кластеру.

(структура)

Метаданные, назначенные ресурсу Amazon DocumentDB, состоящие из пары ключ-значение.

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

Требуемое имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только набор букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

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

Необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только набор букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

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

Key=string,Value=string ...

JSON синтаксис:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Идентификатор ключа KMS, который необходимо использовать при восстановлении зашифрованного кластера из снимка базы данных или снимка кластера.

Идентификатор ключа KMS — это Amazon Resource Name (ARN) ключа шифрования KMS. Если вы восстанавливаете кластер с использованием той же учетной записи Amazon Web Services, что и владелец ключа шифрования KMS, используемого для шифрования нового кластера, то вы можете использовать псевдоним ключа KMS вместо ARN ключа шифрования KMS.

Если вы не укажете значение для параметра KmsKeyId, произойдет следующее:

  • Если снимок или снимок кластера в SnapshotIdentifier зашифрован, то восстановленный кластер шифруется с использованием ключа KMS, который использовался для шифрования снимка или снимка кластера.
  • Если снимок или снимок кластера в SnapshotIdentifier не зашифрован, то восстановленный кластер базы данных не шифруется.

--enable-cloudwatch-logs-exports (список)

Список типов журналов, которые должны быть включены для экспорта в Amazon CloudWatch Logs.

(строка)

Синтаксис:

"string" "string" ...

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

Указывает, можно ли удалить этот кластер. Если DeletionProtection включено, кластер нельзя удалить, пока он не будет изменен, и DeletionProtection выключено. DeletionProtection защищает кластеры от случайного удаления.

--db-cluster-parameter-group-name (строка)

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

Тип: Строка. Обязательно: Нет.

Если этот аргумент опущен, используется параметрическая группа кластера базы данных по умолчанию. При указании должно совпадать с именем существующей параметрической группы кластера базы данных по умолчанию. Строка должна состоять из 1–255 букв, цифр или дефисов. Первый символ должен быть буквой, а не должен заканчиваться дефисом или содержать два дефиса подряд.

--storage-type (строка)

Тип хранения, который необходимо связать с кластером базы данных.

Дополнительную информацию о типах хранения для кластеров Amazon DocumentDB см. в разделе Конфигурации хранилища кластера в руководстве разработчика Amazon DocumentDB.

Допустимые значения для типа хранения - standard | iopt1

Значение по умолчанию - standard

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей командной строки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Восстановление кластера Amazon DocumentDB из автоматического или ручного снимка

Следующий пример создает новый кластер Amazon DocumentDB с именем sample-cluster-2019-03-16-00-01-restored из снимка rds:sample-cluster-2019-03-16-00-01.

aws docdb restore-db-cluster-from-snapshot \
    --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \
    --engine docdb \
    --snapshot-identifier rds:sample-cluster-2019-03-16-00-01

Вывод:

{
    "DBCluster": {
        "ClusterCreateTime": "2019-03-19T18:45:01.857Z",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "Engine": "docdb",
        "DBClusterMembers": [],
        "MultiAZ": false,
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2c",
            "us-west-2b"
        ],
        "StorageEncrypted": false,
        "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.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-west-2: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.

Вывод

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 -> (строка)

Указывает еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы в универсальном координированном времени (UTC).

ReplicationSourceIdentifier -> (строка)

Содержит идентификатор исходного кластера, если этот кластер является вторичным кластером.

ReadReplicaIdentifiers -> (список)

Содержит один или несколько идентификаторов вторичных кластеров, связанных с этим кластером.

(строка)

DBClusterMembers -> (список)

Предоставляет список экземпляров, составляющих кластер.

(структура)

Содержит информацию об экземпляре, являющемся частью кластера.

DBInstanceIdentifier -> (строка)

Указывает идентификатор экземпляра для этого члена кластера.

IsClusterWriter -> (булево)

Значение, равное true, если член кластера является основным экземпляром для кластера, и false в противном случае.

DBClusterParameterGroupStatus -> (строка)

Указывает состояние группы параметров кластера для этого члена кластера DB.

PromotionTier -> (целое число)

Значение, определяющее порядок, в котором реплика Amazon DocumentDB повышается до основного экземпляра после сбоя существующего основного экземпляра.

VpcSecurityGroups -> (список)

Предоставляет список групп безопасности виртуальной частной сети (VPC), к которым принадлежит кластер.

(структура)

Используется в качестве элемента ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Состояние группы безопасности VPC.

HostedZoneId -> (строка)

Указывает идентификатор, присвоенный Amazon Route 53 при создании зоны размещения.

StorageEncrypted -> (булево)

Указывает, зашифрован ли кластер.

KmsKeyId -> (строка)

Если StorageEncrypted равно true, идентификатор ключа KMS для зашифрованного кластера.

DbClusterResourceId -> (строка)

Уникальный, неизменяемый идентификатор кластера, специфичный для региона Amazon Web Services. Этот идентификатор находится в журналах CloudTrail всякий раз, когда к ключу KMS для кластера осуществляется доступ.

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для кластера.

AssociatedRoles -> (список)

Предоставляет список ролей управления доступом и идентификацией (IAM), связанных с кластером. Роли (IAM), связанные с кластером, предоставляют разрешения кластеру на доступ к другим службам Amazon Web Services от вашего имени.

(структура)

Описание роли управления доступом и идентификацией (IAM), связанной с кластером.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с кластером DB.

Status -> (строка)

Описание состояния ассоциации между ролью IAM и кластером. Свойство Status возвращает одно из следующих значений:

  • ACTIVE - ARN роли IAM связан с кластером и может использоваться для доступа к другим службам Amazon Web Services от вашего имени.
  • PENDING - ARN роли IAM связывается с кластером.
  • INVALID - ARN роли IAM связан с кластером, но кластер не может принять роль IAM для доступа к другим службам Amazon Web Services от вашего имени.

CloneGroupId -> (строка)

Идентифицирует группу клонов, к которой связан кластер DB.

ClusterCreateTime -> (метка времени)

Указывает время создания кластера в универсальном координированном времени (UTC).

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 -> (строка)

Amazon Resource Name (ARN) секрета.

SecretStatus -> (строка)

Состояние секрета.

Возможные значения состояния включают следующие:

  • creating - Секрет создается.
  • active - Секрет доступен для обычного использования и вращения.
  • rotating - Секрет вращается.
  • impaired - Секрет можно использовать для доступа к учетным данным базы данных, но его нельзя вращать. Секрет может иметь это состояние, например, если права изменены таким образом, что Amazon DocumentDB больше не может получить доступ к секрету или ключу KMS для секрета. Когда у секрета такое состояние, вы можете исправить условие, которое вызвало это состояние. Или измените экземпляр, чтобы отключить автоматическое управление учетными данными базы данных, а затем снова измените экземпляр, чтобы включить автоматическое управление учетными данными базы данных.

KmsKeyId -> (строка)

Идентификатор ключа KMS Amazon Web Services, используемого для шифрования секрета.

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

Spec-Zone.ru

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