get-branch
Описание
Возвращает ветвь для приложения Amplify.
См. также: Документацию API AWS
Синтаксис
get-branch
--app-id <value>
--branch-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]
Параметры
--app-id (строка)
--branch-name (строка)
--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 (строка)
Файл с корневым сертификатом для проверки 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 -> (строка)
branchName -> (строка)
description -> (строка)
tags -> (карта)
Тег ветви приложения Amplify.
key -> (строка)
value -> (строка)
stage -> (строка)
displayName -> (строка)
enableNotification -> (логическое значение)
createTime -> (временная метка)
updateTime -> (временная метка)
environmentVariables -> (карта)
Переменные среды, специфичные для ветви приложения Amplify.
key -> (строка)
value -> (строка)
enableAutoBuild -> (логическое значение)
enableSkewProtection -> (логическое значение)
Указывает, включена ли функция защиты смещения для ветви.
Защита смещения при развертывании доступна для приложений Amplify для устранения проблем со смещением версий между клиентом и сервером в веб-приложениях. При применении защиты смещения к ветви можно гарантировать, что клиенты всегда взаимодействуют с правильной версией серверных ресурсов, независимо от времени развертывания. Дополнительную информацию о защите смещения см. в руководстве пользователя Amplify в разделе Защита смещения при развертывании Amplify.
customDomains -> (список)
Список пользовательских доменов для ветви приложения Amplify.
(строка)
framework -> (строка)
activeJobId -> (строка)
totalNumberOfJobs -> (строка)
enableBasicAuth -> (логическое значение)
enablePerformanceMode -> (логическое значение)
Включает режим производительности для ветви.
Режим производительности оптимизирован для более быстрой производительности размещения, сохраняя кэш содержимого на границе на более длительный период. При включенном режиме производительности изменения конфигурации или кода размещения могут занимать до 10 минут для развертывания.
thumbnailUrl -> (строка)
basicAuthCredentials -> (строка)
user:password.buildSpec -> (строка)
ttl -> (строка)
associatedResources -> (список)
Список пользовательских ресурсов, связанных с этой ветвью.
(строка)
enablePullRequestPreview -> (логическое значение)
pullRequestEnvironmentName -> (строка)
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 -> (строка)
computeRoleArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|