[ aws . codepipeline ]
создание типа пользовательского действия
Описание
Создает новое пользовательское действие, которое может использоваться во всех конвейерах, связанных с учетной записью Amazon Web Services. Используется только для пользовательских действий.
См. также: Документацию API AWS
Синтаксис
create-custom-action-type
--category <value>
--provider <value>
[--settings <value>]
[--configuration-properties <value>]
--input-artifact-details <value>
--output-artifact-details <value>
[--tags <value>]
--action-version <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]
Параметры
--category (строка)
Категория пользовательского действия, например, действие сборки или действия тестирования.
Возможные значения:
SourceBuildDeployTestInvokeApprovalCompute
--provider (строка)
--settings (структура)
URL-адреса, предоставляющие пользователям информацию об этом пользовательском действии.
thirdPartyConfigurationUrl -> (строка)
entityUrlTemplate -> (строка)
executionUrlTemplate -> (строка)
revisionUrlTemplate -> (строка)
Сокращенный синтаксис:
thirdPartyConfigurationUrl=string,entityUrlTemplate=string,executionUrlTemplate=string,revisionUrlTemplate=string
Синтаксис JSON:
{
"thirdPartyConfigurationUrl": "string",
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string"
}
--configuration-properties (список)
Свойства конфигурации для пользовательского действия.
Примечание
Вы можете ссылаться на имя в свойствах конфигурации пользовательского действия в шаблонах URL, следуя формату {Config:имя}, при условии, что свойство конфигурации является обязательным и не является секретным. Для получения дополнительной информации см. Создание пользовательского действия для конвейера.(структура)
Представляет информацию о свойстве конфигурации действия.
name -> (строка)
required -> (булево)
key -> (булево)
secret -> (булево)
Является ли свойство конфигурации секретным. Секреты скрыты от всех вызовов, кроме GetJobDetails , GetThirdPartyJobDetails , PollForJobs и PollForThirdPartyJobs .
При обновлении конвейера передача * * * * * без изменения других значений действия сохраняет предыдущее значение секрета.
queryable -> (булево)
Указывает, что свойство используется с PollForJobs . При создании пользовательского действия действие может иметь не более одного запросимого свойства. Если оно есть, то это свойство должно быть обязательным и не секретным.
Если вы создаете конвейер с типом пользовательского действия, и это пользовательское действие содержит запросимое свойство, значение этого свойства конфигурации ограничено. Значение должно быть меньше или равно двадцати (20) символам. Значение может содержать только буквенно-цифровые символы, подчеркивания и дефисы.
description -> (строка)
type -> (строка)
Сокращенный синтаксис:
name=string,required=boolean,key=boolean,secret=boolean,queryable=boolean,description=string,type=string ...
Синтаксис JSON:
[
{
"name": "string",
"required": true|false,
"key": true|false,
"secret": true|false,
"queryable": true|false,
"description": "string",
"type": "String"|"Number"|"Boolean"
}
...
]
--input-artifact-details (структура)
Подробности входного артефакта для действия, например, его идентификатор коммита.
minimumCount -> (целое число)
maximumCount -> (целое число)
Сокращенный синтаксис:
minimumCount=integer,maximumCount=integer
Синтаксис JSON:
{
"minimumCount": integer,
"maximumCount": integer
}
--output-artifact-details (структура)
Подробности выходного артефакта действия, например, его идентификатор коммита.
minimumCount -> (целое число)
maximumCount -> (целое число)
Сокращенный синтаксис:
minimumCount=integer,maximumCount=integer
Синтаксис JSON:
{
"minimumCount": integer,
"maximumCount": integer
}
--tags (список)
Теги пользовательского действия.
(структура)
Тег — это пара ключ-значение, используемая для управления ресурсом.
key -> (строка)
value -> (строка)
Сокращенный синтаксис:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "string",
"value": "string"
}
...
]
--action-version (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который может использоваться в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включение отладки логов.
--endpoint-url (строка)
Переопределение стандартного URL команды указанным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключение автоматической постраничной навигации. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- включено
- выключено
- автоматически
--no-sign-request (булево)
Отказ от подписи запросов. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с пакетом сертификатов 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.
Создание пользовательского действия
В этом примере создается пользовательское действие для AWS CodePipeline с использованием уже созданного JSON-файла (здесь MyCustomAction.json), содержащего структуру пользовательского действия. Для получения дополнительной информации о требованиях к созданию пользовательского действия, включая структуру файла, см. Руководство пользователя AWS CodePipeline.
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
Содержимое JSON-файла MyCustomAction.json:
{
"category": "Build",
"provider": "MyJenkinsProviderName",
"version": "1",
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
},
"configurationProperties": [
{
"name": "MyJenkinsExampleBuildProject",
"required": true,
"key": true,
"secret": false,
"queryable": false,
"description": "The name of the build project must be provided when this action is added to the pipeline.",
"type": "String"
}
],
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
}
}
Эта команда возвращает структуру пользовательского действия.
Вывод
actionType -> (структура)
Возвращает информацию о деталях типа действия.
id -> (структура)
Представляет информацию о типе действия.
category -> (строка)
Категория определяет, какой тип действия может быть выполнен на этапе, и ограничивает тип поставщика для действия. Допустимые категории ограничены одним из следующих значений.
- Источник
- Сборка
- Тестирование
- Развертывание
- Вызов
- Утверждение
- Вычисление
owner -> (строка)
Owner в разделе категории действия в структуре вашей конвейерной линии: AWS , ThirdParty , и Custom . Дополнительную информацию см. в разделе «Действительные типы и поставщики действий в CodePipeline».provider -> (строка)
CodeDeploy . Дополнительную информацию см. в разделе «Действительные типы и поставщики действий в CodePipeline».version -> (строка)
settings -> (структура)
Настройки типа действия.
thirdPartyConfigurationUrl -> (строка)
entityUrlTemplate -> (строка)
executionUrlTemplate -> (строка)
revisionUrlTemplate -> (строка)
actionConfigurationProperties -> (список)
Свойства конфигурации для типа действия.
(структура)
Представляет информацию о свойстве конфигурации действия.
name -> (строка)
required -> (булево)
key -> (булево)
secret -> (булево)
Является ли свойство конфигурации секретным. Секреты скрыты от всех вызовов, кроме GetJobDetails , GetThirdPartyJobDetails , PollForJobs и PollForThirdPartyJobs .
При обновлении конвейера передача * * * * * без изменения других значений действия сохраняет предыдущее значение секрета.
queryable -> (булево)
Указывает, что свойство используется с PollForJobs . При создании пользовательского действия действие может иметь не более одного запросимого свойства. Если оно есть, это свойство должно быть как обязательным, так и не секретным.
Если вы создаете конвейер с пользовательским типом действия, и это пользовательское действие содержит запросимое свойство, значение этого свойства конфигурации подчиняется другим ограничениям. Значение должно быть меньше или равно двадцати (20) символов. Значение может содержать только буквенно-цифровые символы, символы подчеркивания и дефисы.
description -> (строка)
type -> (строка)
inputArtifactDetails -> (структура)
Подробности входного артефакта для действия, такие как его идентификатор коммита.
minimumCount -> (целое число)
maximumCount -> (целое число)
outputArtifactDetails -> (структура)
Подробности выходного артефакта действия, такие как его идентификатор коммита.
minimumCount -> (целое число)
maximumCount -> (целое число)
tags -> (список)
Указывает теги, примененные к пользовательскому действию.
(структура)
Тег — это пара «ключ-значение», используемая для управления ресурсом.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.