Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

update-recovery-point-index-settings

Описание

Эта операция обновляет настройки индекса восстановления точки.

Обязательно укажите: BackupVaultName, RecoveryPointArn и IAMRoleArn

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

Синтаксис

  update-recovery-point-index-settings
--backup-vault-name <value>
--recovery-point-arn <value>
[--iam-role-arn <value>]
--index <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]

Параметры

--backup-vault-name (строка)

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

Допустимые символы: строчные буквы, цифры и дефисы.

--recovery-point-arn (строка)

Уникальный ARN, идентифицирующий точку восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

--iam-role-arn (строка)

Указывает ARN роли IAM, используемой для этой операции.

Например, arn:aws:iam::123456789012:role/S3Access

--index (строка)

Индекс может иметь одно из двух возможных значений: ENABLED или DISABLED.

Чтобы создать индекс резервной копии для подходящей точки восстановления ACTIVE, которая еще не имеет индекса резервной копии, установите значение в ENABLED.

Чтобы удалить индекс резервной копии, установите значение в DISABLED.

Возможные значения:

  • ENABLED
  • DISABLED

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить страницу cli для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

BackupVaultName -> (строка)

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

RecoveryPointArn -> (строка)

Уникальный ARN, идентифицирующий точку восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

IndexStatus -> (строка)

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

Статусы: PENDING | ACTIVE | FAILED | DELETING

Точку восстановления с индексом, имеющим статус ACTIVE, можно включить в поиск.

Index -> (строка)

Индекс может иметь одно из двух возможных значений: ENABLED или DISABLED.

Значение ENABLED означает, что для подходящей точки восстановления ACTIVE был создан индекс резервной копии.

Значение DISABLED означает, что индекс резервной копии был удалён.

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

Spec-Zone.ru

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