Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

update-branch

Описание

Обновляет ветку для приложения Amplify.

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

Синтаксис

  update-branch
--app-id <value>
--branch-name <value>
[--description <value>]
[--framework <value>]
[--stage <value>]
[--enable-notification | --no-enable-notification]
[--enable-auto-build | --no-enable-auto-build]
[--enable-skew-protection | --no-enable-skew-protection]
[--environment-variables <value>]
[--basic-auth-credentials <value>]
[--enable-basic-auth | --no-enable-basic-auth]
[--enable-performance-mode | --no-enable-performance-mode]
[--build-spec <value>]
[--ttl <value>]
[--display-name <value>]
[--enable-pull-request-preview | --no-enable-pull-request-preview]
[--pull-request-environment-name <value>]
[--backend-environment-arn <value>]
[--backend <value>]
[--compute-role-arn <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]

Параметры

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

Уникальный идентификатор приложения Amplify.

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

Имя ветки.

--description (строка)

Описание ветки.

--framework (строка)

Фреймворк для ветки.

--stage (строка)

Описывает текущую стадию для ветки.

Возможные значения:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

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

Включает уведомления для ветки.

--enable-auto-build | --no-enable-auto-build (логическое значение)

Включает автоматическое построение для ветки.

--enable-skew-protection | --no-enable-skew-protection (логическое значение)

Указывает, включена ли функция защиты смещения для ветки.

Защита от смещения развертывания доступна для приложений Amplify для устранения проблем со смещением версий между клиентом и серверами в веб-приложениях. При применении защиты от смещения к ветке вы можете гарантировать, что клиенты всегда взаимодействуют с правильной версией серверных ресурсов, независимо от времени развертывания. Дополнительную информацию о защите от смещения см. в руководстве пользователя Amplify в разделе «Защита от смещения для развертываний Amplify».

--environment-variables (карта)

Переменные среды для ветки.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--basic-auth-credentials (строка)

Основные учетные данные для авторизации для ветки. Вам необходимо выполнить кодирование учетных данных авторизации в base64 и предоставить их в формате user:password.

--enable-basic-auth | --no-enable-basic-auth (логическое значение)

Включает основную авторизацию для ветки.

--enable-performance-mode | --no-enable-performance-mode (логическое значение)

Включает режим производительности для ветки.

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

--build-spec (строка)

Спецификация сборки (build spec) для ветки.

--ttl (строка)

Время жизни содержимого (TTL) для веб-сайта во секундах.

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

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

--enable-pull-request-preview | --no-enable-pull-request-preview (логическое значение)

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

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

Имя среды Amplify для запроса на вытягивание.

--backend-environment-arn (строка)

Amazon Resource Name (ARN) для среды бэкенда, которая является частью приложения Amplify Gen 1.

Это поле доступно только для приложений Amplify Gen 1, где бэкенд создается с помощью Amplify Studio или командной строки Amplify (CLI).

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

Бэкенд для Branch приложения Amplify. Используется для бэкенда, созданного из стека CloudFormation.

Это поле доступно только для приложений Amplify Gen 2. При развертывании приложения Amplify Gen 2 вы настраиваете инфраструктуру бэкенда приложения с помощью кода TypeScript.

stackArn -> (строка)

Amazon Resource Name (ARN) для стека CloudFormation.

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

stackArn=string

Синтаксис JSON:

{
  "stackArn": "string"
}

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

Amazon Resource Name (ARN) роли IAM, которая должна быть назначена ветке приложения SSR. Роль вычислений SSR позволяет службе вычислений Amplify Hosting безопасно получать доступ к определенным ресурсам Amazon Web Services на основе разрешений роли. Дополнительную информацию о роли вычислений SSR см. в руководстве пользователя Amplify в разделе «Добавление роли вычислений SSR».

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

Вывод

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

Ветка приложения Amplify, которая отображается в ветке стороннего репозитория.

branchArn -> (строка)

Amazon Resource Name (ARN) ветки, которая входит в состав приложения Amplify.

branchName -> (строка)

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

description -> (строка)

Описание ветки, которая входит в состав приложения Amplify.

tags -> (массив)

Тег ветки приложения Amplify.

key -> (строка)

value -> (строка)

stage -> (строка)

Текущая стадия ветки, которая входит в состав приложения Amplify.

displayName -> (строка)

Используемое имя отображения ветки. Оно используется в качестве префикса по умолчанию для домена.

enableNotification -> (булево)

Включает уведомления для ветки, которая входит в состав приложения Amplify.

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

Метка времени создания ветки сервисом Amplify.

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

Метка времени последнего обновления ветки.

environmentVariables -> (массив)

Переменные среды, специфичные для ветки приложения Amplify.

key -> (строка)

value -> (строка)

enableAutoBuild -> (булево)

Включает автоматическое построение при изменении кода в ветке приложения Amplify.

enableSkewProtection -> (булево)

Указывает, включена ли функция защиты от искажений для ветки.

Защита от искажений при развертывании доступна приложениям Amplify для устранения проблем с искажениями версий между клиентом и серверами в веб-приложениях. При применении защиты от искажений к ветке вы можете гарантировать, что клиенты всегда взаимодействуют с правильной версией серверных ресурсов, независимо от времени развертывания. Дополнительную информацию о защите от искажений см. в руководстве пользователя Amplify в разделе «Защита от искажений при развертывании Amplify».

customDomains -> (список)

Настраиваемые домены ветки приложения Amplify.

(строка)

framework -> (строка)

Фреймворк ветки приложения Amplify.

activeJobId -> (строка)

Идентификатор активной задачи для ветки приложения Amplify.

totalNumberOfJobs -> (строка)

Общее количество задач, входящих в состав приложения Amplify.

enableBasicAuth -> (булево)

Включает базовый аутентификацию для ветки приложения Amplify.

enablePerformanceMode -> (булево)

Включает режим производительности для ветки.

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

thumbnailUrl -> (строка)

Ссылка на миниатюру ветки приложения Amplify.

basicAuthCredentials -> (строка)

Данные базовой аутентификации для ветки приложения Amplify. Вам необходимо закодировать данные аутентификации в base64 и предоставить их в формате user:password .

buildSpec -> (строка)

Содержание спецификации построения (build spec) для ветки приложения Amplify.

ttl -> (строка)

Время жизни содержимого (TTL) веб-сайта в секундах.

associatedResources -> (список)

Список настраиваемых ресурсов, связанных с этой веткой.

(строка)

enablePullRequestPreview -> (булево)

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

pullRequestEnvironmentName -> (строка)

Имя среды Amplify для запроса на слияние.

destinationBranch -> (строка)

Целевая ветка, если ветка является веткой запроса на слияние.

sourceBranch -> (строка)

Исходная ветка, если ветка является веткой запроса на слияние.

backendEnvironmentArn -> (строка)

Amazon Resource Name (ARN) для среды бэкенда, которая входит в состав приложения Amplify.

Это свойство доступно только для приложений Amplify Gen 1. При развертывании приложения с Amplify Gen 2 вы настраиваете инфраструктуру бэкенда приложения с помощью кода Typescript.

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

Описание бэкенда, связанного с приложеним Amplify Branch .

Это свойство доступно только для приложений Amplify Gen 2. При развертывании приложения с Amplify Gen 2 вы настраиваете инфраструктуру бэкенда приложения с помощью кода Typescript.

stackArn -> (строка)

Amazon Resource Name (ARN) для стека CloudFormation.

computeRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM для ветки приложения SSR. Роль вычислений позволяет службе вычислений Amplify Hosting безопасно получать доступ к определенным ресурсам Amazon Web Services на основе разрешений роли. Дополнительную информацию о роли вычислений SSR см. в руководстве пользователя Amplify в разделе «Добавление роли вычислений SSR».

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

Spec-Zone.ru

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