create-pipeline

Описание

Создаёт конвейер.

Примечание

В структуре конвейера необходимо включить либо artifactStore, либо artifactStores, но нельзя использовать оба. Если вы создаёте действие кросс-региона в своём конвейере, вы должны использовать artifactStores.

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

Синтаксис

  create-pipeline
--pipeline <value>
[--tags <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]

Параметры

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

Представляет структуру действий и этапов, которые будут выполняться в конвейере.

name -> (строка)

Имя конвейера.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) для CodePipeline, который используется для выполнения действий без actionRoleArn или для делегирования ролей для действий с actionRoleArn.

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

Представляет информацию о ведре S3, где хранятся артефакты для конвейера.

Примечание

Необходимо включить либо artifactStore, либо artifactStores в ваш конвейер, но нельзя использовать оба. Если вы создаёте действие кросс-региона в своём конвейере, вы должны использовать artifactStores.

type -> (строка)

Тип хранилища артефактов, например, S3.

location -> (строка)

Ведро S3, используемое для хранения артефактов конвейера. Вы можете указать имя ведра S3, но не папку в ведре. Для вас создаётся папка для хранения артефактов конвейера на основе имени конвейера. Вы можете использовать любое ведро S3 в той же Регионе Amazon Web Services, что и конвейер, для хранения артефактов конвейера.

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

Ключ шифрования, используемый для шифрования данных в хранилище артефактов, например, ключ службы управления ключами Amazon Web Services. Если он не определён, используется ключ по умолчанию для Amazon S3.

id -> (строка)

Идентификатор, используемый для идентификации ключа. Для ключа Amazon Web Services KMS вы можете использовать идентификатор ключа, ARN ключа или ARN псевдонима.

Примечание

Псевдонимы распознаются только в аккаунте, который создал ключ KMS. Для действий между аккаунтами вы можете использовать только идентификатор ключа или ARN ключа для идентификации ключа. Действия между аккаунтами подразумевают использование роли из другого аккаунта (AccountB), поэтому указание идентификатора ключа будет использовать ключ из другого аккаунта (AccountB).

type -> (строка)

Тип ключа шифрования, например, ключ Amazon Web Services KMS. При создании или обновлении конвейера значение должно быть установлено в «KMS».

artifactStores -> (массив)

Мапинг объектов artifactStore и соответствующих Регионов Amazon Web Services. Должно быть хранилище артефактов для Региона конвейера и для каждого действия кросс-региона в конвейере.

Примечание

key -> (строка)

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

Ведро S3, где хранятся артефакты для конвейера.

Примечание

type -> (строка)

Тип хранилища артефактов, например, S3.

location -> (строка)

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

id -> (строка)

Примечание

type -> (строка)

stages -> (список)

Этап, на котором выполнить действие.

(структура)

Представляет информацию о стадии и её определении.

name -> (строка)

Название этапа.

blockers -> (список)

Зарезервировано для будущего использования.

(структура)

Зарезервировано для будущего использования.

name -> (строка)

Зарезервировано для будущего использования.

type -> (строка)

Зарезервировано для будущего использования.

actions -> (список)

Действия, включенные в этап.

(структура)

Представляет информацию о декларации действия.

name -> (строка)

Название декларации действия.

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

Указывает тип действия и поставщика действия.

category -> (строка)

Категория определяет, какой тип действия можно выполнить на этапе, и ограничивает тип поставщика для действия. Допустимые категории ограничены следующими значениями.

Источник
Сборка
Тестирование
Развертывание
Вызов
Утверждение
Вычисление

owner -> (строка)

Создатель вызываемого действия. Существует три допустимых значения для поля Owner в разделе категории действий в структуре вашей конвейерной линии: AWS , ThirdParty и Custom. Для получения дополнительной информации см. Допустимые типы и поставщики действий в CodePipeline.

provider -> (строка)

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

version -> (строка)

Строка, описывающая версию действия.

runOrder -> (целое число)

Порядок выполнения действий.

configuration -> (карта)

Настройка действия. Это пары ключ-значение, которые указывают входные значения для действия. Для получения дополнительной информации см. Требования к структуре действий в CodePipeline. Для получения списка свойств конфигурации для типа действия CloudFormation в CodePipeline см. Справочник по свойствам конфигурации в Руководстве пользователя CloudFormation. Для фрагментов шаблонов с примерами см. Использование функций переопределения параметров с конвейерными линиями CodePipeline в Руководстве пользователя CloudFormation.

Значения могут быть представлены в формате JSON или YAML. Например, формат элемента конфигурации JSON выглядит следующим образом:

JSON:

"Configuration" : { Key : Value },

key -> (строка)

value -> (строка)

commands -> (список)

Команды оболочки для запуска действия вычисления в CodePipeline. Поддерживаются все команды, кроме многострочных форматов. Хотя используются журналы и разрешения CodeBuild, вам не нужно создавать какие-либо ресурсы в CodeBuild.

Примечание

Использование времени вычисления для этого действия повлечёт отдельные расходы в CodeBuild.

(строка)

outputArtifacts -> (список)

Имя или идентификатор результата объявления действия, такого как артефакт теста или сборки.

(структура)

Представляет информацию об выводе действия.

name -> (строка)

Название вывода артефакта, например, «Мой Приложение».

Входной артефакт действия должен точно совпадать с выходным артефактом, объявленным в предыдущем действии, но входной артефакт не должен быть следующим действием в строгой последовательности от действия, которое предоставило выходной артефакт. Действия в параллели могут объявлять разные выходные артефакты, которые в свою очередь потребляются разными последующими действиями.

Имена выходных артефактов должны быть уникальными в пределах конвейера.

files -> (список)

Файлы, которые вы хотите связать с выходным артефактом, который будет экспортирован из действия вычисления.

(строка)

inputArtifacts -> (список)

Имя или идентификатор артефакта, используемого действием, например, артефакт теста или сборки.

(структура)

Представляет информацию об артефакте, над которым необходимо работать, например, артефакте теста или сборки.

name -> (строка)

Название артефакта для обработки (например, «Мой Приложение»).

Артефакты — это файлы, над которыми работают действия в конвейере. Подробности параметров артефактов см. в настройке каждого действия. Например, входной артефакт действия источника S3 — это имя файла (или путь к файлу), и файлы обычно предоставляются в формате ZIP-архива. Пример имени артефакта: SampleApp_Windows.zip

outputVariables -> (список)

Список переменных, которые должны быть экспортированы из действия вычисления. Это конкретные переменные среды CodeBuild, используемые для этого действия.

(строка)

roleArn -> (строка)

ARN службы IAM, выполняющей объявленное действие. Предполагается через roleArn для конвейерной линии.

region -> (строка)

Регион Amazon Web Services, например, us-east-1, в котором объявлено действие.

namespace -> (строка)

Пространство имён переменных, связанное с действием. Все переменные, созданные в качестве выходных данных этим действием, находятся в этом пространстве имён.

timeoutInMinutes -> (целое число)

Время ожидания в минутах, которое может быть применено к значению по умолчанию для ActionType, указанному в квотах CodePipeline. Этот атрибут доступен только для типа действия ручного утверждения.

environmentVariables -> (список)

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

(структура)

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

name -> (строка)

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

value -> (строка)

Значение переменной среды в паре ключ-значение.

type -> (строка)

Указывает тип использования значения переменной среды. Значение может быть либо PLAINTEXT, либо SECRETS_MANAGER. Если значение равно SECRETS_MANAGER, укажите ссылку на секреты в значении EnvironmentVariable.

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

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

result -> (строка)

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

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

Настройка повторной попытки определяет автоматическую повторную попытку неисправного этапа, а также настроенный режим повторной попытки.

retryMode -> (строка)

Метод, который вы хотите настроить для автоматической повторной попытки этапа при сбое этапа. Вы можете указать, чтобы повторная попытка выполнялась только для неисправного действия на этапе или для всех действий на этапе.

conditions -> (список)

Условия, настроенные как условия сбоя. Для получения дополнительной информации об условиях см. Условия этапов и Как работают условия этапов?.

(структура)

Условие для этапа. Условие состоит из правил и результата для условия. Для получения дополнительной информации об условиях см. Условия этапов и Как работают условия этапов?. Для получения дополнительной информации о правилах см. справочник по правилам CodePipeline.

result -> (строка)

Действие, которое должно быть выполнено при соблюдении условия. Например, откат выполнения при условии сбоя.

rules -> (список)

Правила, составляющие условие.

(структура)

Представляет информацию о правиле, которое будет создано для связанного условия. Примером является создание нового правила для условия входа, например, правила, которое проверяет результат теста перед тем, как разрешить выполнение войти на этап развертывания. Для получения дополнительной информации об условиях см. Условия этапов и Как работают условия этапов?. Для получения дополнительной информации о правилах см. справочник по правилам CodePipeline.

name -> (строка)

Название правила, созданного для условия, например, VariableCheck.

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

Идентификатор типа правила, состоящий из объединённых значений категории, владельца, поставщика и версии.

category -> (строка)

Категория определяет, какой тип правила можно запустить на этапе, и ограничивает тип поставщика для правила. Допустимая категория — Rule.

owner -> (строка)

Создатель вызываемого правила. Допустимое значение для поля Owner в категории правил — AWS.

provider -> (строка)

Поставщик правил, например, правило DeploymentWindow. Список имён поставщиков правил см. в справочнике по правилам CodePipeline.

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Команды оболочки для запуска вашего правила команд в CodePipeline. Поддерживаются все команды, кроме многострочных форматов. Хотя используются журналы и разрешения CodeBuild, вам не нужно создавать какие-либо ресурсы в CodeBuild.

Примечание

Использование времени вычисления для этого действия повлечёт отдельные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

name -> (строка)

Название артефакта для обработки (например, «Мой Приложение»).

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Время ожидания действия для правила.

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

Метод, используемый, когда этап завершился успешно. Например, настройка этого поля для условий позволит этапу завершиться успешно, когда условия будут выполнены.

conditions -> (список)

Условия, являющиеся условиями успеха.

(структура)

Условие для этапа. Условие состоит из правил и результата для условия. Дополнительную информацию об условиях см. в разделах Условия этапов и Как работают условия этапов?. Дополнительную информацию о правилах см. в справочнике по правилам CodePipeline.

result -> (строка)

Действие, которое должно быть выполнено, когда условие выполняется. Например, откат выполнения для условия сбоя.

rules -> (список)

Правила, составляющие условие.

(структура)

Представляет информацию о правиле, которое нужно создать для связанного условия. Пример — создание нового правила для условия входа, например, правило, которое проверяет результат теста перед разрешением запуску войти на этап развертывания. Дополнительную информацию об условиях см. в разделах Условия этапов и Как работают условия этапов?. Дополнительную информацию о правилах см. в справочнике по правилам CodePipeline.

name -> (строка)

Имя правила, созданного для условия, например, VariableCheck.

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

Идентификатор типа правила, который состоит из объединённых значений категории, владельца, поставщика и версии.

category -> (строка)

Категория определяет, какой тип правила можно запустить на этапе и ограничивает тип поставщика для правила. Действительная категория — Rule.

owner -> (строка)

Создатель вызываемого правила. Действительное значение для поля Owner в категории правила — AWS.

provider -> (строка)

Поставщик правила, например, правило DeploymentWindow. Список имён поставщиков правил см. в справочнике по правилам CodePipeline.

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Команды оболочки для выполнения с вашим правилом команд в CodePipeline. Поддерживаются все команды, кроме многострочных форматов. Хотя используются журналы и разрешения CodeBuild, вам не нужно создавать какие-либо ресурсы в CodeBuild.

Примечание

Использование времени вычислений для этого действия повлечёт дополнительные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

Представляет информацию об артефакте, над которым нужно работать, например, артефакт теста или сборки.

name -> (строка)

Имя артефакта, над которым нужно работать (например, «My App»).

Артефакты — это файлы, над которыми работают действия в конвейере. Подробности параметров артефактов см. в конфигурации действия для каждого действия. Например, входной артефакт действия источника S3 — это имя файла (или путь к файлу), и файлы обычно предоставляются в формате ZIP. Пример имени артефакта: SampleApp_Windows.zip

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

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Таймаут действия для правила.

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

Метод, используемый, когда этап разрешает вход. Например, настройка этого поля для условий позволит войти на этап, когда условия будут выполнены.

conditions -> (список)

Условия, настроенные как условия входа.

(структура)

result -> (строка)

rules -> (список)

Правила, составляющие условие.

(структура)

name -> (строка)

Имя правила, созданного для условия, например, VariableCheck.

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

category -> (строка)

owner -> (строка)

Создатель вызываемого правила. Действительное значение для поля Owner в категории правила — AWS.

provider -> (строка)

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Примечание

Использование времени вычислений для этого действия повлечёт дополнительные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

Представляет информацию об артефакте, над которым нужно работать, например, артефакт теста или сборки.

name -> (строка)

Имя артефакта, над которым нужно работать (например, «My App»).

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Таймаут действия для правила.

version -> (целое число)

Номер версии конвейера. Новый конвейер всегда имеет номер версии 1. Этот номер увеличивается при обновлении конвейера.

executionMode -> (строка)

Метод, который конвейер будет использовать для обработки нескольких выполнений. По умолчанию используется режим SUPERSEDED.

pipelineType -> (строка)

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

Конвейеры типа V1 имеют JSON-структуру, которая содержит стандартные параметры конвейера, этапа и действия.
Конвейеры типа V2 имеют ту же структуру, что и конвейеры типа V1, а также дополнительные параметры для безопасности выпусков и настройки триггеров.

Предупреждение

Включение параметров V2, таких как триггеры по тегам Git, в JSON-конвейера при создании или обновлении конвейера приведёт к тому, что конвейер будет иметь тип V2 и соответствующие расходы.

Дополнительную информацию о ценообразовании для CodePipeline см. в разделе Цены.

Дополнительную информацию о том, какой тип конвейера выбрать, см. в разделе Какой тип конвейера подходит мне?

variables -> (список)

Список, определяющий переменные конвейера для ресурса конвейера. Имена переменных могут содержать буквенно-цифровые символы и символы нижнего подчёркивания, а значения должны соответствовать [A-Za-z0-9@\-_]+.

(структура)

Переменная, объявленная на уровне конвейера.

name -> (строка)

Имя переменной уровня конвейера.

defaultValue -> (строка)

Значение переменной уровня конвейера.

description -> (строка)

Описание переменной уровня конвейера. Используется для добавления дополнительного контекста о переменной и не используется во время выполнения конвейера.

triggers -> (список)

Конфигурация триггера, определяющая тип события, такого как теги Git, запускающего конвейер.

Примечание

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

(структура)

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

Примечание

Это поддерживается только для типа действия CodeStarSourceConnection.

Примечание

providerType -> (строка)

Источник события, например, подключения, настроенные для репозитория с тегами Git, для заданной конфигурации триггера.

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

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

sourceActionName -> (строка)

Имя действия источника конвейера, где задана конфигурация триггера, например, теги Git. Конфигурация триггера запустит конвейер при указанном изменении.

Примечание

Вы можете указать только одну конфигурацию триггера на действие источника.

push -> (список)

Поле, где указывается событие репозитория, которое запустит конвейер, например, отправка тегов Git, с деталями.

(структура)

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

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

Поле, содержащее детали конфигурации триггера для тегов Git.

includes -> (список)

Список шаблонов тегов Git, которые при отправке должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов тегов Git, которые при отправке должны исключаться из запуска конвейера.

(строка)

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

Поле, определяющее фильтрацию по веткам для конфигурации триггера push.

includes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны исключаться из запуска конвейера.

(строка)

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

Поле, определяющее фильтрацию по путям файлов для конфигурации триггера push.

includes -> (список)

Список шаблонов путей к файлам репозитория Git, которые при отправке коммита должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов путей к файлам репозитория Git, которые при отправке коммита должны исключаться из запуска конвейера.

(строка)

pullRequest -> (список)

Поле, где событие репозитория, которое запустит конвейер, указано как запросы на вытягивание.

(структура)

Критерии события для конфигурации триггера pull request, такие как списки ветвей или путей к файлам для включения и исключения.

Следующие значения допустимы для событий для этого фильтра:

CLOSED
OPEN
UPDATED

events -> (список)

Поле, определяющее, какие события запросов на вытягивание фильтровать (OPEN, UPDATED, CLOSED) для конфигурации триггера.

(строка)

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

Поле, определяющее фильтрацию по веткам для конфигурации триггера pull request.

includes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны исключаться из запуска конвейера.

(строка)

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

Поле, определяющее фильтрацию по путям файлов для конфигурации триггера pull request.

includes -> (список)

(строка)

excludes -> (список)

(строка)

Синтаксис JSON:

{
  "name": "string",
  "roleArn": "string",
  "artifactStore": {
    "type": "S3",
    "location": "string",
    "encryptionKey": {
      "id": "string",
      "type": "KMS"
    }
  },
  "artifactStores": {"string": {
        "type": "S3",
        "location": "string",
        "encryptionKey": {
          "id": "string",
          "type": "KMS"
        }
      }
    ...},
  "stages": [
    {
      "name": "string",
      "blockers": [
        {
          "name": "string",
          "type": "Schedule"
        }
        ...
      ],
      "actions": [
        {
          "name": "string",
          "actionTypeId": {
            "category": "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|"Compute",
            "owner": "AWS"|"ThirdParty"|"Custom",
            "provider": "string",
            "version": "string"
          },
          "runOrder": integer,
          "configuration": {"string": "string"
            ...},
          "commands": ["string", ...],
          "outputArtifacts": [
            {
              "name": "string",
              "files": ["string", ...]
            }
            ...
          ],
          "inputArtifacts": [
            {
              "name": "string"
            }
            ...
          ],
          "outputVariables": ["string", ...],
          "roleArn": "string",
          "region": "string",
          "namespace": "string",
          "timeoutInMinutes": integer,
          "environmentVariables": [
            {
              "name": "string",
              "value": "string",
              "type": "PLAINTEXT"|"SECRETS_MANAGER"
            }
            ...
          ]
        }
        ...
      ],
      "onFailure": {
        "result": "ROLLBACK"|"FAIL"|"RETRY"|"SKIP",
        "retryConfiguration": {
          "retryMode": "FAILED_ACTIONS"|"ALL_ACTIONS"
        },
        "conditions": [
          {
            "result": "ROLLBACK"|"FAIL"|"RETRY"|"SKIP",
            "rules": [
              {
                "name": "string",
                "ruleTypeId": {
                  "category": "Rule",
                  "owner": "AWS",
                  "provider": "string",
                  "version": "string"
                },
                "configuration": {"string": "string"
                  ...},
                "commands": ["string", ...],
                "inputArtifacts": [
                  {
                    "name": "string"
                  }
                  ...
                ],
                "roleArn": "string",
                "region": "string",
                "timeoutInMinutes": integer
              }
              ...
            ]
          }
          ...
        ]
      },
      "onSuccess": {
        "conditions": [
          {
            "result": "ROLLBACK"|"FAIL"|"RETRY"|"SKIP",
            "rules": [
              {
                "name": "string",
                "ruleTypeId": {
                  "category": "Rule",
                  "owner": "AWS",
                  "provider": "string",
                  "version": "string"
                },
                "configuration": {"string": "string"
                  ...},
                "commands": ["string", ...],
                "inputArtifacts": [
                  {
                    "name": "string"
                  }
                  ...
                ],
                "roleArn": "string",
                "region": "string",
                "timeoutInMinutes": integer
              }
              ...
            ]
          }
          ...
        ]
      },
      "beforeEntry": {
        "conditions": [
          {
            "result": "ROLLBACK"|"FAIL"|"RETRY"|"SKIP",
            "rules": [
              {
                "name": "string",
                "ruleTypeId": {
                  "category": "Rule",
                  "owner": "AWS",
                  "provider": "string",
                  "version": "string"
                },
                "configuration": {"string": "string"
                  ...},
                "commands": ["string", ...],
                "inputArtifacts": [
                  {
                    "name": "string"
                  }
                  ...
                ],
                "roleArn": "string",
                "region": "string",
                "timeoutInMinutes": integer
              }
              ...
            ]
          }
          ...
        ]
      }
    }
    ...
  ],
  "version": integer,
  "executionMode": "QUEUED"|"SUPERSEDED"|"PARALLEL",
  "pipelineType": "V1"|"V2",
  "variables": [
    {
      "name": "string",
      "defaultValue": "string",
      "description": "string"
    }
    ...
  ],
  "triggers": [
    {
      "providerType": "CodeStarSourceConnection",
      "gitConfiguration": {
        "sourceActionName": "string",
        "push": [
          {
            "tags": {
              "includes": ["string", ...],
              "excludes": ["string", ...]
            },
            "branches": {
              "includes": ["string", ...],
              "excludes": ["string", ...]
            },
            "filePaths": {
              "includes": ["string", ...],
              "excludes": ["string", ...]
            }
          }
          ...
        ],
        "pullRequest": [
          {
            "events": ["OPEN"|"UPDATED"|"CLOSED", ...],
            "branches": {
              "includes": ["string", ...],
              "excludes": ["string", ...]
            },
            "filePaths": {
              "includes": ["string", ...],
              "excludes": ["string", ...]
            }
          }
          ...
        ]
      }
    }
    ...
  ]
}

--tags (список)

Теги конвейера.

(структура)

Тег — это пара ключ-значение, используемая для управления ресурсом.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

Краткая форма синтаксиса:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования на подобие Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Создание конвейера

В этом примере создается конвейер AWS CodePipeline с использованием уже созданного JSON-файла (здесь с именем MySecondPipeline.json), содержащего структуру конвейера. Дополнительную информацию о требованиях к созданию конвейера, включая структуру файла, см. в руководстве пользователя AWS CodePipeline.

Команда:

aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json

Пример содержимого JSON-файла:

{
 "pipeline": {
  "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
  "stages": [
    {
      "name": "Source",
      "actions": [
        {
          "inputArtifacts": [],
          "name": "Source",
          "actionTypeId": {
            "category": "Source",
            "owner": "AWS",
            "version": "1",
            "provider": "S3"
          },
          "outputArtifacts": [
            {
              "name": "MyApp"
            }
          ],
          "configuration": {
            "S3Bucket": "awscodepipeline-demo-bucket",
            "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
          },
          "runOrder": 1
        }
      ]
    },
    {
      "name": "Beta",
      "actions": [
        {
          "inputArtifacts": [
            {
              "name": "MyApp"
            }
          ],
          "name": "CodePipelineDemoFleet",
          "actionTypeId": {
            "category": "Deploy",
            "owner": "AWS",
            "version": "1",
            "provider": "CodeDeploy"
          },
          "outputArtifacts": [],
          "configuration": {
            "ApplicationName": "CodePipelineDemoApplication",
            "DeploymentGroupName": "CodePipelineDemoFleet"
          },
          "runOrder": 1
        }
      ]
    }
  ],
  "artifactStore": {
    "type": "S3",
    "location": "codepipeline-us-east-1-11EXAMPLE11"
  },
  "name": "MySecondPipeline",
  "version": 1
 }
}

Вывод:

This command returns the structure of the pipeline.

Вывод

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

Представляет структуру действий и этапов, которые должны быть выполнены в конвейере.

name -> (строка)

Имя конвейера.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) для CodePipeline, используемый для выполнения действий без actionRoleArn или для делегирования ролей для действий с actionRoleArn.

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

Представляет информацию о ведре S3, где хранятся артефакты для конвейера.

Примечание

Вы должны включить либо artifactStore, либо artifactStores в свой конвейер, но не оба. Если вы создаёте действие между регионами в своём конвейере, вы должны использовать artifactStores.

type -> (строка)

Тип хранилища артефактов, например, S3.

location -> (строка)

Ведро S3, используемое для хранения артефактов конвейера. Вы можете указать имя ведра S3, но не папку в ведре. Для вас создаётся папка для хранения артефактов конвейера на основе имени конвейера. Вы можете использовать любое ведро S3 в том же регионе Amazon Web Services, что и конвейер, для хранения артефактов конвейера.

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

Ключ шифрования, используемый для шифрования данных в хранилище артефактов, например, ключ службы управления ключами Amazon Web Services. Если этот параметр не определён, используется ключ по умолчанию для Amazon S3.

id -> (строка)

Примечание

Псевдонимы распознаются только в аккаунте, который создал ключ KMS. Для действий между аккаунтами можно использовать только идентификатор ключа или ARN ключа для идентификации ключа. Действия между аккаунтами подразумевают использование роли из другого аккаунта (AccountB), поэтому указание идентификатора ключа будет использовать ключ из другого аккаунта (AccountB).

type -> (строка)

Тип ключа шифрования, например, ключ Amazon Web Services KMS. При создании или обновлении конвейера значение должно быть установлено на «KMS».

artifactStores -> (массив)

Сопоставление объектов artifactStore и соответствующих регионов Amazon Web Services. Должно быть хранилище артефактов для региона конвейера и для каждого действия между регионами в конвейере.

Примечание

key -> (строка)

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

Ведро S3, где хранятся артефакты для конвейера.

Примечание

type -> (строка)

Тип хранилища артефактов, например, S3.

location -> (строка)

Ведро S3, используемое для хранения артефактов конвейера. Вы можете указать имя ведра S3, но не папку в ведре. Для вас создаётся папка для хранения артефактов конвейера на основе имени конвейера. Вы можете использовать любое ведро S3 в том же регионе Amazon Web Services, что и конвейер, для хранения артефактов конвейера.

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

id -> (строка)

Примечание

type -> (строка)

stages -> (список)

Этап, на котором нужно выполнить действие.

(структура)

Представляет информацию о этапе и его определении.

name -> (строка)

Название этапа.

blockers -> (список)

Зарезервировано для будущего использования.

(структура)

Зарезервировано для будущего использования.

name -> (строка)

Зарезервировано для будущего использования.

type -> (строка)

Зарезервировано для будущего использования.

actions -> (список)

Действия, включенные в этап.

(структура)

Представляет информацию об объявлении действия.

name -> (строка)

Имя объявления действия.

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

Определяет тип действия и поставщика действия.

category -> (строка)

Категория определяет, какой вид действия можно выполнить на этапе, и ограничивает тип поставщика для действия. Допустимые категории ограничены одним из следующих значений.

Источник
Сборка
Тестирование
Развертывание
Вызов
Утверждение
Вычисление

owner -> (строка)

Создатель вызываемого действия. Для поля Owner в разделе категории действия в вашей структуре конвейера доступны три допустимых значения: AWS , ThirdParty , и Custom . Дополнительная информация доступна в разделе Действительные типы и поставщики действий в CodePipeline.

provider -> (строка)

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

version -> (строка)

Строка, описывающая версию действия.

runOrder -> (целое число)

Порядок выполнения действий.

configuration -> (карта)

Настройка действия. Это пары ключ-значение, которые указывают входные значения для действия. Дополнительная информация доступна в разделе Требования к структуре действий в CodePipeline. Список свойств конфигурации для типа действия CloudFormation в CodePipeline см. в справочнике по свойствам конфигурации в Руководстве пользователя по CloudFormation. Примеры фрагментов шаблонов см. в разделе Использование функций параметрической переопределения с конвейерами CodePipeline в Руководстве пользователя по CloudFormation.

JSON:

"Configuration" : { Key : Value },

key -> (строка)

value -> (строка)

commands -> (список)

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

Примечание

Использование времени вычисления для этого действия повлечет дополнительные расходы в CodeBuild.

(строка)

outputArtifacts -> (список)

Имя или идентификатор результата объявления действия, например, артефакта теста или сборки.

(структура)

Представляет информацию об выходе действия.

name -> (строка)

Название вывода артефакта, например, «Моё приложение».

Имена выходных артефактов должны быть уникальными в пределах конвейера.

files -> (список)

Файлы, которые вы хотите связать с выходным артефактом, который будет экспортирован из действия вычисления.

(строка)

inputArtifacts -> (список)

Имя или идентификатор артефакта, используемого действием, например, артефакт теста или сборки.

(структура)

Представляет информацию об артефакте, над которым следует работать, например, артефакте теста или сборки.

name -> (строка)

Имя артефакта, над которым необходимо работать (например, «Моё приложение»).

Артефакты — это файлы, над которыми работают действия в конвейере. Подробности параметров артефактов см. в настройках действия каждого действия. Например, входной артефакт действия источника S3 — это имя файла (или путь к файлу), и файлы обычно предоставляются как ZIP-архив. Пример имени артефакта: SampleApp_Windows.zip

outputVariables -> (список)

Список переменных, которые должны быть экспортированы из действия вычисления. Это конкретно переменные среды CodeBuild, используемые для этого действия.

(строка)

roleArn -> (строка)

ARN службы IAM, которая выполняет объявленное действие. Предполагается через roleArn для конвейера.

region -> (строка)

Регион Amazon Web Services для объявления действия, например, us-east-1.

namespace -> (строка)

Пространство имен переменных, связанное с действием. Все переменные, производимые этим действием как вывод, попадают под это пространство имен.

timeoutInMinutes -> (целое число)

Срок ожидания в минутах, который может быть применен к значению по умолчанию для срока ожидания ActionType, указанному в квотах для CodePipeline. Это атрибут доступен только для типа действия ручного утверждения.

environmentVariables -> (список)

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

(структура)

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

name -> (строка)

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

value -> (строка)

Значение переменной среды в паре ключ-значение.

type -> (строка)

Определяет тип использования значения переменной среды. Значение может быть либо PLAINTEXT , либо SECRETS_MANAGER . Если значение SECRETS_MANAGER , укажите ссылку на секреты в значении EnvironmentVariable.

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

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

result -> (строка)

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

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

Настройка повторных попыток определяет автоматические повторные попытки для неудачного этапа вместе с настроенным режимом повторных попыток.

retryMode -> (строка)

Метод, который вы хотите настроить для автоматического повторения этапа при сбое этапа. Вы можете указать повтор только для неудачного действия на этапе или всех действий на этапе.

conditions -> (список)

Установленные условия как условия сбоя. Дополнительная информация о условиях доступна в разделе Условия этапа и Как работают условия этапа?.

(структура)

Условие для этапа. Условие состоит из правил и результата для условия. Дополнительная информация о условиях доступна в разделе Условия этапа и Как работают условия этапа?. Дополнительная информация о правилах доступна в справке по правилам CodePipeline.

result -> (строка)

Действие, которое будет выполнено, когда условие будет соблюдено. Например, откат выполнения при условии сбоя.

rules -> (список)

Правила, составляющие условие.

(структура)

Представляет информацию о правиле, которое нужно создать для связанного условия. Примером может служить создание нового правила для условия входа, например, правила, проверяющего результат теста перед допуском запуска на этап развертывания. Дополнительная информация о условиях доступна в разделе Условия этапа и Как работают условия этапа?. Дополнительная информация о правилах доступна в справке по правилам CodePipeline.

name -> (строка)

Имя правила, созданного для условия, например, VariableCheck.

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

Идентификатор типа правила, который состоит из объединенных значений категории, владельца, поставщика и версии.

category -> (строка)

owner -> (строка)

Создатель вызываемого правила. Допустимое значение для поля Owner в категории правила — AWS.

provider -> (строка)

Поставщик правил, например, правило DeploymentWindow. Список имен поставщиков правил см. в правилах, перечисленных в справке по правилам CodePipeline.

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Команды оболочки для выполнения правила команд в CodePipeline. Поддерживаются все команды, кроме многострочных форматов. Хотя используются журналы и разрешения CodeBuild, создавать ресурсы в CodeBuild не нужно.

Примечание

Использование времени вычисления для этого действия повлечет дополнительные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

Представляет информацию об артефакте, над которым следует работать, например, артефакте теста или сборки.

name -> (строка)

Имя артефакта, над которым необходимо работать (например, «Моё приложение»).

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Срок ожидания действия для правила.

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

Метод, используемый при успешном выполнении этапа. Например, настройка этого поля для условий позволит этапу завершиться успешно при выполнении условий.

conditions -> (список)

Условия, являющиеся условиями успеха.

(структура)

Условие для этапа. Условие состоит из правил и результата для условия. Более подробная информация об условиях доступна в разделе Условия этапа и Как работают условия этапов?. Более подробная информация о правилах доступна в Справочнике по правилам CodePipeline.

result -> (строка)

Действие, выполняемое при выполнении условия. Например, откат выполнения для условия ошибки.

rules -> (список)

Правила, составляющие условие.

(структура)

Представляет информацию о правиле, которое нужно создать для связанного условия. Примером может служить создание нового правила для условия входа, например, правило, проверяющее результат теста перед разрешением запуска на этап развертывания. Более подробная информация об условиях доступна в разделе Условия этапа и Как работают условия этапов?. Более подробная информация о правилах доступна в Справочнике по правилам CodePipeline.

name -> (строка)

Имя правила, созданного для условия, например VariableCheck.

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

Идентификатор типа правила, состоящий из объединенных значений категории, владельца, поставщика и версии.

category -> (строка)

Категория определяет тип правила, которое может быть запущено на этапе, и ограничивает тип поставщика для правила. Допустимая категория - Rule.

owner -> (строка)

Создатель вызываемого правила. Допустимое значение для поля Owner в категории правил - AWS.

provider -> (строка)

Поставщик правил, например правило DeploymentWindow. Список имен поставщиков правил см. в Справочнике по правилам CodePipeline.

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Команды оболочки для выполнения с правилом команд в CodePipeline. Поддерживаются все команды, кроме многострочных форматов. Хотя используются журналы и разрешения CodeBuild, вам не нужно создавать какие-либо ресурсы в CodeBuild.

Примечание

Использование времени вычислений для этого действия повлечет отдельные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

Представляет информацию об артефакте, над которым нужно работать, например, артефакт теста или сборки.

name -> (строка)

Имя артефакта, над которым нужно работать (например, «My App»).

Артефакты — это файлы, над которыми работают действия в конвейере. Подробности о параметрах артефактов см. в конфигурации каждого действия. Например, входной артефакт действия источника S3 — это имя файла (или путь к файлу), а файлы обычно предоставляются в виде ZIP-архива. Пример имени артефакта: SampleApp_Windows.zip

Входной артефакт действия должен точно соответствовать выходному артефакту, объявленному в предыдущем действии, но входной артефакт не обязательно должен быть следующим действием в строгой последовательности от действия, которое предоставило выходной артефакт. Действия в параллели могут объявлять разные выходные артефакты, которые в свою очередь используются различными последующими действиями.

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Таймаут действия для правила.

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

Метод, используемый, когда этап разрешает вход. Например, настройка этого поля для условий позволит войти на этап при выполнении условий.

conditions -> (список)

Условия, настроенные как условия входа.

(структура)

result -> (строка)

Действие, выполняемое при выполнении условия. Например, откат выполнения для условия ошибки.

rules -> (список)

Правила, составляющие условие.

(структура)

name -> (строка)

Имя правила, созданного для условия, например VariableCheck.

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

Идентификатор типа правила, состоящий из объединенных значений категории, владельца, поставщика и версии.

category -> (строка)

owner -> (строка)

Создатель вызываемого правила. Допустимое значение для поля Owner в категории правил - AWS.

provider -> (строка)

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

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

key -> (строка)

value -> (строка)

commands -> (список)

Примечание

Использование времени вычислений для этого действия повлечет отдельные расходы в CodeBuild.

(строка)

inputArtifacts -> (список)

Поля входных артефактов для правила, например, указание входного файла для правила.

(структура)

Представляет информацию об артефакте, над которым нужно работать, например, артефакт теста или сборки.

name -> (строка)

Имя артефакта, над которым нужно работать (например, «My App»).

roleArn -> (строка)

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

region -> (строка)

Регион для условия, связанного с правилом.

timeoutInMinutes -> (целое число)

Таймаут действия для правила.

version -> (целое число)

Номер версии конвейера. У нового конвейера всегда номер версии 1. Этот номер увеличивается при обновлении конвейера.

executionMode -> (строка)

pipelineType -> (строка)

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

Конвейеры типа V1 имеют JSON-структуру, которая содержит стандартные параметры конвейера, этапа и действия.
Конвейеры типа V2 имеют такую же структуру, как конвейеры типа V1, а также дополнительные параметры для обеспечения безопасности выпуска и настройки триггера.

Предупреждение

Включение параметров V2, таких как триггеры по тегам Git, в JSON-конвейер при создании или обновлении конвейера приведет к тому, что конвейер будет иметь тип конвейера V2 и соответствующие затраты.

Информация о ценообразовании для CodePipeline доступна на странице Цены.

Информация о выборе типа конвейера доступна в разделе Какой тип конвейера подходит мне?.

variables -> (список)

Список, определяющий переменные конвейера для ресурса конвейера. Имена переменных могут содержать алфавитно-цифровые символы и символы подчеркивания, а значения должны соответствовать [A-Za-z0-9@\-_]+.

(структура)

Переменная, объявленная на уровне конвейера.

name -> (строка)

Имя переменной на уровне конвейера.

defaultValue -> (строка)

Значение переменной на уровне конвейера.

description -> (строка)

Описание переменной на уровне конвейера. Используется для добавления дополнительного контекста о переменной, и не используется во время выполнения конвейера.

triggers -> (список)

Конфигурация триггера, определяющая тип события, такого как метки Git, запускающего конвейер.

Примечание

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

(структура)

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

Примечание

Это поддерживается только для типа действия CodeStarSourceConnection.

Примечание

providerType -> (строка)

Источник поставщика событий, такой как подключения, настроенные для репозитория с метками Git, для указанной конфигурации триггера.

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

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

sourceActionName -> (строка)

Имя действия источника конвейера, где задана конфигурация триггера, например, метки Git. Конфигурация триггера запустит конвейер при указанном изменении.

Примечание

Вы можете указать только одну конфигурацию триггера на действие источника.

push -> (список)

Поле, где задаётся событие репозитория, которое запустит конвейер, например, отправка меток Git, с деталями.

(структура)

Критерии события, определяющие, когда указанное событие репозитория запустит конвейер для заданной конфигурации триггера, например, списки меток Git для включения и исключения.

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

Поле, содержащее детали конфигурации триггера меток Git.

includes -> (список)

Список шаблонов меток Git, которые при отправке должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов меток Git, которые при отправке должны исключаться из запуска конвейера.

(строка)

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

Поле, задающее фильтрацию по ветвям для конфигурации триггера push.

includes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны исключаться из запуска конвейера.

(строка)

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

Поле, задающее фильтрацию по путям файлов для конфигурации триггера push.

includes -> (список)

(строка)

excludes -> (список)

(строка)

pullRequest -> (список)

Поле, где событие репозитория, которое запустит конвейер, задаётся как запросы на вытягивание.

(структура)

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

Следующие значения допустимы для событий для этого фильтра:

CLOSED
OPEN
UPDATED

events -> (список)

(строка)

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

Поле, задающее фильтрацию по ветвям для конфигурации триггера запроса на вытягивание.

includes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны включаться как критерии запуска конвейера.

(строка)

excludes -> (список)

Список шаблонов ветвей Git, которые при отправке коммита должны исключаться из запуска конвейера.

(строка)

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

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

includes -> (список)

(строка)

excludes -> (список)

(строка)

tags -> (список)

Указывает метки, применённые к конвейеру.

(структура)

Метка — это пара ключ-значение, используемая для управления ресурсом.

key -> (строка)

Ключ метки.

value -> (строка)

Значение метки.

END_OF_DOCUMENT_MARKER