Spec-Zone.ru › AWS CLI v2

[ aws . elasticbeanstalk ]

terminate-environment

Описание

Завершает указанную среду.

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

Синтаксис

  terminate-environment
[--environment-id <value>]
[--environment-name <value>]
[--terminate-resources | --no-terminate-resources]
[--force-terminate | --no-force-terminate]
[--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]

Параметры

--environment-id (строка)

Идентификатор среды, которую требуется завершить.

Условие: Вы должны указать либо этот параметр, либо EnvironmentName, либо оба. Если вы не укажете ни один из них, AWS Elastic Beanstalk вернёт ошибку MissingRequiredParameter.

--environment-name (строка)

Имя среды, которую требуется завершить.

Условие: Вы должны указать либо этот параметр, либо EnvironmentId, либо оба. Если вы не укажете ни один из них, AWS Elastic Beanstalk вернёт ошибку MissingRequiredParameter.

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

Указывает, следует ли завершать связанные ресурсы AWS при завершении среды:

  • true: Указанная среда, а также связанные ресурсы AWS, такие как группа Auto Scaling и LoadBalancer, завершаются.
  • false: Управление ресурсами AWS Elastic Beanstalk удаляется из среды, но ресурсы AWS продолжают работать.

Для получения дополнительной информации см. руководство пользователя AWS Elastic Beanstalk.

Значение по умолчанию: true

Допустимые значения: true | false

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

Завершает целевую среду, даже если другая среда в той же группе зависит от неё.

--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.

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

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

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

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

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

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

Для завершения среды

Следующая команда завершает среду Elastic Beanstalk с именем my-env:

aws elasticbeanstalk terminate-environment --environment-name my-env

Вывод:

{
    "ApplicationName": "my-app",
    "EnvironmentName": "my-env",
    "Status": "Terminating",
    "EnvironmentId": "e-fh2eravpns",
    "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com",
    "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
    "CNAME": "my-env.elasticbeanstalk.com",
    "Health": "Grey",
    "AbortableOperationInProgress": false,
    "Tier": {
        "Version": " ",
        "Type": "Standard",
        "Name": "WebServer"
    },
    "DateUpdated": "2015-08-12T19:05:54.744Z",
    "DateCreated": "2015-08-12T18:52:53.622Z"
}

Вывод

ИмяОкружения -> (строка)

Название этой среды.

ИдентификаторОкружения -> (строка)

Идентификатор этой среды.

ИмяПриложения -> (строка)

Имя приложения, связанного с этой средой.

МеткаВерсии -> (строка)

Версия приложения, развернутая в этой среде.

ИмяСтекРешения -> (строка)

Имя SolutionStack, развернутого вместе с этой средой.

ArnПлатформы -> (строка)

ARN версии платформы.

ИмяШаблона -> (строка)

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

Описание -> (строка)

Описание этой среды.

URLКонечнойТочки -> (строка)

Для сред с балансировкой нагрузки и автоматическим масштабированием — URL балансировщика нагрузки. Для сред с одним экземпляром — IP-адрес экземпляра.

CNAME -> (строка)

URL для CNAME этой среды.

ДатаСоздание -> (меткаВремени)

Дата создания этой среды.

ДатаОбновления -> (меткаВремени)

Дата последнего изменения этой среды.

Статус -> (строка)

Текущий операционный статус среды:

  • Launching : Среда находится в процессе первоначального развертывания.
  • Updating : Среда находится в процессе обновления параметров конфигурации или версии приложения.
  • Ready : Среда доступна для выполнения действий, таких как обновление или завершение.
  • Terminating : Среда находится в процессе завершения работы.
  • Terminated : Среда не работает.

ЗавершеннаяОперация -> (логическое значение)

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

true: Обновление выполняется.

false: Обновлений в данный момент нет.

Состояние -> (строка)

Описывает состояние работоспособности среды. AWS Elastic Beanstalk указывает уровни сбоев для рабочей среды:

  • Red : Указывает, что среда не отвечает. Происходит, когда происходит три или более последовательных сбоя в среде.
  • Yellow : Указывает, что что-то не так. Происходит, когда происходит два последовательных сбоя в среде.
  • Green : Указывает, что среда работоспособна и полностью функциональна.
  • Grey : Стандартное состояние работоспособности для новой среды. Среда не полностью запущена, проверки работоспособности не начались или проверки работоспособности приостановлены во время запроса UpdateEnvironment или RestartEnvironment.

По умолчанию: Grey

СтатусРаботоспособности -> (строка)

Возвращает состояние работоспособности приложения, работающего в вашей среде. Для получения дополнительной информации см. Цвета и состояния работоспособности.

Ресурсы -> (структура)

Описание ресурсов AWS, используемых этой средой.

БалансировщикНагрузки -> (структура)

Описывает балансировщик нагрузки.

ИмяБалансировщикаНагрузки -> (строка)

Название балансировщика нагрузки.

Домен -> (строка)

Имя домена балансировщика нагрузки.

Слушатели -> (список)

Список слушателей, используемых балансировщиком нагрузки.

(структура)

Описывает свойства слушателя для балансировщика нагрузки.

Протокол -> (строка)

Протокол, используемый слушателем.

Порт -> (целое число)

Порт, используемый слушателем.

Уровень -> (структура)

Описывает текущий уровень этой среды.

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

Название уровня этой среды.

Допустимые значения:

  • Для уровня веб-сервера — WebServer
  • Для уровня рабочих процессов — Worker

Тип -> (строка)

Тип этого уровня среды.

Допустимые значения:

  • Для уровня веб-сервера — Standard
  • Для уровня рабочих процессов — SQS/HTTP

Версия -> (строка)

Версия этого уровня среды. Если вы не задаете значение, Elastic Beanstalk использует последнюю совместимую версию уровня рабочих процессов.

Примечание

Этот элемент устарел. Любая заданная вами конкретная версия может стать устаревшей. Рекомендуется оставить его без указания.

СсылкиНаОкружения -> (список)

Список ссылок на другие среды в той же группе.

(структура)

Ссылка на другую среду, определенную в манифесте среды. Ссылки предоставляют информацию о подключении в системных свойствах, которые могут использоваться для подключения к другой среде в той же группе. См. Манифест среды (env.yaml) для получения подробной информации.

ИмяСсылки -> (строка)

Название ссылки.

ИмяОкружения -> (строка)

Имя связанной среды (зависимости).

ArnОкружения -> (строка)

Amazon Resource Name (ARN) среды, который можно использовать в других запросах API, требующих ARN.

РольОпераций -> (строка)

Amazon Resource Name (ARN) роли операций среды. Для получения дополнительной информации см. Роли операций в Руководстве разработчика AWS Elastic Beanstalk.

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

Spec-Zone.ru

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