Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

восстановление-кластера-db-по-точке-времени

Описание

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

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

Синтаксис

  restore-db-cluster-to-point-in-time
--db-cluster-identifier <value>
[--restore-type <value>]
--source-db-cluster-identifier <value>
[--restore-to-time <value>]
[--use-latest-restorable-time | --no-use-latest-restorable-time]
[--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]
[--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]

Параметры

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

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

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

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

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

Тип восстановления, который необходимо выполнить. Вы можете указать одно из следующих значений:

  • full-copy - Новый кластер БД восстанавливается как полная копия исходного кластера БД.
  • copy-on-write - Новый кластер БД восстанавливается как клон исходного кластера БД.

Ограничения: Вы не можете указать copy-on-write, если версия движка исходного кластера БД предшествует 1.11.

Если вы не укажете значение RestoreType, то новый кластер БД восстанавливается как полная копия исходного кластера БД.

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

Идентификатор исходного кластера, из которого необходимо восстановить.

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

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

--restore-to-time (метка времени)

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

Допустимые значения: Время в формате Всемирного координированного времени (UTC).

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

  • Должно быть до последнего восстанавливаемого времени для экземпляра.
  • Должно быть указано, если параметр UseLatestRestorableTime не указан.
  • Не может быть указано, если параметр UseLatestRestorableTime равен true.
  • Не может быть указано, если параметр RestoreType равен copy-on-write.

Пример: 2015-03-07T23:45:00Z

--use-latest-restorable-time | --no-use-latest-restorable-time (логическое значение)

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

По умолчанию: false

Ограничения: Не может быть указано, если указан параметр RestoreToTime.

--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.

Вы можете восстановить новый кластер и зашифровать новый кластер с помощью ключа KMS, который отличается от ключа KMS, использовавшегося для шифрования исходного кластера. Новый кластер БД шифруется с помощью ключа KMS, идентифицируемого параметром KmsKeyId.

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

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

Если DBClusterIdentifier относится к не зашифрованному кластеру, запрос на восстановление отклоняется.

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

--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 до определённой точки времени из ручного снимка

В следующем примере используется restore-db-cluster-to-point-in-time для создания нового кластера Amazon DocumentDB, sample-cluster-pit, используя последнее время, с которого возможна реставрация.

aws docdb restore-db-cluster-to-point-in-time \
    --db-cluster-identifier sample-cluster-pit \
    --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --use-latest-restorable-time

Вывод:

{
    "DBCluster": {
        "StorageEncrypted": false,
        "BackupRetentionPeriod": 3,
        "MasterUsername": "master-user",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "PreferredBackupWindow": "00:00-00:30",
        "MultiAZ": false,
        "DBClusterIdentifier": "sample-cluster-pit",
        "DBSubnetGroup": "default",
        "ClusterCreateTime": "2019-04-03T15:55:21.320Z",
        "AssociatedRoles": [],
        "DBClusterParameterGroup": "default.docdb3.6",
        "DBClusterMembers": [],
        "Status": "creating",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2d",
            "us-west-2b"
        ],
        "ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Port": 27017,
        "Engine": "docdb",
        "EngineVersion": "3.6.0",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit"
    }
}

Для получения дополнительной информации см. Восстановление снимка до определенной точки времени в Руководстве разработчика 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 (ARN) для кластера.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

Идентификатор ресурса Amazon (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 (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