db-cluster-snapshot-available

Описание

Ожидание, пока JMESPath-запрос DBClusterSnapshots[].Status вернёт значение «available» для всех элементов при опросе с помощью describe-db-cluster-snapshots. Будет выполняться опрос каждые 30 секунд до достижения успешного состояния. Код возврата 255 будет выдан после 60 неудачных проверок.

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

db-cluster-snapshot-available — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запросов: DBClusterSnapshots

Синтаксис

  db-cluster-snapshot-available
[--db-cluster-identifier <value>]
[--db-cluster-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--db-cluster-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-cluster-identifier (строка)

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

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

Если указан, должен соответствовать идентификатору существующего DBCluster.

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

Уникальный идентификатор снимка кластера баз данных для описания. Этот параметр нельзя использовать совместно с параметром DBClusterIdentifier. Это значение хранится как строка в нижнем регистре.

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

Если указан, должен соответствовать идентификатору существующего DBClusterSnapshot.
Если этот идентификатор относится к автоматическому снимку, необходимо также указать параметр SnapshotType.

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

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

automated — Возвращает все снимки кластеров баз данных, автоматически созданные Amazon RDS для моей учетной записи Amazon Web Services.
manual — Возвращает все снимки кластеров баз данных, созданные моей учетной записью Amazon Web Services.
shared — Возвращает все ручные снимки кластеров баз данных, которые были предоставлены для доступа моей учетной записи Amazon Web Services.
public — Возвращает все снимки кластеров баз данных, помеченные как публичные.

Если вы не указываете значение SnapshotType, возвращаются как автоматические, так и ручные снимки кластеров баз данных. Вы можете включить в эти результаты общие снимки кластеров баз данных, включив параметр IncludeShared. Вы можете включить в эти результаты публичные снимки кластеров баз данных, включив параметр IncludePublic.

Параметры IncludeShared и IncludePublic не применяются к значениям SnapshotType типам manual или automated. Параметр IncludePublic не применяется, когда SnapshotType задано как shared. Параметр IncludeShared не применяется, когда SnapshotType задано как public.

--filters (список)

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

Поддерживаемые фильтры:

db-cluster-id — Принимает идентификаторы кластеров баз данных и Amazon Resource Names (ARN) кластеров баз данных.
db-cluster-snapshot-id — Принимает идентификаторы снимков кластеров баз данных.
snapshot-type — Принимает типы снимков кластеров баз данных.
engine — Принимает имена СУБД.

(структура)

Пара имя-значение фильтра используется для возвращения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, например, по идентификаторам. Поддерживаемые фильтры операции describe документированы вместе с операцией describe.

Примечание

В настоящее время подстановка символов в фильтры не поддерживается.

Следующие действия могут быть отфильтрованы:

DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

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

Вы можете предоставить учетной записи Amazon Web Services разрешение на восстановление ручного снимка кластера баз данных из другой учетной записи Amazon Web Services с помощью API-действия ModifyDBClusterSnapshotAttribute.

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

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

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

--db-cluster-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 (логическое значение)

Включение отладки регистрации.

--endpoint-url (строка)

Переопределение URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

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

--output (строка)

Стиль форматирования выходных данных команды.

json
text
table
yaml
yaml-stream

--query (строка)

JMESPath-запрос для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

on
off
auto

--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-auto-prompt (логическое значение)

Автоматический запрос параметров CLI.

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

Отключение автоматического запроса параметров CLI.

Вывод

Нет