update-environment
Описание
Обновить среду.
Если среда связана с подключением к учётной записи среды, не обновляйте и не включайте параметр protonServiceRoleArn и provisioningRepository для обновления или подключения к подключению к учётной записи среды.
Вы можете обновить только на новое подключение к учётной записи среды, если это подключение было создано в той же учётной записи среды, что и текущее подключение к учётной записи среды. Подключение к учётной записи также должно быть связано с текущей средой.
Если среда не связана с подключением к учётной записи среды, не обновляйте и не включайте параметр environmentAccountConnectionId. Вы не можете обновить или подключить среду к подключению к учётной записи среды, если она не уже связана с подключением к среде.
Вы можете обновить либо параметр environmentAccountConnectionId или protonServiceRoleArn и его значение. Нельзя обновлять оба.
Если среда была настроена для управляемого Amazon Web Services развертывания, опустите параметр provisioningRepository.
Если среда была настроена для самообслуживания, укажите параметр provisioningRepository и опустите параметры protonServiceRoleArn и environmentAccountConnectionId.
Дополнительную информацию см. в разделе "Среды и методы развертывания" в Руководстве пользователя Proton.
Существует четыре режима обновления среды. Поле deploymentType определяет режим.
NONEВ этом режиме развертывание не выполняется. Обновляются только запрошенные параметры метаданных.
CURRENT_VERSIONВ этом режиме среда развертывается и обновляется с помощью нового спецификатора, который вы предоставляете. Обновляются только запрошенные параметры. Не включайте параметры версии основной или дополнительной версии, когда используете этот deployment-type.
MINOR_VERSIONВ этом режиме среда развертывается и обновляется с использованием опубликованной рекомендуемой (последней) дополнительной версии текущей основной версии по умолчанию. Вы также можете указать другую дополнительную версию текущей основной версии.
MAJOR_VERSIONВ этом режиме среда развертывается и обновляется с использованием опубликованной рекомендуемой (последней) основной и дополнительной версии текущей шаблона по умолчанию. Вы также можете указать другую основную версию, которая выше текущей основной версии, и дополнительную версию (необязательно).
См. также: Документация по API AWS
Синопсис
update-environment
[--codebuild-role-arn <value>]
[--component-role-arn <value>]
--deployment-type <value>
[--description <value>]
[--environment-account-connection-id <value>]
--name <value>
[--proton-service-role-arn <value>]
[--provisioning-repository <value>]
[--spec <value>]
[--template-major-version <value>]
[--template-minor-version <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 (строка)
--component-role-arn (строка)
Amazon Resource Name (ARN) роли службы IAM, которую Proton использует при развёртывании непосредственно определённых компонентов в этой среде. Она определяет область инфраструктуры, которую может развёртывать компонент.
Для среды необходимо подключение componentRoleArn, чтобы позволить непосредственно определённым компонентам быть связанными со средой.
Дополнительную информацию о компонентах см. в разделе "Компоненты Proton" в Руководстве пользователя Proton.
--deployment-type (строка)
Существует четыре режима обновления среды. Поле deploymentType определяет режим.
NONEВ этом режиме развертывание не выполняется. Обновляются только запрошенные параметры метаданных.
CURRENT_VERSIONВ этом режиме среда развертывается и обновляется с помощью нового спецификатора, который вы предоставляете. Обновляются только запрошенные параметры. Не включайте параметры основной или дополнительной версии, когда используете этот deployment-type.
MINOR_VERSIONВ этом режиме среда развертывается и обновляется с использованием опубликованной рекомендуемой (последней) дополнительной версии текущей основной версии по умолчанию. Вы также можете указать другую дополнительную версию текущей основной версии.
MAJOR_VERSIONВ этом режиме среда развертывается и обновляется с использованием опубликованной рекомендуемой (последней) основной и дополнительной версии текущей шаблона по умолчанию. Вы также можете указать другую основную версию, которая выше текущей основной версии, и дополнительную версию (необязательно).
Возможные значения:
NONECURRENT_VERSIONMINOR_VERSIONMAJOR_VERSION
--description (строка)
--environment-account-connection-id (строка)
Идентификатор подключения к учётной записи среды.
Вы можете обновить только на новое подключение к учётной записи среды, если оно было создано в той же учётной записи среды, что и текущее подключение к учётной записи среды, и связано с текущей средой.
--name (строка)
--proton-service-role-arn (строка)
--provisioning-repository (структура)
Связанный репозиторий, который вы используете для размещения ваших обработанных шаблонов инфраструктуры для самообслуживания. Связанный репозиторий — это репозиторий, который был зарегистрирован в Proton. Дополнительную информацию см. в разделе CreateRepository.
branch -> (строка)
name -> (строка)
provider -> (строка)
Сокращенная синтаксис:
branch=string,name=string,provider=string
Синтаксис JSON:
{
"branch": "string",
"name": "string",
"provider": "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
}
--spec (строка)
--template-major-version (строка)
--template-minor-version (строка)
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
environment -> (структура)
Данные о деталях среды, возвращаемые Proton.
arn -> (строка)
codebuildRoleArn -> (строка)
componentRoleArn -> (строка)
Amazon Resource Name (ARN) роли службы IAM, которую Proton использует при непосредственном развертывании компонентов в этой среде. Она определяет область инфраструктуры, которую может развернуть компонент.
Для корректного объединения непосредственно определенных компонентов со средой необходим componentRoleArn.
Дополнительную информацию о компонентах см. в руководстве пользователя Proton в разделе «Компоненты Proton».
createdAt -> (отметка времени)
deploymentStatus -> (строка)
deploymentStatusMessage -> (строка)
description -> (строка)
environmentAccountConnectionId -> (строка)
environmentAccountId -> (строка)
lastAttemptedDeploymentId -> (строка)
lastDeploymentAttemptedAt -> (отметка времени)
lastDeploymentSucceededAt -> (отметка времени)
lastSucceededDeploymentId -> (строка)
name -> (строка)
protonServiceRoleArn -> (строка)
provisioning -> (строка)
provisioningRepository -> (структура)
Связанный репозиторий, в котором хранятся шаблоны инфраструктуры для самостоятельного развертывания. Связанный репозиторий — это репозиторий, зарегистрированный в Proton. Дополнительную информацию см. в разделе CreateRepository.
arn -> (строка)
branch -> (строка)
name -> (строка)
provider -> (строка)
spec -> (строка)
templateMajorVersion -> (строка)
templateMinorVersion -> (строка)
templateName -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.