db-snapshot-available
Описание
Ожидание, пока JMESPath-запрос DBSnapshots[].Status вернёт значение «available» для всех элементов при опросе с помощью describe-db-snapshots. Будет выполняться опрос каждые 30 секунд до достижения успешного состояния. Выполнение завершится с кодом возврата 255 после 60 неудачных проверок.
См. также: Документацию AWS API.
db-snapshot-available — это постраничная операция. Для получения всего набора результатов может потребоваться несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query с постраничным ответом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBSnapshots
Синтаксис
db-snapshot-available
[--db-instance-identifier <value>]
[--db-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--dbi-resource-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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-instance-identifier (строка)
Идентификатор экземпляра БД для получения списка снимков БД. Этот параметр нечувствителен к регистру.
Ограничения:
- Если указан, должен соответствовать идентификатору существующего экземпляра БД.
--db-snapshot-identifier (строка)
Уникальный идентификатор снимка БД. Это значение хранится в нижнем регистре.
Ограничения:
- Если указан, должен соответствовать идентификатору существующего снимка БД.
- Если этот идентификатор относится к автоматическому снимку, параметр
SnapshotTypeтакже должен быть указан.
--snapshot-type (строка)
Тип снимков, которые должны быть возвращены. Вы можете указать одно из следующих значений:
-
automated— Возвращает все снимки БД, автоматически созданные Amazon RDS для вашей учетной записи AWS. -
manual— Возвращает все снимки БД, созданные вашей учетной записью AWS. -
shared— Возвращает все ручные снимки БД, которые были предоставлены вашей учетной записи AWS. -
public— Возвращает все снимки БД, помеченные как публичные. -
awsbackup— Возвращает снимки БД, управляемые службой Amazon Web Services Backup. Дополнительную информацию о службе Amazon Web Services Backup см. в руководстве разработчика ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ Типawsbackupне применяется к Aurora.
Если вы не указываете значение SnapshotType, возвращаются как автоматические, так и ручные снимки. По умолчанию общие и публичные снимки БД не включаются в возвращаемые результаты. Вы можете включить общие снимки в эти результаты, включив параметр IncludeShared. Вы можете включить публичные снимки в эти результаты, включив параметр IncludePublic.
Параметры IncludeShared и IncludePublic не применяются для значений SnapshotType manual или automated . Параметр IncludePublic не применяется, когда SnapshotType установлено в значение shared . Параметр IncludeShared не применяется, когда SnapshotType установлено в значение public .
--filters (список)
Фильтр, который определяет один или несколько снимков БД для описания.
Поддерживаемые фильтры:
-
db-instance-id— Принимает идентификаторы экземпляров БД и Amazon Resource Names (ARN) экземпляров БД. -
db-snapshot-id— Принимает идентификаторы снимков БД. -
dbi-resource-id— Принимает идентификаторы исходных экземпляров БД. -
snapshot-type— Принимает типы снимков БД. -
engine— Принимает названия типов баз данных.
(структура)
Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, например, идентификаторам. Фильтры, поддерживаемые операцией describe, документированы с операцией describe.
Примечание
В настоящее время подстановочные знаки в фильтрах не поддерживаются.Следующие действия могут быть отфильтрованы:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribeDBRecommendationsDescribeDBShardGroupsDescribePendingMaintenanceActions
Имя -> (строка)
Значения -> (список)
Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--include-shared | --no-include-shared (логическое значение)
Указывает, следует ли включать общие ручные снимки кластера БД из других учетных записей AWS, которые этой учетной записи AWS разрешено копировать или восстанавливать. По умолчанию эти снимки не включаются.
Вы можете предоставить учетной записи AWS разрешение на восстановление ручного снимка БД из другой учетной записи AWS, используя действие API ModifyDBSnapshotAttribute.
Это значение не применяется к RDS Custom.
--include-public | --no-include-public (логическое значение)
Указывает, следует ли включать ручные снимки кластера БД, которые являются общедоступными и могут быть скопированы или восстановлены любой учетной записью AWS. По умолчанию эти снимки не включаются.
Вы можете сделать ручной снимок БД общедоступным, используя API ModifyDBSnapshotAttribute.
Это значение не применяется к RDS Custom.
--dbi-resource-id (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные данные с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания места начала постраничного вывода. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращённых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервисных вызовов.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки API-запроса. При отсутствии значения или значении input выводит пример JSON-ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, при указании значения yaml-input выводит пример YAML-ввода, который может быть использован с --cli-input-yaml. При указании значения output, команда проверяет входные данные и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-каркас не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-каркасе.
Глобальные параметры
--debug (boolean)
Включить отладочную регистрацию.
--endpoint-url (string)
Переопределить стандартный URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки из конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить кли-паджер для вывода.
--cli-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.