обновить-пайплайн

Описание

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

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

Синтаксис

  update-pipeline
--pipeline <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 -> (строка)

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

Примечание

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

type -> (строка)

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

artifactStores -> (отображение)

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

Примечание

key -> (строка)

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

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

Примечание

type -> (строка)

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

location -> (строка)

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

id -> (строка)

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

Примечание

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 «Справочник по свойствам конфигурации». Примеры фрагментов шаблонов см. в справочнике пользователя CloudFormation «Использование функций параметризации с конвейерами CodePipeline».

Значения могут быть представлены в формате 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 -> (список)

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

(структура)

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

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

CLOSED
OPEN
UPDATED

events -> (список)

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

(строка)

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

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

includes -> (список)

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

(строка)

excludes -> (список)

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

(строка)

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

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

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", ...]
            }
          }
          ...
        ]
      }
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено значение null или значение 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
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

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

Примеры

Примечание

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

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

Для обновления структуры конвейера

В этом примере используется команда update-pipeline с аргументом –cli-input-json. В этом примере используется предварительно определённый JSON-файл (MyFirstPipeline.json) для обновления структуры конвейера. AWS CodePipeline распознаёт имя конвейера, содержащееся в JSON-файле, а затем применяет любые изменения от изменённых полей в структуре конвейера для обновления конвейера.

Следуйте этим рекомендациям при создании предварительно определённого JSON-файла:

Если вы работаете со структурой конвейера, полученной с помощью команды get-pipeline, вы должны удалить секцию метаданных из структуры конвейера в JSON-файле (строки «metadata»: { } и поля «created», «pipelineARN» и «updated» внутри).
Имя конвейера изменить нельзя.

Команда:

aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.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-bucket2",
            "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": "MyFirstPipeline",
  "version": 1
 }
}

Вывод:

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

Вывод

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

Структура обновленного конвейера.

name -> (строка)

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

roleArn -> (строка)

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

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

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

Примечание

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

type -> (строка)

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

location -> (строка)

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

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

id -> (строка)

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

Примечание

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

type -> (строка)

Тип ключа шифрования, например, ключ KMS Amazon Web Services. При создании или обновлении конвейера значение должно быть установлено в «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:

"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 , укажите ссылку на Secrets в значении 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 -> (список)

Примечание

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

(строка)

inputArtifacts -> (список)

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

(структура)

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

name -> (строка)

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

Артефакты — это файлы, над которыми работают действия в конвейере. Подробные сведения об параметрах артефактов см. в конфигурации каждого действия. Например, входной артефакт действия источника 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 -> (строка)

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

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

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 -> (структура)

sourceActionName -> (строка)

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

Примечание

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

push -> (список)

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

(структура)

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

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

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

includes -> (список)

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

(строка)

excludes -> (список)

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

(строка)

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

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

includes -> (список)

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

(строка)

excludes -> (список)

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

(строка)

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

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

includes -> (список)

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

(строка)

excludes -> (список)

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

(строка)

pullRequest -> (список)

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

(структура)

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

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

ЗАКРЫТО
ОТКРЫТО
ОБНОВЛЕНО

events -> (список)

Поле, указывающее, какие события запросов на вытягивание следует отфильтровать (ОТКРЫТО, ОБНОВЛЕНО, ЗАКРЫТО) для настройки триггера.

(строка)

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

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

includes -> (список)

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

(строка)

excludes -> (список)

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

(строка)

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

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

includes -> (список)

(строка)

excludes -> (список)

(строка)