customer-gateway-available
Описание
Ожидание, пока JMESPath запрос CustomerGateways[].State вернёт значение available для всех элементов при опросе с помощью describe-customer-gateways. Будет производиться опрос каждые 15 секунд до тех пор, пока не будет достигнуто успешное состояние. Код возврата 255 будет выведен после 40 неудачных проверок.
См. также: Документация API AWS
Синтаксис
customer-gateway-available
[--customer-gateway-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--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]
Параметры
--customer-gateway-ids (список)
Один или несколько идентификаторов шлюзов клиента.
По умолчанию: описывает все ваши шлюзы клиента.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Один или несколько фильтров.
-
bgp-asn- Автономный номер системы Border Gateway Protocol (BGP) шлюза клиента (ASN). -
customer-gateway-id- Идентификатор шлюза клиента. -
ip-address- IP-адрес внешнего интерфейса устройства шлюза клиента. -
state- Состояние шлюза клиента (pending|available|deleting|deleted). -
type- Тип шлюза клиента. В настоящее время поддерживается только типipsec.1. -
tag:<ключ> - Комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerдля имени фильтра иTeamAдля значения фильтра. -
tag-key- Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определенным ключом, независимо от значения тега.
(структура)
Пара ключ-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, фильтры объединяются с помощью AND , и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.
Дополнительную информацию можно найти в разделе Список и фильтрация с помощью командной строки и API в руководстве пользователя Amazon EC2.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR , и запрос возвращает все результаты, которые соответствуют любому из указанных значений.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--dry-run | --no-dry-run (логическое значение)
DryRunOperation. В противном случае — UnauthorizedOperation.--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
- 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 (логическое значение)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода командной строки.
Примеры
Примечание
Чтобы использовать следующие примеры, вы должны установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.
За исключением случаев, прямо указанных, все примеры используют правила цитирования, похожие на правила цитирования в Unix-подобных системах. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы дождаться готовности шлюза клиента
Следующий wait customer-gateway-available пример приостанавливает и возобновляет выполнение только после подтверждения того, что указанный шлюз клиента готов. Он не выводит ничего.
aws ec2 wait customer-gateway-available \
--customer-gateway-ids cgw-1234567890abcdef0
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.