Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

batch-get-projects

Описание

Получает информацию об одном или нескольких проектах сборки.

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

Синтаксис

  batch-get-projects
--names <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]

Параметры

--names (список)

Имена или ARN проектов сборки. Чтобы получить информацию о проекте, используемом вашей учетной записью Amazon Web Services, необходимо указать его ARN. Вы не можете указать общий проект по имени.

(строка)

Синтаксис:

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

Переопределить адрес по умолчанию команды заданным адресом.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-потоковый

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы дословно. При предоставлении содержимого из файла, который отображается на двоичный блок fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинатор cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

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

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

Для получения списка имен проектов сборки AWS CodeBuild.

Следующий batch-get-projects пример получает список проектов сборки CodeBuild, указанных по имени.

aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project

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

{
    "projectsNotFound": [],
    "projects": [
        {
            "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
            "name": "codebuild-demo-project2",
            "queuedTimeoutInMinutes": 480,
            "timeoutInMinutes": 60,
            "source": {
                "buildspec": "version: 0.2\n\n#env:\n  #variables:\n     # key: \"value\"\n     # key: \"value\"\n  #parameter-store:\n     # key: \"value\"\n     # key:\"value\"\n\nphases:\n  #install:\n    #commands:\n      # - command\n      # - command\n  #pre_build:\n    #commands:\n      # - command\n      # - command\n  build:\n    commands:\n      # - command\n      # - command\n  #post_build:\n    #commands:\n      # - command\n      # - command\n#artifacts:\n  #files:\n    # - location\n    # - location\n  #name: $(date +%Y-%m-%d)\n  #discard-paths: yes\n  #base-directory: location\n#cache:\n  #paths:\n    # - paths",
                "type": "NO_SOURCE",
                "insecureSsl": false,
                "gitCloneDepth": 1
            },
            "artifacts": {
                "type": "NO_ARTIFACTS"
            },
            "badge": {
                "badgeEnabled": false
            },
            "lastModified": 1540588091.108,
            "created": 1540588091.108,
            "arn": "arn:aws:codebuild:us-west-2:123456789012:project/test-for-sample",
            "secondarySources": [],
            "secondaryArtifacts": [],
            "cache": {
                "type": "NO_CACHE"
            },
            "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-test-role",
            "environment": {
                "image": "aws/codebuild/java:openjdk-8",
                "privilegedMode": true,
                "type": "LINUX_CONTAINER",
                "computeType": "BUILD_GENERAL1_SMALL",
                "environmentVariables": []
            },
            "tags": []
        },
        {
            "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
            "name": "my-other-demo-project",
            "queuedTimeoutInMinutes": 480,
            "timeoutInMinutes": 60,
            "source": {
                "location": "https://github.com/iversonic/codedeploy-sample.git",
                "reportBuildStatus": false,
                "buildspec": "buildspec.yml",
                "insecureSsl": false,
                "gitCloneDepth": 1,
                "type": "GITHUB",
                "auth": {
                    "type": "OAUTH"
                }
            },
            "artifacts": {
                "type": "NO_ARTIFACTS"
            },
            "badge": {
                "badgeEnabled": false
            },
            "lastModified": 1523401711.73,
            "created": 1523401711.73,
            "arn": "arn:aws:codebuild:us-west-2:123456789012:project/Project2",
            "cache": {
                "type": "NO_CACHE"
            },
            "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-Project2-service-role",
            "environment": {
                "image": "aws/codebuild/nodejs:4.4.7",
                "privilegedMode": false,
                "type": "LINUX_CONTAINER",
                "computeType": "BUILD_GENERAL1_SMALL",
                "environmentVariables": []
            },
            "tags": []
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр подробностей проекта сборки (AWS CLI) в Руководстве пользователя AWS CodeBuild.

Вывод

projects -> (список)

Информация о запрошенных проектах сборки.

(структура)

Информация о проекте сборки.

name -> (строка)

Имя проекта сборки.

arn -> (строка)

Amazon Resource Name (ARN) проекта сборки.

description -> (строка)

Описание, облегчающее идентификацию проекта сборки.

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

Информация о коде исходного кода проекта сборки.

type -> (строка)

Тип репозитория, содержащего исходный код для сборки. Допустимые значения:

  • BITBUCKET : Исходный код находится в репозитории Bitbucket.
  • CODECOMMIT : Исходный код находится в репозитории CodeCommit.
  • CODEPIPELINE : Параметры исходного кода указаны в действии источника конвейера CodePipeline.
  • GITHUB : Исходный код находится в репозитории GitHub.
  • GITHUB_ENTERPRISE : Исходный код находится в репозитории GitHub Enterprise Server.
  • GITLAB : Исходный код находится в репозитории GitLab.
  • GITLAB_SELF_MANAGED : Исходный код находится в управляемом пользователем репозитории GitLab.
  • NO_SOURCE : Проект не имеет исходного кода.
  • S3 : Исходный код находится в ведре Amazon S3.

location -> (строка)

Информация о расположении исходного кода для сборки. Допустимые значения:

  • Для параметров исходного кода, указанных в действии источника конвейера CodePipeline, location не должен быть указан. Если он указан, CodePipeline его игнорирует. Это потому, что CodePipeline использует настройки действия источника конвейера вместо этого значения.
  • Для исходного кода в репозитории CodeCommit, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec (например, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
  • Для исходного кода в ведре Amazon S3, одно из следующих.
    • Путь к файлу ZIP, содержащему исходный код (например, <bucket-name>/<path>/<object-name>.zip).
    • Путь к папке, содержащей исходный код (например, <bucket-name>/<path-to-source-code>/<folder>/).
  • Для исходного кода в репозитории GitHub, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitHub. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitHub в окне GitHub Авторизовать приложение для Доступ к организации выберите Запросить доступ рядом с каждым репозиторием, которому вы хотите предоставить CodeBuild доступ, а затем выберите Авторизовать приложение. (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете покинуть консоль CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth type на OAUTH.
  • Для исходного кода в репозитории GitLab или управляемом пользователем репозитории GitLab, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitLab в окне подключений Авторизовать приложение выберите Авторизовать. Затем на странице CodeConnections Создать подключение GitLab выберите Подключиться к GitLab. (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете покинуть консоль CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение объекта auth type на CODECONNECTIONS в объекте source.
  • Для исходного кода в репозитории Bitbucket, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к Bitbucket в окне Bitbucket Подтвердить доступ к вашей учетной записи выберите Предоставить доступ. (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете покинуть консоль CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth type на OAUTH.

Если вы укажите CODEPIPELINE для свойства Type, не указывайте это свойство. Для всех других типов вы должны указать Location.

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

Информация о глубине клонирования Git для проекта сборки.

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

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

fetchSubmodules -> (булево)

Установите в значение true, чтобы получить подмодули Git для вашего проекта сборки CodeBuild.

buildspec -> (строка)

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

Если это значение задано, оно может быть либо встроенным определением buildspec, путем к альтернативному файлу buildspec, относительно значения встроенной переменной среды CODEBUILD_SRC_DIR, либо путем к ведру S3. Ведро должно находиться в той же области Amazon Web Services, что и проект сборки. Укажите файл buildspec, используя его ARN (например, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). Если это значение не указано или установлено в пустую строку, исходный код должен содержать файл buildspec в корневом каталоге. Дополнительная информация: Имя и расположение файла buildspec .

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

Информация об установках авторизации для CodeBuild для доступа к исходному коду для сборки.

type -> (строка)

Тип авторизации для использования. Допустимые варианты: OAUTH, CODECONNECTIONS или SECRETS_MANAGER.

resource -> (строка)

Значение ресурса, применимое к указанному типу авторизации.

reportBuildStatus -> (булево)

Установите в значение true, чтобы сообщать о состоянии запуска и завершения сборки вашему поставщику исходного кода. Этот параметр действителен только тогда, когда вашим поставщиком исходного кода является GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, GitLab, GitLab Self Managed или Bitbucket. Если это установлено, и вы используете другого поставщика исходного кода, будет выброшено сообщение об ошибке invalidInputException.

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

Статус сборки, инициированной веб-хуком, всегда сообщается вашему поставщику исходного кода.

Если сборки вашего проекта инициируются веб-хуком, вы должны внести новые изменения в репозиторий для применения изменений в этом свойстве.

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

Содержит информацию, определяющую, как проект сборки сообщает о статусе сборки поставщику исходного кода. Этот параметр используется только когда поставщиком исходного кода является GITHUB , GITHUB_ENTERPRISE или BITBUCKET.

context -> (строка)

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

Bitbucket

Этот параметр используется для параметра name в статусе коммита Bitbucket. Дополнительная информация в документации API Bitbucket по build.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра context в статусе коммита GitHub. Дополнительная информация в руководстве разработчика GitHub по созданию статуса коммита.

targetUrl -> (строка)

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

Bitbucket

Этот параметр используется для параметра url в статусе коммита Bitbucket. Дополнительная информация в документации API Bitbucket по build.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра target_url в статусе коммита GitHub. Дополнительная информация в руководстве разработчика GitHub по созданию статуса коммита.

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

Идентификатор источника проекта. Идентификатор может содержать только буквенно-цифровые символы и символы подчеркивания, и должен быть меньше 128 символов.

secondarySources -> (список)

Массив объектов ProjectSource.

(структура)

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

тип -> (строка)

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

  • BITBUCKET : Исходный код находится в репозитории Bitbucket.
  • CODECOMMIT : Исходный код находится в репозитории CodeCommit.
  • CODEPIPELINE : Настройки исходного кода указаны в действии «исходный код» конвейера CodePipeline.
  • GITHUB : Исходный код находится в репозитории GitHub.
  • GITHUB_ENTERPRISE : Исходный код находится в репозитории GitHub Enterprise Server.
  • GITLAB : Исходный код находится в репозитории GitLab.
  • GITLAB_SELF_MANAGED : Исходный код находится в управляемом пользователем репозитории GitLab.
  • NO_SOURCE : Проект не содержит входного исходного кода.
  • S3 : Исходный код находится в ведре Amazon S3.

местоположение -> (строка)

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

  • Для настроек исходного кода, указанных в действии «исходный код» конвейера CodePipeline, значение location не должно быть указано. Если оно указано, CodePipeline его игнорирует. Это связано с тем, что CodePipeline использует настройки действия «исходный код» конвейера вместо этого значения.
  • Для исходного кода в репозитории CodeCommit, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec (например, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name> ).
  • Для исходного кода во входном ведре Amazon S3, одно из следующих.
    • Путь к файлу ZIP, содержащему исходный код (например, <bucket-name>/<path>/<object-name>.zip ).
    • Путь к папке, содержащей исходный код (например, <bucket-name>/<path-to-source-code>/<folder>/ ).
  • Для исходного кода в репозитории GitHub, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitHub. Используйте консоль CodeBuild для начала создания проекта сборки. При использовании консоли для подключения (или повторного подключения) к GitHub, на странице GitHub Авторизовать приложение, для Доступа к организации выберите Запросить доступ рядом с каждым репозиторием, которому вы хотите предоставить доступ CodeBuild, а затем выберите Авторизовать приложение . (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете закрыть консоль CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth type в OAUTH .
  • Для исходного кода в репозитории GitLab или управляемом пользователем репозитории GitLab, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При использовании консоли для подключения (или повторного подключения) к GitLab, на странице Подключения Авторизовать приложение, выберите Авторизовать. Затем на странице CodeConnections Создать подключение GitLab выберите Подключиться к GitLab . (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете закрыть консоль CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение объекта auth type в CODECONNECTIONS в объекте source.
  • Для исходного кода в репозитории Bitbucket, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При использовании консоли для подключения (или повторного подключения) к Bitbucket, на странице Bitbucket Подтвердите доступ к вашей учетной записи, выберите Предоставить доступ. (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете закрыть консоль CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth type в OAUTH .

Если вы указываете CODEPIPELINE для свойства Type, не указывайте это свойство. Для всех остальных типов необходимо указать Location .

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

Информация о глубине клонирования Git для проекта сборки.

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

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

fetchSubmodules -> (булево)

Установите в значение true, чтобы получить подмодули Git для вашего проекта сборки CodeBuild.

buildspec -> (строка)

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

Если это значение задано, оно может представлять собой встроенное определение buildspec, путь к альтернативному файлу buildspec, относительно значения встроенной переменной среды CODEBUILD_SRC_DIR, или путь к ведру S3. Ведро должно находиться в той же области Amazon Web Services, что и проект сборки. Укажите файл buildspec, используя его ARN (например, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). Если это значение не указано или установлено в пустую строку, исходный код должен содержать файл buildspec в корневой директории. Дополнительную информацию см. в разделе «Имя и расположение файла buildspec».

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

Информация о настройках авторизации для доступа CodeBuild к исходному коду, подлежащему сборке.

тип -> (строка)

Тип авторизации для использования. Допустимые варианты: OAUTH, CODECONNECTIONS или SECRETS_MANAGER.

ресурс -> (строка)

Значение ресурса, применяемое к указанному типу авторизации.

reportBuildStatus -> (булево)

Установите в значение true, чтобы сообщать о статусе начала и завершения сборки вашему поставщику исходного кода. Этот параметр допустим только в том случае, если ваш поставщик исходного кода GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, GitLab или Bitbucket. Если он установлен, и вы используете другого поставщика исходного кода, будет выброшено исключение invalidInputException.

Чтобы иметь возможность сообщать о статусе сборки поставщику исходного кода, пользователю, связанному с поставщиком исходного кода, должен быть предоставлен доступ для записи в репозиторий. Если у пользователя нет доступа для записи, статус сборки не может быть обновлён. Дополнительную информацию см. в разделе «Доступ к поставщику исходного кода» в руководстве пользователя CodeBuild.

Статус сборки, инициированной веб-хуком, всегда сообщается вашему поставщику исходного кода.

Если сборки вашего проекта инициируются веб-хуком, для вступления в силу изменений этого параметра необходимо внести новую коммитацию в репозиторий.

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

Содержит информацию, определяющую, как проект сборки сообщает о статусе сборки поставщику исходного кода. Этот параметр используется только в том случае, если поставщик исходного кода GITHUB, GITHUB_ENTERPRISE или BITBUCKET.

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

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

Bitbucket

Этот параметр используется для параметра name в статусе коммита Bitbucket. Дополнительную информацию см. в документации к API Bitbucket.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра context в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub.

targetUrl -> (строка)

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

Bitbucket

Этот параметр используется для параметра url в статусе коммита Bitbucket. Дополнительную информацию см. в документации к API Bitbucket.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра target_url в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub.

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

Идентификатор исходного кода этого проекта. Идентификатор может содержать только буквенно-цифровые символы и символы нижнего подчеркивания, и должен быть меньше 128 символов в длину.

sourceVersion -> (строка)

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

  • Для CodeCommit: идентификатор коммита, ветка или Git-тег для использования.
  • Для GitHub: идентификатор коммита, идентификатор запроса на вытягивание, имя ветки или имя тега, соответствующее версии исходного кода, которую вы хотите собрать. Если указан идентификатор запроса на вытягивание, он должен иметь формат pr/pull-request-ID (например, pr/25). Если указано имя ветки, используется идентификатор HEAD коммита ветки. Если не указано, используется идентификатор HEAD коммита ветки по умолчанию.
  • Для GitLab: идентификатор коммита, ветка или Git-тег для использования.
  • Для Bitbucket: идентификатор коммита, имя ветки или имя тега, соответствующее версии исходного кода, которую вы хотите собрать. Если указано имя ветки, используется идентификатор HEAD коммита ветки. Если не указано, используется идентификатор HEAD коммита ветки по умолчанию.
  • Для Amazon S3: идентификатор версии объекта, представляющего файл ZIP входного кода для использования.

Если sourceVersion указано на уровне сборки, эта версия имеет приоритет над этой sourceVersion (на уровне проекта).

Дополнительную информацию см. в примере версии исходного кода с CodeBuild в руководстве пользователя CodeBuild.

secondarySourceVersions -> (список)

Массив объектов ProjectSourceVersion. Если secondarySourceVersions указан на уровне сборки, то они переопределяют эти secondarySourceVersions (на уровне проекта).

(структура)

Идентификатор источника и соответствующая версия.

sourceIdentifier -> (строка)

Идентификатор источника в проекте сборки. Идентификатор может содержать только буквенно-цифровые символы и символы нижнего подчеркивания, и должен быть меньше 128 символов.

sourceVersion -> (строка)

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

  • Для CodeCommit: идентификатор коммита, ветка или Git тег для использования.
  • Для GitHub: идентификатор коммита, идентификатор pull запроса, имя ветки или имя тега, соответствующие версии исходного кода, которую вы хотите собрать. Если указан идентификатор pull запроса, он должен использовать формат pr/pull-request-ID (например, pr/25 ). Если указано имя ветки, используется идентификатор HEAD коммита ветки. Если не указано, используется идентификатор HEAD коммита ветки по умолчанию.
  • Для GitLab: идентификатор коммита, ветка или Git тег для использования.
  • Для Bitbucket: идентификатор коммита, имя ветки или имя тега, соответствующие версии исходного кода, которую вы хотите собрать. Если указано имя ветки, используется идентификатор HEAD коммита ветки. Если не указано, используется идентификатор HEAD коммита ветки по умолчанию.
  • Для Amazon S3: идентификатор версии объекта, представляющего ZIP-файл входных данных сборки для использования.

Для получения дополнительной информации см. Пример версии источника с CodeBuild в руководстве пользователя CodeBuild.

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

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

type -> (строка)

Тип выходного артефакта сборки. Допустимые значения включают:

  • CODEPIPELINE : Проект сборки создал выходные данные через CodePipeline.

Примечание

Тип CODEPIPELINE не поддерживается для secondaryArtifacts .
  • NO_ARTIFACTS : Проект сборки не создает выходных данных.
  • S3 : Проект сборки хранит выходные данные сборки в Amazon S3.

location -> (строка)

Информация о местоположении выходного артефакта сборки:

  • Если type установлено в CODEPIPELINE , CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет своими местами расположения выходных данных сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS , это значение игнорируется, если оно указано, так как выходные данные сборки не создаются.
  • Если type установлено в S3 , это имя выходного хранилища.

path -> (строка)

Вместе с namespaceType и name, шаблон, который CodeBuild использует для именования и хранения выходного артефакта:

  • Если type установлено в CODEPIPELINE , CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет своими именами выходных данных сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS , это значение игнорируется, если оно указано, так как выходные данные сборки не создаются.
  • Если type установлено в S3 , это путь к выходному артефакту. Если path не указано, то path не используется.

Например, если path установлено в MyArtifacts, namespaceType установлено в NONE и name установлено в MyArtifact.zip, то выходной артефакт хранится в выходном хранилище по адресу MyArtifacts/MyArtifact.zip.

namespaceType -> (строка)

Вместе с path и name, шаблон, который CodeBuild использует для определения имени и расположения для хранения выходного артефакта:

  • Если type установлено в CODEPIPELINE , CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет своими именами выходных данных сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS , это значение игнорируется, если оно указано, так как выходные данные сборки не создаются.
  • Если type установлено в S3, допустимые значения включают:
    • BUILD_ID : Включить идентификатор сборки в расположение выходного артефакта сборки.
    • NONE : Не включать идентификатор сборки. Это значение по умолчанию, если namespaceType не указано.

Например, если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID и name установлено в MyArtifact.zip, выходной артефакт хранится в MyArtifacts/<build-ID>/MyArtifact.zip.

name -> (строка)

Вместе с path и namespaceType, шаблон, который CodeBuild использует для именования и хранения выходного артефакта:

  • Если type установлено в CODEPIPELINE , CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет своими именами выходных данных сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS , это значение игнорируется, если оно указано, так как выходные данные сборки не создаются.
  • Если type установлено в S3 , это имя объекта выходного артефакта. Если вы установите имя в обратную косую черту (“/”), артефакт хранится в корне выходного хранилища.

Например:

  • Если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID и name установлено в MyArtifact.zip, то выходной артефакт хранится в MyArtifacts/<build-ID>/MyArtifact.zip.
  • Если path пустое, namespaceType установлено в NONE и name установлено в “/”, выходной артефакт хранится в корне выходного хранилища.
  • Если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID и name установлено в “/”, выходной артефакт хранится в MyArtifacts/<build-ID>.

packaging -> (строка)

Тип выходного артефакта сборки для создания:

  • Если type установлено в CODEPIPELINE , CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет своими артефактами выходных данных сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS , это значение игнорируется, если оно указано, так как выходные данные сборки не создаются.
  • Если type установлено в S3 , допустимые значения включают:
    • NONE : CodeBuild создает в выходном хранилище папку, содержащую выходные данные сборки. Это значение по умолчанию, если packaging не указано.
    • ZIP : CodeBuild создает в выходном хранилище ZIP-архив, содержащий выходные данные сборки.

overrideArtifactName -> (логическое значение)

Если этот флаг установлен, имя, указанное в файле buildspec, переопределяет имя артефакта. Имя, указанное в файле buildspec, рассчитывается во время сборки и использует Shell Command Language. Например, вы можете добавить дату и время к имени артефакта, чтобы оно всегда было уникальным.

encryptionDisabled -> (логическое значение)

Устанавливается в true, если вы не хотите шифровать свои выходные артефакты. Этот параметр допустим только если ваш тип артефактов — Amazon S3. Если он установлен с другим типом артефактов, генерируется исключение invalidInputException.

artifactIdentifier -> (строка)

Идентификатор этого определения артефакта.

bucketOwnerAccess -> (строка)

Указывает доступ владельца хранилища для объектов, которые другое учетное представление загружает в хранилище Amazon S3.

Примечание

Чтобы использовать этот параметр, ваша роль службы CodeBuild должна иметь разрешение s3:PutBucketAcl. Это разрешение позволяет CodeBuild изменять список управления доступом для хранилища.

Этот параметр может принимать следующие значения:

NONE

Владелец хранилища не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

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

FULL

Владелец хранилища имеет полный доступ к объектам. Владелец объекта определяется следующими критериями:

  • Если хранилище настроено с параметром Bucket owner preferred, владелец хранилища владеет объектами. Загружающее учетное представление будет иметь доступ к объекту, как указано в политике хранилища.
  • В противном случае, загружающее учетное представление сохраняет права собственности на объекты.

Дополнительную информацию о владении объектами Amazon S3 см. в разделе Управление правами собственности на загруженные объекты с помощью S3 Object Ownership в руководстве пользователя Amazon Simple Storage Service.

secondaryArtifacts -> (список)

Массив объектов ProjectArtifacts.

(структура)

Информация о результатах сборки проекта сборки.

тип -> (строка)

Тип результата сборки. Допустимые значения включают:

  • CODEPIPELINE : Проект сборки сгенерировал результаты сборки через CodePipeline.

Примечание

Тип CODEPIPELINE не поддерживается для secondaryArtifacts .
  • NO_ARTIFACTS : Проект сборки не производит никаких результатов сборки.
  • S3 : Проект сборки хранит результаты сборки в Amazon S3.

местоположение -> (строка)

Информация о местоположении результата сборки:

  • Если type установлено в CODEPIPELINE, CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет местоположениями результатов сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS, это значение игнорируется, если оно указано, потому что результаты сборки не производятся.
  • Если type установлено в S3, это имя выходного ведра.

путь -> (строка)

Вместе с namespaceType и name, шаблон, который CodeBuild использует для именования и хранения результата сборки:

  • Если type установлено в CODEPIPELINE, CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет именами результатов сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS, это значение игнорируется, если оно указано, потому что результаты сборки не производятся.
  • Если type установлено в S3, это путь к результату сборки. Если path не указано, path не используется.

Например, если path установлено в MyArtifacts, namespaceType установлено в NONE, и name установлено в MyArtifact.zip, результат сборки хранится в выходном ведре по адресу MyArtifacts/MyArtifact.zip.

namespaceType -> (строка)

Вместе с path и name, шаблон, который CodeBuild использует для определения имени и местоположения для хранения результата сборки:

  • Если type установлено в CODEPIPELINE, CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет именами результатов сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS, это значение игнорируется, если оно указано, потому что результаты сборки не производятся.
  • Если type установлено в S3, допустимые значения включают:
    • BUILD_ID : Включить идентификатор сборки в местоположение результата сборки.
    • NONE : Не включать идентификатор сборки. Это значение по умолчанию, если namespaceType не указано.

Например, если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID, и name установлено в MyArtifact.zip, результат сборки хранится в MyArtifacts/<build-ID>/MyArtifact.zip.

имя -> (строка)

Вместе с path и namespaceType, шаблон, который CodeBuild использует для именования и хранения результата сборки:

  • Если type установлено в CODEPIPELINE, CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет именами результатов сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS, это значение игнорируется, если оно указано, потому что результаты сборки не производятся.
  • Если type установлено в S3, это имя объекта результата сборки. Если вы зададите имя как обратный слэш («/»), результат сборки хранится в корневом каталоге выходного ведра.

Например:

  • Если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID, и name установлено в MyArtifact.zip, тогда результат сборки хранится в MyArtifacts/<build-ID>/MyArtifact.zip.
  • Если path пусто, namespaceType установлено в NONE, и name установлено в “/”, результат сборки хранится в корневом каталоге выходного ведра.
  • Если path установлено в MyArtifacts, namespaceType установлено в BUILD_ID, и name установлено в “/”, результат сборки хранится в MyArtifacts/<build-ID>.

упаковка -> (строка)

Тип результата сборки, который нужно создать:

  • Если type установлено в CODEPIPELINE, CodePipeline игнорирует это значение, если оно указано. Это потому, что CodePipeline управляет результатами сборки вместо CodeBuild.
  • Если type установлено в NO_ARTIFACTS, это значение игнорируется, если оно указано, потому что результаты сборки не производятся.
  • Если type установлено в S3, допустимые значения включают:
    • NONE : CodeBuild создает в выходном ведре папку, содержащую результаты сборки. Это значение по умолчанию, если packaging не указано.
    • ZIP : CodeBuild создает в выходном ведре ZIP-архив, содержащий результаты сборки.

переопределитьИмяРезультата -> (логическое)

Если этот флаг установлен, имя, указанное в файле buildspec, переопределяет имя результата. Имя, указанное в файле buildspec, вычисляется во время сборки и использует язык командной строки Shell. Например, вы можете добавить дату и время к имени результата, чтобы оно всегда было уникальным.

отключениеШифрования -> (логическое)

Установите в значение true, если вы не хотите шифровать свои результаты сборки. Этот параметр действителен только если тип ваших результатов — Amazon S3. Если этот параметр установлен с другим типом результатов, выбрасывается исключение invalidInputException.

идентификаторРезультата -> (строка)

Идентификатор этого определения результата.

доступВладельцаВедра -> (строка)

Указывает доступ владельца ведра для объектов, которые другой аккаунт загружает в ведро Amazon S3.

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

Примечание

Для использования этого параметра ваша роль службы CodeBuild должна иметь разрешение s3:PutBucketAcl. Это разрешение позволяет CodeBuild изменять список управления доступом для ведра.

Этот параметр может принимать следующие значения:

NONE

Владелец ведра не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

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

FULL

Владелец ведра имеет полный доступ к объектам. Владелец объекта определяется следующим критерием:

  • Если ведро настроено с параметром «Предпочтительный владелец ведра», владелец ведра владеет объектами. Загружающий аккаунт будет иметь доступ к объектам в соответствии с политикой ведра.
  • В противном случае загружающий аккаунт сохраняет право собственности на объекты.

Дополнительную информацию о владении объектами Amazon S3 см. в разделе Управление владением загруженными объектами с помощью владельца объекта S3 в руководстве пользователя Amazon Simple Storage Service.

кэш -> (структура)

Информация о кэше для проекта сборки.

тип -> (строка)

Тип кэша, используемого проектом сборки. Допустимые значения включают:

  • NO_CACHE : Проект сборки не использует кэш.
  • S3 : Проект сборки считывает и записывает данные в S3.
  • LOCAL : Проект сборки хранит кэш локально на хосте сборки, доступном только этому хосту.

местоположение -> (строка)

Информация о местоположении кэша:

  • NO_CACHE или LOCAL : Это значение игнорируется.
  • S3 : Это имя/префикс ведра S3.

режимы -> (список)

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

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

LOCAL_SOURCE_CACHE

Кэширует метаданные Git для первичных и вторичных источников. После создания кэша последующие сборки извлекают только изменения между коммитами. Этот режим хорошо подходит для проектов с чистым рабочим каталогом и исходным кодом, который представляет собой большой Git-репозиторий. Если вы выбрали этот вариант, а ваш проект не использует Git-репозиторий (GitHub, GitHub Enterprise или Bitbucket), этот вариант будет проигнорирован.

LOCAL_DOCKER_LAYER_CACHE

Кэширует существующие слои Docker. Этот режим хорошо подходит для проектов, которые собирают или извлекают большие Docker-образы. Он может предотвратить проблемы с производительностью, связанные с извлечением больших Docker-образов из сети.

Примечание

  • Вы можете использовать кэш слоёв Docker только в среде Linux.
  • Флаг privileged должен быть установлен, чтобы ваш проект имел необходимые разрешения Docker.
  • Перед использованием кэша слоёв Docker следует учитывать последствия для безопасности.

LOCAL_CUSTOM_CACHE

Кэширует каталоги, указанные вами в файле buildspec. Этот режим подходит, если ваша сценарий сборки не подходит ни под один из других трёх режимов локального кэша. Если вы используете пользовательский кэш:

  • Можно указывать только каталоги для кэширования. Нельзя указывать отдельные файлы.
  • Символьные ссылки используются для указания на кэшированные каталоги.
  • Кэшированные каталоги подключаются к вашей сборке до загрузки исходных кодов проекта. Кэшированные элементы переопределяются, если элемент исходного кода имеет то же имя. Каталоги указываются с помощью путей к кэшу в файле buildspec.

(строка)

cacheNamespace -> (строка)

Определяет область действия кэша. Вы можете использовать этот пространство имён для совместного использования кэша между несколькими проектами. Дополнительную информацию см. в разделе Общие кэши между проектами в руководстве пользователя CodeBuild.

среда -> (структура)

Информация о среде сборки для данного проекта сборки.

type -> (string)

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

Примечание

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

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

image -> (string)

Тег изображения или дайджест изображения, определяющий Docker-образ, который следует использовать для данного проекта сборки. Используйте следующие форматы:

  • Для тега изображения: <registry>/<repository>:<tag> . Например, в Docker-репозитории, который CodeBuild использует для управления своими Docker-изображениями, это будет aws/codebuild/standard:4.0 .
  • Для дайджеста изображения: <registry>/<repository>@<digest> . Например, для указания изображения с дайджестом “sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,” используйте <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf .

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

computeType -> (string)

Информация о вычислительных ресурсах, используемых проектом сборки. Доступные значения включают:

  • ATTRIBUTE_BASED_COMPUTE : Укажите количество vCPU, объем памяти, объем дискового пространства и тип машины.

Примечание

Если вы используете ATTRIBUTE_BASED_COMPUTE, вы должны определить свои атрибуты, используя computeConfiguration. CodeBuild выберет самый дешевый экземпляр, удовлетворяющий вашим указанным атрибутам. Дополнительную информацию см. в разделе Типы сред с резервируемыми ресурсами в руководстве пользователя CodeBuild.
  • BUILD_GENERAL1_SMALL : Используйте до 4 ГБ памяти и 2 vCPU для сборок.
  • BUILD_GENERAL1_MEDIUM : Используйте до 8 ГБ памяти и 4 vCPU для сборок.
  • BUILD_GENERAL1_LARGE : Используйте до 16 ГБ памяти и 8 vCPU для сборок, в зависимости от типа вашей среды.
  • BUILD_GENERAL1_XLARGE : Используйте до 72 ГБ памяти и 36 vCPU для сборок, в зависимости от типа вашей среды.
  • BUILD_GENERAL1_2XLARGE : Используйте до 144 ГБ памяти, 72 vCPU и 824 ГБ SSD-хранилища для сборок. Этот тип вычислительных ресурсов поддерживает Docker-изображения объемом до 100 ГБ без сжатия.
  • BUILD_LAMBDA_1GB : Используйте до 1 ГБ памяти для сборок. Доступно только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_2GB : Используйте до 2 ГБ памяти для сборок. Доступно только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_4GB : Используйте до 4 ГБ памяти для сборок. Доступно только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_8GB : Используйте до 8 ГБ памяти для сборок. Доступно только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_10GB : Используйте до 10 ГБ памяти для сборок. Доступно только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.

Если вы используете BUILD_GENERAL1_SMALL:

  • Для среды типа LINUX_CONTAINER, вы можете использовать до 4 ГБ памяти и 2 vCPU для сборок.
  • Для среды типа LINUX_GPU_CONTAINER, вы можете использовать до 16 ГБ памяти, 4 vCPU и 1 NVIDIA A10G Tensor Core GPU для сборок.
  • Для среды типа ARM_CONTAINER, вы можете использовать до 4 ГБ памяти и 2 vCPU на процессорах ARM для сборок.

Если вы используете BUILD_GENERAL1_LARGE:

  • Для среды типа LINUX_CONTAINER, вы можете использовать до 16 ГБ памяти и 8 vCPU для сборок.
  • Для среды типа LINUX_GPU_CONTAINER, вы можете использовать до 255 ГБ памяти, 32 vCPU и 4 NVIDIA Tesla V100 GPU для сборок.
  • Для среды типа ARM_CONTAINER, вы можете использовать до 16 ГБ памяти и 8 vCPU на процессорах ARM для сборок.

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

computeConfiguration -> (structure)

Настройка вычислительных ресурсов проекта сборки. Требуется только если computeType установлено в ATTRIBUTE_BASED_COMPUTE.

vCpu -> (long)

Количество vCPU типа экземпляра, включенного в ваш флот.

memory -> (long)

Объем памяти типа экземпляра, включенного в ваш флот.

disk -> (long)

Объем дискового пространства типа экземпляра, включенного в ваш флот.

machineType -> (string)

Тип машины типа экземпляра, включенного в ваш флот.

instanceType -> (string)

Тип EC2-экземпляра, который должен быть запущен в вашем флоте.

fleet -> (structure)

Объект ProjectFleet для использования в данном проекте сборки.

fleetArn -> (string)

Указывает ARN вычислительного флота для проекта сборки.

environmentVariables -> (list)

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

(structure)

Информация о переменной среды для проекта сборки или сборки.

name -> (string)

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

value -> (string)

Значение переменной среды.

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

Мы настоятельно не рекомендуем использовать PLAINTEXT переменные среды для хранения конфиденциальных значений, особенно идентификаторов секретных ключей Amazon Web Services. PLAINTEXT переменные среды могут отображаться в виде простого текста в консоли CodeBuild и через командную строку. Для конфиденциальных значений рекомендуется использовать переменную среды типа PARAMETER_STORE или SECRETS_MANAGER.

type -> (string)

Тип переменной среды. Допустимые значения включают:

  • PARAMETER_STORE : Переменная среды, хранящаяся в хранилище параметров Systems Manager. Для переменных среды этого типа укажите имя параметра как value переменной EnvironmentVariable. Значение параметра будет заменено именем во время выполнения. Вы также можете определить переменные среды хранилища параметров в файле buildspec. Чтобы узнать как, см. env/parameter-store в руководстве пользователя CodeBuild.
  • PLAINTEXT : Переменная среды в формате простого текста. Это значение по умолчанию.
  • SECRETS_MANAGER : Переменная среды, хранящаяся в Secrets Manager. Для переменных среды этого типа укажите имя секрета как value переменной EnvironmentVariable. Значение секрета будет заменено именем во время выполнения. Вы также можете определить переменные среды Secrets Manager в файле buildspec. Чтобы узнать как, см. env/secrets-manager в руководстве пользователя CodeBuild.

privilegedMode -> (boolean)

Включает запуск Docker-демонов внутри контейнера Docker. Установите в значение true только если проект сборки используется для создания Docker-изображений. В противном случае сборка, пытающаяся взаимодействовать с Docker-демоном, завершается ошибкой. Значение по умолчанию - false.

Вы можете инициализировать Docker-демон на этапе установки вашей сборки, добавив один из следующих наборов команд в этап установки вашего файла buildspec:

Если базовый образ операционной системы - Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

Если базовый образ операционной системы - Alpine Linux и предыдущая команда не работает, добавьте аргумент -t к timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

certificate -> (string)

ARN Amazon S3-бакета, префикса пути и имени объекта, содержащего PEM-кодированный сертификат для проекта сборки. Дополнительную информацию см. в разделе certificate в руководстве пользователя CodeBuild.

registryCredential -> (structure)

Учетные данные для доступа к частному репозиторию.

credential -> (string)

Amazon Resource Name (ARN) или имя учетных данных, созданных с помощью Secrets Manager.

Примечание

credential может использовать имя учетных данных только в том случае, если они существуют в текущем регионе Amazon Web Services.

credentialProvider -> (string)

Сервис, создавший учетные данные для доступа к частному Docker-репозиторию. Допустимое значение SECRETS_MANAGER относится к Secrets Manager.

imagePullCredentialsType -> (string)

Тип учетных данных, которые CodeBuild использует для извлечения изображений в вашей сборке. Есть два допустимых значения:

  • CODEBUILD указывает, что CodeBuild использует свои собственные учетные данные. Это требует изменения политики вашего репозитория ECR для доверия сервисному принципалу CodeBuild.
  • SERVICE_ROLE указывает, что CodeBuild использует роль сервиса вашего проекта сборки.

При использовании изображения из другого аккаунта или частного репозитория, вы должны использовать учетные данные SERVICE_ROLE. При использовании предопределённого изображения CodeBuild, вы должны использовать CODEBUILD учетные данные.

dockerServer -> (structure)

Объект DockerServer для использования в этом проекте сборки.

computeType -> (string)

Информация о вычислительных ресурсах, используемых docker-сервером. Доступные значения включают:

  • BUILD_GENERAL1_SMALL : Используйте до 4 ГБ памяти и 2 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_MEDIUM : Используйте до 8 ГБ памяти и 4 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_LARGE : Используйте до 16 ГБ памяти и 8 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_XLARGE : Используйте до 64 ГБ памяти и 32 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_2XLARGE : Используйте до 128 ГБ памяти и 64 vCPU для вашего docker-сервера.

securityGroupIds -> (list)

Список одного или нескольких идентификаторов групп безопасности.

Примечание

Группы безопасности, настроенные для docker-серверов, должны разрешать входящий сетевой трафик из VPC, настроенной в проекте. Они должны разрешать входящий трафик на порт 9876.

(string)

status -> (structure)

Объект DockerServerStatus для использования с этим docker-сервером.

status -> (string)

Статус docker-сервера.

message -> (string)

Сообщение, связанное со статусом docker-сервера.

serviceRole -> (string)

ARN IAM-роли, которая позволяет CodeBuild взаимодействовать с зависимыми сервисами Amazon Web Services от имени учетной записи Amazon Web Services.

timeoutInMinutes -> (integer)

Время в минутах, от 5 до 2160 (36 часов), которое CodeBuild ожидает, прежде чем прервать любую связанную сборку, которая не была отмечена как завершённая. Значение по умолчанию 60 минут.

queuedTimeoutInMinutes -> (integer)

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

encryptionKey -> (string)

Ключ Customer Master Key (CMK) службы управления ключами, который будет использоваться для шифрования артефактов сборки.

Примечание

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

Вы можете указать либо ARN (Amazon Resource Name) CMK, либо, если доступно, псевдоним CMK (используя формат alias/<alias-name> ). Если вы не укажете значение, CodeBuild использует управляемый CMK для Amazon Simple Storage Service (Amazon S3).

tags -> (list)

Список пар ключ-значение тегов, связанных с этим проектом сборки.

Эти теги доступны для использования службами Amazon Web Services, которые поддерживают теги проектов сборки CodeBuild.

(structure)

Тег, состоящий из ключа и значения.

Этот тег доступен для использования службами Amazon Web Services, которые поддерживают теги в CodeBuild.

key -> (string)

Ключ тега.

value -> (string)

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

created -> (timestamp)

Когда был создан проект сборки, выражено в формате времени Unix.

lastModified -> (timestamp)

Когда настройки проекта сборки были изменены в последний раз, выражено в формате времени Unix.

webhook -> (structure)

Информация о веб-перехватчике, который связывает события репозитория с проектом сборки в CodeBuild.

url -> (string)

URL-адрес веб-перехватчика.

payloadUrl -> (string)

Конечная точка CodeBuild, куда отправляются события веб-перехватчика.

secret -> (string)

Секретный токен связанного репозитория.

Примечание

Веб-перехватчик Bitbucket не поддерживает secret .

branchFilter -> (string)

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

Примечание

Рекомендуется использовать filterGroups вместо branchFilter .

filterGroups -> (list)

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

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

(list)

(structure)

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

type -> (string)

Тип фильтра веб-перехватчика. Существует 11 типов фильтров веб-перехватчиков: EVENT , ACTOR_ACCOUNT_ID , HEAD_REF , BASE_REF , FILE_PATH , COMMIT_MESSAGE , TAG_NAME , RELEASE_NAME , REPOSITORY_NAME , ORGANIZATION_NAME и WORKFLOW_NAME .

  • EVENT

    • Веб-перехватчик запускает сборку, когда предоставленный pattern соответствует одному из девяти типов событий: PUSH , PULL_REQUEST_CREATED , PULL_REQUEST_UPDATED , PULL_REQUEST_CLOSED , PULL_REQUEST_REOPENED , PULL_REQUEST_MERGED , RELEASED , PRERELEASED и WORKFLOW_JOB_QUEUED . Шаблоны EVENT указываются в виде строки, разделенной запятыми. Например, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED фильтрует все события push, pull request created и pull request updated.

    Примечание

    Типы PULL_REQUEST_REOPENED и WORKFLOW_JOB_QUEUED работают только с GitHub и GitHub Enterprise. Типы RELEASED и PRERELEASED работают только с GitHub.

  • ACTOR_ACCOUNT_ID

    • Веб-перехватчик запускает сборку, когда ID учетной записи GitHub, GitHub Enterprise или Bitbucket соответствует регулярному выражению pattern .

  • HEAD_REF

    • Веб-перехватчик запускает сборку, когда ссылка head соответствует регулярному выражению pattern . Например, refs/heads/branch-name и refs/tags/tag-name .

    Примечание

    Работает с событиями push GitHub и GitHub Enterprise, pull request GitHub и GitHub Enterprise, push Bitbucket и pull request Bitbucket.

  • BASE_REF

    • Веб-перехватчик запускает сборку, когда базовая ссылка соответствует регулярному выражению pattern . Например, refs/heads/branch-name .

    Примечание

    Работает только с событиями pull request.

  • FILE_PATH

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

    Примечание

    Работает только с событиями push и pull request.

  • COMMIT_MESSAGE

    • Веб-перехватчик запускает сборку, когда сообщение фиксации head соответствует регулярному выражению pattern .

    Примечание

    Работает только с событиями push и pull request.

  • TAG_NAME

    • Веб-перехватчик запускает сборку, когда имя тега релиза соответствует регулярному выражению pattern .

    Примечание

    Работает только с событиями RELEASED и PRERELEASED .

  • RELEASE_NAME

    • Веб-перехватчик запускает сборку, когда имя релиза соответствует регулярному выражению pattern .

    Примечание

    Работает только с событиями RELEASED и PRERELEASED .

  • REPOSITORY_NAME

    • Веб-перехватчик запускает сборку, когда имя репозитория соответствует регулярному выражению pattern .

    Примечание

    Работает только с глобальными веб-перехватчиками GitHub или веб-перехватчиками организации.

  • ORGANIZATION_NAME

    • Веб-перехватчик запускает сборку, когда имя организации соответствует регулярному выражению pattern .

    Примечание

    Работает только с глобальными веб-перехватчиками GitHub.

  • WORKFLOW_NAME

    • Веб-перехватчик запускает сборку, когда имя рабочего процесса соответствует регулярному выражению pattern .

    Примечание

    Работает только с событиями WORKFLOW_JOB_QUEUED .

    Примечание

    Для сборок раннера Buildkite, размещенных CodeBuild, фильтры WORKFLOW_NAME будут фильтровать по имени конвейера.

pattern -> (string)

Для WebHookFilter , который использует тип EVENT , строка, разделенная запятыми, которая указывает одно или несколько событий. Например, фильтр веб-перехватчика PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED позволяет всем событиям push, pull request created и pull request updated запускать сборку.

Для WebHookFilter , который использует любой из других типов фильтров, шаблон регулярного выражения. Например, WebHookFilter , который использует HEAD_REF для своего type и шаблон ^refs/heads/ , запускает сборку, когда ссылка head является веткой с именем ссылки refs/heads/branch-name .

excludeMatchedPattern -> (boolean)

Используется для указания того, что pattern определяет, какие события веб-перехватчика не запускают сборку. Если true, то событие веб-перехватчика, которое не соответствует pattern , запускает сборку. Если false, то событие веб-перехватчика, которое соответствует pattern , запускает сборку.

buildType -> (string)

Указывает тип сборки, который будет запускать этот веб-перехватчик.

Примечание

RUNNER_BUILDKITE_BUILD доступен только для проектов с типом источника NO_SOURCE , настроенных для сборок раннера Buildkite. Для получения дополнительной информации о сборках раннера Buildkite, размещенных CodeBuild, см. Руководство: Configure a CodeBuild-hosted Buildkite runner в руководстве пользователя CodeBuild .

manualCreation -> (boolean)

Если manualCreation имеет значение true, CodeBuild не создает веб-перехватчик в GitHub, а вместо этого возвращает значения payloadUrl и secret для веб-перехватчика. Значения payloadUrl и secret в выводе можно использовать для ручного создания веб-перехватчика в GitHub.

Примечание

manualCreation доступен только для веб-перехватчиков GitHub.

lastModifiedSecret -> (timestamp)

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

scopeConfiguration -> (structure)

Настройка области действия для глобальных веб-перехватчиков или веб-перехватчиков организации.

Примечание

Глобальные веб-перехватчики или веб-перехватчики организации доступны только для веб-перехватчиков GitHub и Github Enterprise.

name -> (string)

Имя группы, предприятия или организации, которая будет отправлять события веб-перехватчика в CodeBuild, в зависимости от типа веб-перехватчика.

domain -> (string)

Домен организации GitHub Enterprise или группы GitLab Self Managed. Обратите внимание, что этот параметр требуется только в том случае, если типом источника вашего проекта является GITHUB_ENTERPRISE или GITLAB_SELF_MANAGED.

scope -> (string)

Тип области действия для веб-перехватчика GitHub или GitLab. Область действия по умолчанию — GITHUB_ORGANIZATION.

status -> (string)

Состояние веб-перехватчика. Допустимые значения включают:

  • CREATING : Веб-перехватчик создается.
  • CREATE_FAILED : Не удалось создать веб-перехватчик.
  • ACTIVE : Веб-перехватчик успешно создан и активен.
  • DELETING : Веб-перехватчик удаляется.

statusMessage -> (string)

Сообщение, связанное с состоянием веб-перехватчика.

vpcConfig -> (structure)

Информация о конфигурации VPC, к которой CodeBuild имеет доступ.

vpcId -> (string)

Идентификатор Amazon VPC.

subnets -> (list)

Список одного или нескольких идентификаторов подсетей в вашей Amazon VPC.

(string)

securityGroupIds -> (list)

Список одного или нескольких идентификаторов групп безопасности в вашей Amazon VPC.

(string)

badge -> (structure)

Информация о значке сборки для проекта сборки.

badgeEnabled -> (boolean)

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

badgeRequestUrl -> (string)

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

logsConfig -> (structure)

Информация о журналах для проекта сборки. Проект может создавать журналы в CloudWatch Logs, в ведре S3 или в обоих.

cloudWatchLogs -> (structure)

Информация о CloudWatch Logs для проекта сборки. CloudWatch Logs включены по умолчанию.

status -> (string)

Текущий статус журналов в CloudWatch Logs для проекта сборки. Допустимые значения:

  • ENABLED : CloudWatch Logs включены для этого проекта сборки.
  • DISABLED : CloudWatch Logs не включены для этого проекта сборки.

groupName -> (string)

Имя группы журналов в CloudWatch Logs. Дополнительная информация: Работа с группами и потоками журналов.

streamName -> (string)

Префикс имени потока CloudWatch Logs. Дополнительная информация: Работа с группами и потоками журналов.

s3Logs -> (structure)

Информация о журналах, созданных в ведре S3 для проекта сборки. Журналы S3 по умолчанию не включены.

status -> (string)

Текущий статус журналов сборки в S3. Допустимые значения:

  • ENABLED : Журналы сборки S3 включены для этого проекта сборки.
  • DISABLED : Журналы сборки S3 не включены для этого проекта сборки.

location -> (string)

ARN ведра S3 и префикс пути для журналов S3. Если ваше имя ведра Amazon S3 — my-bucket , а префикс пути — build-log , то допустимые форматы — my-bucket/build-log или arn:aws:s3:::my-bucket/build-log .

encryptionDisabled -> (boolean)

Установите в true, если вы не хотите шифровать выходные данные журналов сборки S3. По умолчанию журналы сборки S3 шифруются.

bucketOwnerAccess -> (string)

Указывает доступ владельца ведра для объектов, загруженных другим аккаунтом в ведро Amazon S3. По умолчанию доступ к этим объектам имеет только аккаунт, загрузивший их в ведро. Это свойство позволяет предоставить доступ к этим объектам владельцу ведра.

Примечание

Чтобы использовать это свойство, ваша роль службы CodeBuild должна иметь разрешение s3:PutBucketAcl . Это разрешение позволяет CodeBuild изменять список управления доступом для ведра.

Это свойство может принимать следующие значения:

NONE

Владелец ведра не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

Владелец ведра имеет доступ для чтения к объектам. Загружающий аккаунт сохраняет владение объектами.

FULL

Владелец ведра имеет полный доступ к объектам. Владение объектами определяется следующими критериями:

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

Дополнительную информацию о владении объектами Amazon S3 см. в разделе Управление владением загруженными объектами с помощью владения объектами S3 в Руководстве пользователя Amazon Simple Storage Service.

fileSystemLocations -> (list)

Массив объектов ProjectFileSystemLocation для проекта сборки CodeBuild. Объект ProjectFileSystemLocation указывает identifier , location , mountOptions , mountPoint и type файловой системы, созданной с помощью Amazon Elastic File System.

(structure)

Информация о файловой системе, созданной Amazon Elastic File System (EFS). Дополнительная информация: Что такое Amazon Elastic File System?

type -> (string)

Тип файловой системы. Поддерживается только тип EFS .

location -> (string)

Строка, которая указывает расположение файловой системы, созданной Amazon EFS. Ее формат — efs-dns-name:/directory-path . DNS-имя файловой системы можно найти в консоли Amazon EFS. Путь к каталогу — путь к каталогу в файловой системе, который монтирует CodeBuild. Например, если DNS-имя файловой системы — fs-abcd1234.efs.us-west-2.amazonaws.com , а каталог монтирования — my-efs-mount-directory , то location — fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory .

Путь к каталогу в формате efs-dns-name:/directory-path необязателен. Если путь к каталогу не указан, расположением будет только DNS-имя, и CodeBuild смонтирует всю файловую систему.

mountPoint -> (string)

Расположение в контейнере, где вы монтируете файловую систему.

identifier -> (string)

Имя, используемое для доступа к файловой системе, созданной Amazon EFS. CodeBuild создает переменную окружения, добавляя identifier в верхнем регистре к CODEBUILD_ . Например, если вы укажете my_efs для identifier , новая переменная окружения будет создана под именем CODEBUILD_MY_EFS .

identifier используется для монтирования вашей файловой системы.

mountOptions -> (string)

Параметры монтирования файловой системы, созданной Amazon EFS. Параметры монтирования, используемые CodeBuild по умолчанию, — nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2 . Дополнительная информация: Рекомендованные параметры монтирования NFS.

buildBatchConfig -> (structure)

Объект ProjectBuildBatchConfig, определяющий параметры пакетной сборки для проекта.

serviceRole -> (string)

Указывает ARN роли службы для проекта пакетной сборки.

combineArtifacts -> (boolean)

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

restrictions -> (structure)

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

maximumBuildsAllowed -> (integer)

Указывает максимальное количество разрешенных сборок.

computeTypesAllowed -> (list)

Массив строк, которые указывают типы вычислительных ресурсов, разрешенные для пакетной сборки. См. Типы вычислительных ресурсов среды сборки в Руководстве пользователя CodeBuild для этих значений.

(string)

fleetsAllowed -> (list)

Массив строк, которые указывают флоты, разрешенные для пакетной сборки. См. Выполнение сборок на резервируемых флотах емкостей в Руководстве пользователя CodeBuild для получения дополнительной информации.

(string)

timeoutInMins -> (integer)

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

batchReportMode -> (string)

Указывает, как отчеты о статусе сборки отправляются поставщику исходного кода для пакетной сборки. Это свойство используется только при поставщике исходного кода вашего проекта Bitbucket, GitHub или GitHub Enterprise и при настроенном отправлении отчетов о статусе сборки поставщику исходного кода.

REPORT_AGGREGATED_BATCH

(По умолчанию) Объединить все статусы сборок в один отчет.

REPORT_INDIVIDUAL_BUILDS

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

concurrentBuildLimit -> (integer)

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

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

projectVisibility -> (string)

Указывает видимость сборок проекта. Возможные значения:

PUBLIC_READ

Сборки проекта видны всем.

PRIVATE

Сборки проекта не видны всем.

publicProjectAlias -> (string)

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

resourceAccessRole -> (string)

ARN роли IAM, которая позволяет CodeBuild получать доступ к CloudWatch Logs и артефактам Amazon S3 для сборок проекта.

autoRetryLimit -> (integer)

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

projectsNotFound -> (list)

Имена проектов сборки, информация о которых не найдена.

(string)

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

Spec-Zone.ru

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