Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

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

Описание

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

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

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

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

Синтаксис

  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>]
[--database-name <value>]
[--option-group-name <value>]
[--vpc-security-group-ids <value>]
[--tags <value>]
[--kms-key-id <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--enable-cloudwatch-logs-exports <value>]
[--db-cluster-parameter-group-name <value>]
[--deletion-protection | --no-deletion-protection]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--serverless-v2-scaling-configuration <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 (список)

Предоставляет список зон доступности EC2, в которых можно создать экземпляры в восстановленном кластере DB.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

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

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

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

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

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

--engine (строка)

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

По умолчанию: такая же, как у источника

Ограничение: должна быть совместима с системой управления данными источника

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

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

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

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

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

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

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

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

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

Пример: mySubnetgroup

--database-name (строка)

Не поддерживается.

--option-group-name (строка)

(Не поддерживается Neptune)

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

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

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

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

(структура)

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

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

Ключ — это требуемое имя тега. Строковое значение может иметь длину от 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 (строка)

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

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

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

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

--enable-iam-database-authentication | --no-enable-iam-database-authentication (логическое значение)

True, чтобы включить сопоставление учётных записей Amazon Identity and Access Management (IAM) с учётными записями базы данных, и false в противном случае.

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

  • Если указано, должно совпадать с именем существующей группы параметров кластера DB.

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

Значение, указывающее, включена ли защита от удаления для кластера DB. При включённой защите от удаления база данных не может быть удалена. По умолчанию защита от удаления выключена.

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)

Если установлено в ``true`` , теги копируются в любой созданный снимок восстановленного кластера DB.

--serverless-v2-scaling-configuration (структура)

Содержит конфигурацию масштабирования кластера Serverless DB Neptune.

Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в руководстве пользователя Amazon Neptune.

MinCapacity -> (двойное значение)

Минимальное количество единиц ёмкости Neptune (NCU) для экземпляра DB в кластере Serverless Neptune. Можно указывать значения NCU с шагом 0,5, например, 8, 8,5, 9 и т. д.

MaxCapacity -> (двойное значение)

Максимальное количество единиц ёмкости Neptune (NCU) для экземпляра DB в кластере Serverless Neptune. Можно указывать значения NCU с шагом 0,5, например, 40, 40,5, 41 и т. д.

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

MinCapacity=double,MaxCapacity=double

Синтаксис JSON:

{
  "MinCapacity": double,
  "MaxCapacity": double
}

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

Указывает тип хранилища, который следует связать с кластером DB.

Допустимые значения: 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
  • text
  • таблица
  • 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.

Вывод

DBCluster -> (структура)

Содержит сведения об Amazon Neptune кластере баз данных.

Этот тип данных используется в качестве элемента ответа в операции DescribeDBClusters.

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

AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера баз данных Neptune не фиксирован, а автоматически корректируется по мере необходимости.

AvailabilityZones -> (список)

Предоставляет список зон доступности EC2, в которых можно создавать экземпляры в кластере баз данных.

(строка)

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

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

CharacterSetName -> (строка)

Не поддерживается Neptune.

DatabaseName -> (строка)

Содержит имя начальной базы данных этого кластера баз данных, предоставленное при создании, если оно было указано при создании кластера баз данных. Это имя возвращается на протяжении всего жизненного цикла кластера баз данных.

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

Указывает текущее состояние этого кластера баз данных.

PercentProgress -> (строка)

Указывает процент выполнения операции.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

Конечная точка чтения для кластера баз данных. Конечная точка чтения для кластера баз данных распределяет подключения между доступными репликами чтения в кластере баз данных. При запросе новых подключений клиентами Neptune распределяет запросы подключений среди реплик чтения в кластере баз данных. Эта функция может помочь сбалансировать вашу рабочую нагрузку чтения между несколькими репликами чтения в кластере баз данных.

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

MultiAZ -> (булево)

Указывает, содержит ли кластер баз данных экземпляры в нескольких зонах доступности.

Engine -> (строка)

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

EngineVersion -> (строка)

Указывает версию движка базы данных.

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

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

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

Указывает порт, на котором слушает движок базы данных.

MasterUsername -> (строка)

Не поддерживается Neptune.

DBClusterOptionGroupMemberships -> (список)

Не поддерживается Neptune.

(структура)

Не поддерживается Neptune.

DBClusterOptionGroupName -> (строка)

Не поддерживается Neptune.

Status -> (строка)

Не поддерживается Neptune.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

Не поддерживается Neptune.

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

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

(структура)

Содержит сведения об экземпляре, входящем в состав кластера баз данных.

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Идентификатор ресурса Amazon (ARN) для кластера баз данных.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, связанной с кластером баз данных.

Status -> (строка)

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

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

FeatureName -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

Истина, если сопоставление учетных записей Amazon Identity and Access Management (IAM) с учетными записями баз данных включено, и ложь в противном случае.

CloneGroupId -> (строка)

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

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

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

CopyTagsToSnapshot -> (булево)

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

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, для которых этот кластер баз данных настроен на экспорт в CloudWatch Logs. Допустимые типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Публикация журналов Neptune в Amazon CloudWatch Logs.

(строка)

PendingModifiedValues -> (структура)

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

PendingCloudwatchLogsExports -> (структура)

Эта PendingCloudwatchLogsExports структура указывает ожидаемые изменения, в отношении которых включены и отключены журналы CloudWatch.

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера баз данных.

IAMDatabaseAuthenticationEnabled -> (булево)

Значение, указывающее, включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных.

EngineVersion -> (строка)

Версия движка базы данных.

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

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

StorageType -> (строка)

Ожидаемое изменение типа хранилища для кластера баз данных. Допустимые значения:

  • **standard ** – ( по умолчанию ) Настраивает экономичное хранилище баз данных для приложений с умеренным или небольшим использованием операций ввода-вывода.
  • **iopt1 ** – Включает хранилище с оптимизированным вводом-выводом, разработанное для удовлетворения потребностей ресурсоемких графических рабочих нагрузок, которые требуют предсказуемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Хранилище Neptune с оптимизированным вводом-выводом доступно только начиная с версии движка 1.3.0.0.

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

Размер выделенного хранилища в гигабайтах (GiB) для движков баз данных. Для Neptune значение AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера баз данных Neptune не фиксирован, а автоматически корректируется по мере необходимости.

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

Значение Provisioned IOPS (операций ввода-вывода в секунду). Этот параметр применяется только к кластерам баз данных Multi-AZ.

DeletionProtection -> (булево)

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

CrossAccountClone -> (булево)

Если установлено значение true , кластер баз данных может быть клонирован между учетными записями.

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

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

ServerlessV2ScalingConfiguration -> (структура)

Отображает конфигурацию масштабирования кластера базы данных Neptune Serverless.

Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в руководстве пользователя Amazon Neptune.

MinCapacity -> (double)

Минимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указывать значения NCU с шагом 0,5, например, 8, 8,5, 9 и т. д.

MaxCapacity -> (double)

Максимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указывать значения NCU с шагом 0,5, например, 40, 40,5, 41 и т. д.

GlobalClusterIdentifier -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

Следующее время, когда вы сможете изменить настройки кластера базы данных для использования типа хранилища iopt1.

StorageType -> (string)

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

Допустимые значения:

  • **standard ** – (по умолчанию) Обеспечивает экономичное хранилище базы данных для приложений с умеренным или небольшим использованием ввода-вывода.
  • **iopt1 ** – Включает оптимизированное хранилище ввода-вывода, предназначенное для удовлетворения потребностей интенсивно использующих ввод-вывод графических рабочих нагрузок, требующих предсказуемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Хранилище Neptune с оптимизацией ввода-вывода доступно только начиная с версии движка 1.3.0.0.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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