Spec-Zone.ru › AWS CLI v2

[ aws . synthetics ]

delete-canary

Описание

Постоянно удаляет указанную канну.

Если поле ProvisionedResourceCleanup канны установлено в значение AUTOMATIC или вы указываете DeleteLambda в этой операции как true, CloudWatch Synthetics также удаляет Lambda-функции и слои, которые используются канной.

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

  • Сигнализаторы CloudWatch, созданные для этой канны. Названия этих сигнализаторов имеют вид ``Synthetics-Alarm-первые-198-символов-имени-канны -id-канны -номер-сигнализатора ``
  • Объекты и ведра Amazon S3, такие как местоположение артефакта канны.
  • IAM-роли, созданные для канны. Если они были созданы в консоли, эти роли имеют имя ``role/service-role/CloudWatchSyntheticsRole-Первые-21-символ-имени-канны ``
  • Группы логов CloudWatch Logs, созданные для канны. Эти группы логов имеют имя ``/aws/lambda/cwsyn-Первые-21-символ-имени-канны ``

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

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

Синтаксис

  delete-canary
--name <value>
[--delete-lambda | --no-delete-lambda]
[--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]

Параметры

--name (строка)

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

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

Указывает, нужно ли также удалить Lambda-функции и слои, используемые этой канной. По умолчанию значение равно false.

Ваше значение для этого параметра используется только в том случае, если у канны нет AUTOMATIC для поля ProvisionedResourceCleanup. Если это поле установлено в значение AUTOMATIC, Lambda-функции и слои будут удалены при удалении этой канны.

Тип: Логическое значение

--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
  • текст
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительные сведения см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Дополнительные сведения см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.

Для постоянного удаления канны

В следующем delete-canary примере удаляется канна с именем demo_canary.

aws synthetics delete-canary \
    --name demo_canary

Эта команда не производит вывода.

Дополнительные сведения см. в разделе Синтетическая мониторинг (канны) в руководстве пользователя Amazon CloudWatch.

Вывод

Нет

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

Spec-Zone.ru

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