Spec-Zone.ru › AWS CLI v2

[ aws . elasticbeanstalk ]

обновить-среду

Описание

Обновляет описание среды, развёртывает новую версию приложения, обновляет параметры конфигурации до совершенно новой шаблона конфигурации или обновляет выбранные значения параметров конфигурации в рабочей среде.

Попытка обновить и выпуск, и конфигурацию запрещена, и AWS Elastic Beanstalk возвращает ошибку InvalidParameterCombination.

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

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

Синтаксис

  update-environment
[--application-name <value>]
[--environment-id <value>]
[--environment-name <value>]
[--group-name <value>]
[--description <value>]
[--tier <value>]
[--version-label <value>]
[--template-name <value>]
[--solution-stack-name <value>]
[--platform-arn <value>]
[--option-settings <value>]
[--options-to-remove <value>]
[--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]

Параметры

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

Имя приложения, с которым связана среда.

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

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

Если среда с таким идентификатором не найдена, AWS Elastic Beanstalk возвращает ошибку InvalidParameterValue.

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

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

Имя среды, которую нужно обновить. Если среда с таким именем не найдена, AWS Elastic Beanstalk вернёт ошибку InvalidParameterValue.

Условие: вы должны указать либо это, либо идентификатор среды, либо оба значения. Если вы не укажете ни то, ни другое, AWS Elastic Beanstalk вернёт ошибку MissingRequiredParameter.

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

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

--description (строка)

Если этот параметр указан, AWS Elastic Beanstalk обновляет описание этой среды.

--tier (структура)

Это указывает уровень, который нужно использовать для обновления среды.

Условие: в настоящее время, если вы изменяете версию, имя или тип уровня, AWS Elastic Beanstalk возвращает ошибку InvalidParameterValue.

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

Имя уровня этой среды.

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

  • Для уровня веб-сервера – WebServer
  • Для уровня задач – Worker

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

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

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

  • Для уровня веб-сервера – Standard
  • Для уровня задач – SQS/HTTP

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

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

Примечание

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

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

Name=string,Type=string,Version=string

Синтаксис JSON:

{
  "Name": "string",
  "Type": "string",
  "Version": "string"
}

--version-label (строка)

Если этот параметр указан, AWS Elastic Beanstalk развёртывает указанную версию приложения в среде. Если такая версия приложения не найдена, возвращает ошибку InvalidParameterValue.

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

Если этот параметр указан, AWS Elastic Beanstalk развёртывает этот шаблон конфигурации в среде. Если такой шаблон конфигурации не найден, AWS Elastic Beanstalk возвращает ошибку InvalidParameterValue.

--solution-stack-name (строка)

Это указывает версию платформы, на которой будет работать среда после её обновления.

--platform-arn (строка)

ARN платформы, если используется.

--option-settings (список)

Если указан, AWS Elastic Beanstalk обновляет набор конфигураций, связанный с рабочей средой, и устанавливает указанные параметры конфигурации в запрошенное значение.

(структура)

Определение отдельного параметра конфигурации вместе с его текущим значением. Список возможных имен пространств имён и значений параметров см. в разделе Значения параметров в Руководстве разработчика AWS Elastic Beanstalk.

ResourceName -> (строка)

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

Namespace -> (строка)

Уникальное имя пространства имён, которое определяет связанный с ним ресурс AWS.

OptionName -> (строка)

Имя параметра конфигурации.

Value -> (строка)

Текущее значение параметра конфигурации.

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

ResourceName=string,Namespace=string,OptionName=string,Value=string ...

Синтаксис JSON:

[
  {
    "ResourceName": "string",
    "Namespace": "string",
    "OptionName": "string",
    "Value": "string"
  }
  ...
]

--options-to-remove (список)

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

(структура)

Определение отдельного параметра конфигурации.

ResourceName -> (строка)

Уникальное имя ресурса для параметра конфигурации масштабирования во времени.

Namespace -> (строка)

Уникальное имя пространства имён, которое определяет связанный с ним ресурс AWS.

OptionName -> (строка)

Имя параметра конфигурации.

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

ResourceName=string,Namespace=string,OptionName=string ...

Синтаксис JSON:

[
  {
    "ResourceName": "string",
    "Namespace": "string",
    "OptionName": "string"
  }
  ...
]

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

Для обновления среды до новой версии

Следующая команда обновляет среду с именем «my-env» до версии «v2» приложения, к которому она принадлежит:

aws elasticbeanstalk update-environment --environment-name my-env --version-label v2

Для выполнения этой команды среда «my-env» должна уже существовать и принадлежать приложению, имеющему действительную версию приложения с меткой «v2».

Вывод:

{
  "ApplicationName": "my-app",
  "EnvironmentName": "my-env",
  "VersionLabel": "v2",
  "Status": "Updating",
  "EnvironmentId": "e-szqipays4h",
  "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com",
  "SolutionStackName": "64bit Amazon Linux running Tomcat 7",
  "CNAME": "my-env.elasticbeanstalk.com",
  "Health": "Grey",
  "Tier": {
      "Version": " ",
      "Type": "Standard",
      "Name": "WebServer"
  },
  "DateUpdated": "2015-02-03T23:12:29.119Z",
  "DateCreated": "2015-02-03T23:04:54.453Z"
}

Для установки переменной среды

Следующая команда устанавливает значение переменной «PARAM1» в среде «my-env» на «ParamValue»:

aws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:application:environment,OptionName=PARAM1,Value=ParamValue

Параметр option-settings принимает пространство имён помимо имени и значения переменной. Elastic Beanstalk поддерживает несколько пространств имён для параметров помимо переменных среды.

Для настройки параметров из файла

Следующая команда настраивает несколько параметров в пространстве имён aws:elb:loadbalancer из файла:

aws elasticbeanstalk update-environment --environment-name my-env --option-settings file://options.json

options.json представляет собой объект JSON, определяющий несколько настроек:

[
  {
    "Namespace": "aws:elb:healthcheck",
    "OptionName": "Interval",
    "Value": "15"
  },
  {
    "Namespace": "aws:elb:healthcheck",
    "OptionName": "Timeout",
    "Value": "8"
  },
  {
    "Namespace": "aws:elb:healthcheck",
    "OptionName": "HealthyThreshold",
    "Value": "2"
  },
  {
    "Namespace": "aws:elb:healthcheck",
    "OptionName": "UnhealthyThreshold",
    "Value": "3"
  }
]

Вывод:

{
    "ApplicationName": "my-app",
    "EnvironmentName": "my-env",
    "VersionLabel": "7f58-stage-150812_025409",
    "Status": "Updating",
    "EnvironmentId": "e-wtp2rpqsej",
    "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.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": true,
    "Tier": {
        "Version": " ",
        "Type": "Standard",
        "Name": "WebServer"
    },
    "DateUpdated": "2015-08-12T18:15:23.804Z",
    "DateCreated": "2015-08-07T20:48:49.599Z"
}

Дополнительную информацию о пространствах имён и поддерживаемых параметрах см. в руководстве разработчика AWS Elastic Beanstalk в разделе «Значения параметров».

Вывод

EnvironmentName -> (строка)

Имя этой среды.

EnvironmentId -> (строка)

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

ApplicationName -> (строка)

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

VersionLabel -> (строка)

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

SolutionStackName -> (строка)

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

PlatformArn -> (строка)

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

TemplateName -> (строка)

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

Description -> (строка)

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

EndpointURL -> (строка)

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

CNAME -> (строка)

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

DateCreated -> (метка времени)

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

DateUpdated -> (метка времени)

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

Status -> (строка)

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

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

AbortableOperationInProgress -> (булево)

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

true:: Обновление в процессе.

false:: В настоящий момент обновлений нет.

Health -> (строка)

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

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

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

HealthStatus -> (строка)

Возвращает состояние работоспособности приложения, работающего в вашей среде. Подробнее см. в разделе «Цвета и статусы работоспособности».

Resources -> (структура)

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

LoadBalancer -> (структура)

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

LoadBalancerName -> (строка)

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

Domain -> (строка)

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

Listeners -> (список)

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

(структура)

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

Protocol -> (строка)

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

Port -> (целое число)

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

Tier -> (структура)

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

Name -> (строка)

Имя уровня этой среды.

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

  • Для уровня веб-сервера – WebServer
  • Для рабочего уровня – Worker

Type -> (строка)

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

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

  • Для уровня веб-сервера – Standard
  • Для рабочего уровня – SQS/HTTP

Version -> (строка)

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

Примечание

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

EnvironmentLinks -> (список)

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

(структура)

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

LinkName -> (строка)

Имя ссылки.

EnvironmentName -> (строка)

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

EnvironmentArn -> (строка)

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

OperationsRole -> (строка)

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

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

Spec-Zone.ru

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