create-environment

Описание

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

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

Синтаксис

  create-environment
--application-name <value>
[--environment-name <value>]
[--group-name <value>]
[--description <value>]
[--cname-prefix <value>]
[--tier <value>]
[--tags <value>]
[--version-label <value>]
[--template-name <value>]
[--solution-stack-name <value>]
[--platform-arn <value>]
[--option-settings <value>]
[--options-to-remove <value>]
[--operations-role <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-name (строка)

Уникальное имя для среды.

Ограничение: длина должна быть от 4 до 40 символов. Имя может содержать только буквы, цифры и дефисы. Не должно начинаться или заканчиваться дефисом. Это имя должно быть уникальным в регионе в вашем аккаунте. Если указанное имя уже существует в регионе, Elastic Beanstalk возвращает ошибку InvalidParameterValue.

Если вы не указываете параметр CNAMEPrefix, имя среды становится частью CNAME и, следовательно, частью видимого URL-адреса вашего приложения.

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

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

--description (строка)

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

--cname-prefix (строка)

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

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

Указывает уровень для создания этой среды. Уровень среды, который вы выбираете, определяет, предоставляет ли Elastic Beanstalk ресурсы для поддержки веб-приложения, обрабатывающего запросы HTTP(S), или веб-приложения, обрабатывающего задачи обработки в фоновом режиме.

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

Name=string,Type=string,Version=string

Синтаксис JSON:

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

--tags (список)

Указывает теги, применяемые к ресурсам в среде.

(структура)

Описывает тег, примененный к ресурсу в среде.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

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

По умолчанию: если не указано, Elastic Beanstalk пытается развернуть демонстрационное приложение.

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

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

Примечание

Если вы указываете TemplateName, то не указывайте SolutionStackName.

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

Имя стека решений Elastic Beanstalk (версия платформы), которое нужно использовать со средой. При указании Elastic Beanstalk устанавливает значения конфигурации по умолчанию, связанные с указанным стеком решений. Список текущих стеков решений см. в руководстве AWS Elastic Beanstalk Platforms.

Примечание

Если вы указываете SolutionStackName, не указывайте PlatformArn или TemplateName.

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

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

Примечание

Если вы указываете PlatformArn, не указывайте SolutionStackName.

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

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

(структура)

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

ResourceName -> (строка)

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

Namespace -> (строка)

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

OptionName -> (строка)

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

Значение -> (строка)

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

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

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"
  }
  ...
]

--operations-role (строка)

Amazon Resource Name (ARN) существующей роли IAM, которая должна использоваться в качестве роли операций среды. Если указано, Elastic Beanstalk использует роль операций для разрешений на подключенные сервисы во время этого вызова и последующих вызовов, выполняемых с этой средой. Для указания роли операций необходимо иметь разрешение iam:PassRole для роли. Дополнительную информацию см. в разделе «Роли операций» в Руководстве разработчика AWS Elastic Beanstalk.

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

on
off
auto

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

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

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

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

Для создания новой среды для приложения

Следующая команда создает новую среду для версии «v1» приложения Java с именем «my-app»:

aws elasticbeanstalk create-environment --application-name my-app --environment-name my-env --cname-prefix my-app --version-label v1 --solution-stack-name "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"

Вывод:

{
  "ApplicationName": "my-app",
  "EnvironmentName": "my-env",
  "VersionLabel": "v1",
  "Status": "Launching",
  "EnvironmentId": "e-izqpassy4h",
  "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
  "CNAME": "my-app.elasticbeanstalk.com",
  "Health": "Grey",
  "Tier": {
      "Type": "Standard",
      "Name": "WebServer",
      "Version": " "
  },
  "DateUpdated": "2015-02-03T23:04:54.479Z",
  "DateCreated": "2015-02-03T23:04:54.479Z"
}

v1 — метка версии приложения, предварительно загруженная с помощью create-application-version.

Для указания JSON-файла для определения параметров конфигурации среды

Следующая create-environment команда указывает, что для переопределения значений, полученных из стека решений или шаблона конфигурации, должен использоваться JSON-файл с именем myoptions.json:

aws elasticbeanstalk create-environment --environment-name sample-env --application-name sampleapp --option-settings file://myoptions.json

myoptions.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"
  }
]

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

Вывод

EnvironmentName -> (строка)

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

EnvironmentId -> (строка)

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

ApplicationName -> (строка)

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

VersionLabel -> (строка)

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

SolutionStackName -> (строка)

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

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.