Spec-Zone.ru › AWS CLI v2

[ aws . proton ]

create-environment

Описание

Развёртывание новой среды. Среда Proton создаётся из шаблона среды, который определяет инфраструктуру и ресурсы, которые могут быть объединены через службы.

Вы можете создавать среды с помощью следующих методов:
  • Управление развёртыванием через Amazon Web Services: Proton напрямую выполняет запросы для развёртывания ваших ресурсов.
  • Самостоятельное развёртывание: Proton делает запросы на ваш репозиторий для предоставления скомпилированных файлов инфраструктуры как кода (IaC), которые ваш движок IaC использует для развёртывания ресурсов.

Для получения дополнительной информации см. Среды и методы развёртывания в Руководстве пользователя Proton.

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

Синтаксис

  create-environment
[--codebuild-role-arn <value>]
[--component-role-arn <value>]
[--description <value>]
[--environment-account-connection-id <value>]
--name <value>
[--proton-service-role-arn <value>]
[--provisioning-repository <value>]
--spec <value>
[--tags <value>]
--template-major-version <value>
[--template-minor-version <value>]
--template-name <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]

Параметры

--codebuild-role-arn (строка)

Amazon Resource Name (ARN) роли службы IAM, которая позволяет Proton развёртывать инфраструктуру с использованием развёртывания на основе CodeBuild от вашего имени.

Чтобы использовать развёртывание на основе CodeBuild для среды или любого экземпляра службы, работающего в среде, укажите либо параметр environmentAccountConnectionId, либо codebuildRoleArn.

--component-role-arn (строка)

Amazon Resource Name (ARN) роли службы IAM, которую Proton использует при развёртывании компонентов, непосредственно определённых в данной среде. Она определяет сферу инфраструктуры, которую может развёртывать компонент.

Вы должны указать componentRoleArn, чтобы разрешить ассоциацию непосредственно определённых компонентов с данной средой.

Для получения дополнительной информации о компонентах см. Компоненты Proton в Руководстве пользователя Proton.

--description (строка)

Описание среды, которая создаётся и развёртывается.

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

Идентификатор подключения к учётной записи среды, который вы предоставляете, если развёртываете ресурсы инфраструктуры вашей среды в учётной записи среды. Дополнительные сведения см. в разделе Подключения к учётным записям среды в Руководстве пользователя Proton.

Для использования управления развёртыванием через Amazon Web Services для среды, укажите либо параметр environmentAccountConnectionId, либо protonServiceRoleArn и опустите параметр provisioningRepository.

--name (строка)

Имя среды.

--proton-service-role-arn (строка)

Amazon Resource Name (ARN) роли службы Proton, которая позволяет Proton делать вызовы к другим службам от вашего имени.

Чтобы использовать управление развёртыванием через Amazon Web Services для среды, укажите либо параметр environmentAccountConnectionId, либо protonServiceRoleArn и опустите параметр provisioningRepository.

--provisioning-repository (структура)

Связанный репозиторий, в котором хранятся ваши шаблоны инфраструктуры для самостоятельного развёртывания. Связанный репозиторий — это репозиторий, зарегистрированный в Proton. Дополнительные сведения см. в CreateRepository.

Чтобы использовать самостоятельное развёртывание для среды, укажите этот параметр и опустите параметры environmentAccountConnectionId и protonServiceRoleArn.

branch -> (строка)

Ветка репозитория.

name -> (строка)

Имя репозитория.

provider -> (строка)

Поставщик репозитория.

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

branch=string,name=string,provider=string

Синтаксис JSON:

{
  "branch": "string",
  "name": "string",
  "provider": "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
}

--spec (строка)

Строка в формате YAML, которая предоставляет входные данные, определённые в схеме файла пакета шаблона среды. Дополнительные сведения см. в разделе Среды в Руководстве пользователя Proton.

--tags (список)

Необязательный список элементов метаданных, которые можно ассоциировать со средой Proton. Тег — это пара «ключ-значение».

Дополнительные сведения см. в разделе Ресурсы и тегирование Proton в Руководстве пользователя Proton.

(структура)

Описание тега ресурса.

key -> (строка)

Ключ тега ресурса.

value -> (строка)

Значение тега ресурса.

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--template-major-version (строка)

Основная версия шаблона среды.

--template-minor-version (строка)

Дополнительная версия шаблона среды.

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

Имя шаблона среды. Дополнительные сведения см. в разделе Шаблоны сред в Руководстве пользователя Proton.

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

Вывод

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

Данные о среде, возвращаемые Proton.

arn -> (строка)

Amazon Resource Name (ARN) среды.

codebuildRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM, которая позволяет Proton создавать инфраструктуру с помощью CodeBuild-базируемого развертывания от вашего имени.

componentRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM, которую Proton использует при непосредственном развертывании компонентов в данной среде. Она определяет область инфраструктуры, которую компонент может развернуть.

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

Дополнительную информацию о компонентах см. в руководстве пользователя Proton (Proton components в Proton User Guide).

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

Время создания среды.

deploymentStatus -> (строка)

Статус развертывания среды.

deploymentStatusMessage -> (строка)

Сообщение о статусе развертывания среды.

description -> (строка)

Описание среды.

environmentAccountConnectionId -> (строка)

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

environmentAccountId -> (строка)

Идентификатор учетной записи среды, в которой развертываются ресурсы инфраструктуры среды.

lastAttemptedDeploymentId -> (строка)

Идентификатор последней попытки развертывания этой среды.

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

Время последней попытки развертывания среды.

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

Время последнего успешного развертывания среды.

lastSucceededDeploymentId -> (строка)

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

name -> (строка)

Имя среды.

protonServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы Proton, которая позволяет Proton выполнять вызовы к другим службам от вашего имени.

provisioning -> (строка)

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

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

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

arn -> (строка)

Amazon Resource Name (ARN) связанного репозитория.

branch -> (строка)

Ветка репозитория.

name -> (строка)

Название репозитория.

provider -> (строка)

Поставщик репозитория.

spec -> (строка)

Спецификация среды.

templateMajorVersion -> (строка)

Основная версия шаблона среды.

templateMinorVersion -> (строка)

Дополнительная версия шаблона среды.

templateName -> (строка)

Amazon Resource Name (ARN) шаблона среды.

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

Spec-Zone.ru

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