Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

update-app

Описание

Обновляет существующее приложение Amplify.

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

Синтаксис

  update-app
--app-id <value>
[--name <value>]
[--description <value>]
[--platform <value>]
[--compute-role-arn <value>]
[--iam-service-role-arn <value>]
[--environment-variables <value>]
[--enable-branch-auto-build | --no-enable-branch-auto-build]
[--enable-branch-auto-deletion | --no-enable-branch-auto-deletion]
[--enable-basic-auth | --no-enable-basic-auth]
[--basic-auth-credentials <value>]
[--custom-rules <value>]
[--build-spec <value>]
[--custom-headers <value>]
[--enable-auto-branch-creation | --no-enable-auto-branch-creation]
[--auto-branch-creation-patterns <value>]
[--auto-branch-creation-config <value>]
[--repository <value>]
[--oauth-token <value>]
[--access-token <value>]
[--cache-config <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.

--name (строка)

Имя приложения Amplify.

--description (строка)

Описание приложения Amplify.

--platform (строка)

Платформа приложения Amplify. Для статического приложения установите тип платформы на WEB. Для динамического приложения с серверной отрисовкой (SSR) установите тип платформы на WEB_COMPUTE. Для приложения, требующего только оригинальную поддержку SSR Amplify Hosting, установите тип платформы на WEB_DYNAMIC.

Если вы развертываете приложение только SSG с Next.js версии 14 или выше, вы должны установить тип платформы на WEB_COMPUTE.

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

  • WEB
  • WEB_DYNAMIC
  • WEB_COMPUTE

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

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

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

Amazon Resource Name (ARN) роли службы IAM для приложения Amplify.

--environment-variables (массив)

Переменные окружения для приложения Amplify.

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

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

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

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

Автоматически отключает ветвь в консоли Amplify при удалении ветви из вашего Git-репозитория.

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

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

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

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

--custom-rules (список)

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

(структура)

Описание настраиваемого правила переписывания или перенаправления.

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

Шаблон источника для правила переписывания или перенаправления URL.

цель -> (строка)

Шаблон цели для правила переписывания или перенаправления URL.

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

Код состояния для правила переписывания или перенаправления URL.

200

Представляет правило переписывания 200.

301

Представляет правило перенаправления 301 (постоянное перемещение). Все последующие запросы должны быть направлены на целевой URL.

302

Представляет правило временного перенаправления 302.

404

Представляет правило перенаправления 404.

404-200

Представляет правило переписывания 404.

условие -> (строка)

Условие для правила переписывания или перенаправления URL, например, код страны.

Краткая запись:

source=string,target=string,status=string,condition=string ...

Синтаксис JSON:

[
  {
    "source": "string",
    "target": "string",
    "status": "string",
    "condition": "string"
  }
  ...
]

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

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

--custom-headers (строка)

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

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

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

--auto-branch-creation-patterns (список)

Описание шаблонов glob для автоматического создания ветвей в приложении Amplify.

(строка)

Синтаксис:

"string" "string" ...

--auto-branch-creation-config (структура)

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

этап -> (строка)

Описание текущего этапа для автоматически созданной ветви.

фреймворк -> (строка)

Фреймворк для автоматически созданной ветви.

включитьАвтоСборку -> (логическое значение)

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

переменныеОкружения -> (массив)

Переменные окружения для автоматически созданной ветви.

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

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

ключАутентификации -> (строка)

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

включитьБазовуюАутентификацию -> (логическое значение)

Включает базовую аутентификацию для автоматически созданной ветви.

включитьРежимПроизводительности -> (логическое значение)

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

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

спецификацияСборки -> (строка)

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

включитьПредварительныйПросмотрPullRequest -> (логическое значение)

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

имяОкруженияPullRequest -> (строка)

Имя среды Amplify для pull request.

Краткая запись:

stage=string,framework=string,enableAutoBuild=boolean,environmentVariables={KeyName1=string,KeyName2=string},basicAuthCredentials=string,enableBasicAuth=boolean,enablePerformanceMode=boolean,buildSpec=string,enablePullRequestPreview=boolean,pullRequestEnvironmentName=string

Синтаксис JSON:

{
  "stage": "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST",
  "framework": "string",
  "enableAutoBuild": true|false,
  "environmentVariables": {"string": "string"
    ...},
  "basicAuthCredentials": "string",
  "enableBasicAuth": true|false,
  "enablePerformanceMode": true|false,
  "buildSpec": "string",
  "enablePullRequestPreview": true|false,
  "pullRequestEnvironmentName": "string"
}

--repository (строка)

Имя Git-репозитория для приложения Amplify.

--oauth-token (строка)

Токен OAuth для системы управления версиями сторонних источников для приложения Amplify. Токен OAuth используется для создания вебхука и ключа для чтения-только развертывания с помощью SSH-клонирования. Токен OAuth не сохраняется.

Используйте oauthToken для поставщиков репозиториев, отличных от GitHub, таких как Bitbucket или CodeCommit.

Для авторизации доступа к GitHub в качестве поставщика репозитория используйте accessToken.

Вы должны указать либо oauthToken, либо accessToken при обновлении приложения.

Существующие приложения Amplify, развертываемые из репозитория GitHub с использованием OAuth, по-прежнему работают с CI/CD. Однако мы настоятельно рекомендуем перейти на использование приложения GitHub для Amplify. Дополнительную информацию см. в разделе Переход с существующего приложения OAuth на приложение Amplify GitHub App в руководстве пользователя Amplify.

--access-token (строка)

Личный токен доступа для репозитория GitHub для приложения Amplify. Личный токен доступа используется для авторизации доступа к репозиторию GitHub с помощью приложения Amplify GitHub. Токен не сохраняется.

Используйте accessToken только для репозиториев GitHub. Для авторизации доступа к поставщику репозиториев, такому как Bitbucket или CodeCommit, используйте oauthToken.

Вы должны указать либо accessToken, либо oauthToken при обновлении приложения.

Существующие приложения Amplify, развертываемые из репозитория GitHub с использованием OAuth, по-прежнему работают с CI/CD. Однако мы настоятельно рекомендуем перейти на использование приложения GitHub для Amplify. Дополнительную информацию см. в разделе Переход с существующего приложения OAuth на приложение Amplify GitHub App в руководстве пользователя Amplify.

--cache-config (структура)

Настройка кэша для приложения Amplify.

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

Тип конфигурации кэша для использования в приложении Amplify.

Конфигурация кэша AMPLIFY_MANAGED автоматически применяет оптимизированную конфигурацию кэша для вашего приложения на основе платформы, правил маршрутизации и правил переписывания. Это значение по умолчанию.

Тип конфигурации кэша AMPLIFY_MANAGED_NO_COOKIES такой же, как AMPLIFY_MANAGED, за исключением того, что все куки исключаются из ключа кэша.

Краткая запись:

type=string

Синтаксис JSON:

{
  "type": "AMPLIFY_MANAGED"|"AMPLIFY_MANAGED_NO_COOKIES"
}

--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 (boolean)

Включить отладку логгирования.

--endpoint-url (string)

Переопределить URL команды по умолчанию заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запрос параметров ввода CLI.

Вывод

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

Представляет обновленное приложение Amplify.

appId -> (строка)

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

appArn -> (строка)

Amazon Resource Name (ARN) приложения Amplify.

name -> (строка)

Имя приложения Amplify.

tags -> (массив)

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

key -> (строка)

value -> (строка)

description -> (строка)

Описание приложения Amplify.

repository -> (строка)

Git-репозиторий приложения Amplify.

platform -> (строка)

Платформа приложения Amplify. Для статического приложения установите тип платформы в WEB. Для динамического приложения с рендерингом на стороне сервера (SSR) установите тип платформы в WEB_COMPUTE. Для приложения, требующего только исходную поддержку SSR Amplify Hosting, установите тип платформы в WEB_DYNAMIC.

Если вы развёртываете приложение только SSG с Next.js 14 или более поздней версии, вы должны использовать тип платформы WEB_COMPUTE.

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

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

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

Временная метка обновления приложения Amplify.

computeRoleArn -> (строка)

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

iamServiceRoleArn -> (строка)

Amazon Resource Name (ARN) сервисной роли IAM для приложения Amplify.

environmentVariables -> (массив)

Переменные окружения приложения Amplify.

Список переменных окружения, доступных для Amplify по умолчанию, см. в Переменные окружения Amplify в Руководстве пользователя Amplify Hosting.

key -> (строка)

value -> (строка)

defaultDomain -> (строка)

Домен по умолчанию для приложения Amplify.

enableBranchAutoBuild -> (boolean)

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

enableBranchAutoDeletion -> (boolean)

Автоматически отключает ветку в консоли Amplify при удалении ветки из вашего Git-репозитория.

enableBasicAuth -> (boolean)

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

basicAuthCredentials -> (строка)

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

customRules -> (список)

Описание пользовательских правил перенаправления и переписывания URL для приложения Amplify.

(структура)

Описание правила переписывания или перенаправления URL.

source -> (строка)

Шаблон исходного URL для правила переписывания или перенаправления URL.

target -> (строка)

Шаблон целевого URL для правила переписывания или перенаправления URL.

status -> (строка)

Код состояния для правила переписывания или перенаправления URL.

200

Представляет правило переписывания 200.

301

Представляет правило перенаправления 301 (перемещение навсегда). Этот и все последующие запросы должны направляться на целевой URL.

302

Представляет временное правило перенаправления 302.

404

Представляет правило перенаправления 404.

404-200

Представляет правило переписывания 404.

condition -> (строка)

Условие для правила переписывания или перенаправления URL, например, код страны.

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

Описание информации о ветке производства приложения Amplify.

lastDeployTime -> (временная метка)

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

status -> (строка)

Статус ветки производства.

thumbnailUrl -> (строка)

URL миниатюры ветки производства.

branchName -> (строка)

Имя ветки производства.

buildSpec -> (строка)

Описание содержимого спецификации сборки (build spec) приложения Amplify.

customHeaders -> (строка)

Описание пользовательских HTTP-заголовков для приложения Amplify.

enableAutoBranchCreation -> (boolean)

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

autoBranchCreationPatterns -> (список)

Описание шаблонов создания веток с помощью glob для приложения Amplify.

(строка)

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

Описание конфигурации автоматического создания веток для приложения Amplify.

stage -> (строка)

Описание текущего этапа для автоматически созданной ветки.

framework -> (строка)

Фреймворк для автоматически созданной ветки.

enableAutoBuild -> (boolean)

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

environmentVariables -> (массив)

Переменные окружения для автоматически созданной ветки.

key -> (строка)

value -> (строка)

basicAuthCredentials -> (строка)

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

enableBasicAuth -> (boolean)

Включает базовую аутентификацию для автоматически созданной ветки.

enablePerformanceMode -> (boolean)

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

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

buildSpec -> (строка)

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

enablePullRequestPreview -> (boolean)

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

pullRequestEnvironmentName -> (строка)

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

repositoryCloneMethod -> (строка)

Примечание

Это для внутреннего использования.

Сервис Amplify использует этот параметр для указания протокола аутентификации для доступа к Git-репозиторию приложения Amplify. Amplify задаёт TOKEN для репозитория GitHub, SIGV4 для репозитория Amazon Web Services CodeCommit и SSH для репозиториев GitLab и Bitbucket.

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

Конфигурация кэша для приложения Amplify. Если вы не указываете конфигурацию кэша type, Amplify использует настройки по умолчанию AMPLIFY_MANAGED.

type -> (строка)

Тип конфигурации кэша для использования в приложении Amplify.

Конфигурация кэша AMPLIFY_MANAGED автоматически применяет оптимизированную конфигурацию кэша для вашего приложения на основе его платформы, правил маршрутизации и правил переписывания. Это значение по умолчанию.

Тип конфигурации кэша AMPLIFY_MANAGED_NO_COOKIES аналогичен AMPLIFY_MANAGED, за исключением того, что он исключает все куки из ключа кэша.

webhookCreateTime -> (временная метка)

Временная метка создания webhook в вашем Git-репозитории.

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

Описывает конфигурацию брандмауэра для приложения Amplify. Поддержка брандмауэра позволяет защитить ваши размещённые приложения с помощью прямой интеграции с WAF.

webAclArn -> (строка)

Amazon Resource Name (ARN) для web ACL, связанного с приложением Amplify.

wafStatus -> (строка)

Статус процесса ассоциации или диссоциации web ACL с приложением Amplify.

statusReason -> (строка)

Причина текущего статуса конфигурации брандмауэра.

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

Spec-Zone.ru

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