Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

create-branch

Описание

Создаёт новую ветвь для приложения Amplify.

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

Синтаксис

  create-branch
--app-id <value>
--branch-name <value>
[--description <value>]
[--stage <value>]
[--framework <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]
[--tags <value>]
[--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 (строка)

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

--stage (строка)

Определяет текущий этап для ветви.

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

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

--framework (строка)

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

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

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

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

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

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

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

Защита от смещения развертывания доступна для приложений 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 минут.

--tags (массив)

Тег для ветви.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

--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 Compute позволяет сервису вычислений Amplify Hosting безопасно получать доступ к определённым ресурсам Amazon Web Services, в зависимости от разрешений роли. Более подробную информацию о роли SSR Compute см. в руководстве по Amplify по добавлению роли SSR Compute.

--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
  • таблица
  • 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.

Вывод

ветвь -> (структура)

Описание ветви для приложения Amplify, которая сопоставляется с ветвью репозитория стороннего поставщика.

branchArn -> (строка)

Идентификатор ресурса Amazon (ARN) для ветви, которая является частью приложения Amplify.

branchName -> (строка)

Имя ветви, которая является частью приложения Amplify.

description -> (строка)

Описание ветви, которая является частью приложения Amplify.

tags -> (карта)

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

key -> (строка)

value -> (строка)

stage -> (строка)

Текущий этап для ветви, которая является частью приложения Amplify.

displayName -> (строка)

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

enableNotification -> (булево)

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

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

Метка времени, когда Amplify создал ветвь.

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

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

environmentVariables -> (карта)

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

key -> (строка)

value -> (строка)

enableAutoBuild -> (булево)

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

enableSkewProtection -> (булево)

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

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

customDomains -> (список)

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

(строка)

framework -> (строка)

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

activeJobId -> (строка)

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

totalNumberOfJobs -> (строка)

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

enableBasicAuth -> (булево)

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

enablePerformanceMode -> (булево)

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

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

thumbnailUrl -> (строка)

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

basicAuthCredentials -> (строка)

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

buildSpec -> (строка)

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

ttl -> (строка)

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

associatedResources -> (список)

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

(строка)

enablePullRequestPreview -> (булево)

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

pullRequestEnvironmentName -> (строка)

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

destinationBranch -> (строка)

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

sourceBranch -> (строка)

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

backendEnvironmentArn -> (строка)

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

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

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

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

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

stackArn -> (строка)

Идентификатор ресурса Amazon (ARN) для стека CloudFormation.

computeRoleArn -> (строка)

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

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

Spec-Zone.ru

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