Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

retry-build-batch

Описание

Повторно запускает проваленный пакетный сбор. Повторно запустить можно только пакетные сборки, которые завершились ошибкой.

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

Синтаксис

  retry-build-batch
[--id <value>]
[--idempotency-token <value>]
[--retry-type <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]

Параметры

--id (строка)

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

--idempotency-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы гарантировать идемпотентность запроса RetryBuildBatch. Токен включается в запрос RetryBuildBatch и действителен в течение пяти минут. Если вы повторяете запрос RetryBuildBatch с тем же токеном, но изменяете параметр, CodeBuild возвращает ошибку несоответствия параметров.

--retry-type (строка)

Указывает тип повторного выполнения.

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

  • RETRY_ALL_BUILDS
  • RETRY_FAILED_BUILDS

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

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

Включить отладочную регистрацию.

--endpoint-url (строка)

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

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

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

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

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

--output (строка)

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

  • json
  • text
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для повторного запуска проваленной пакетной сборки в AWS CodeBuild.

Следующий пример повторно запускает указанную пакетную сборку.

aws codebuild retry-build-batch \
    --id <project-name>:<batch-ID>

Вывод:

{
    "buildBatch": {
        "id": "<project-name>:<batch-ID>",
        "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build-batch/<project-name>:<batch-ID>",
        "startTime": "2020-10-21T17:26:23.099000+00:00",
        "currentPhase": "SUBMITTED",
        "buildBatchStatus": "IN_PROGRESS",
        "resolvedSourceVersion": "3a9e11cb419e8fff14b03883dc4e64f6155aaa7e",
        "projectName": "<project-name>",
        "phases": [
            {
                "phaseType": "SUBMITTED",
                "phaseStatus": "SUCCEEDED",
                "startTime": "2020-10-21T17:26:23.099000+00:00",
                "endTime": "2020-10-21T17:26:23.457000+00:00",
                "durationInSeconds": 0
            },
            {
                "phaseType": "DOWNLOAD_BATCHSPEC",
                "phaseStatus": "SUCCEEDED",
                "startTime": "2020-10-21T17:26:23.457000+00:00",
                "endTime": "2020-10-21T17:26:54.902000+00:00",
                "durationInSeconds": 31
            },
            {
                "phaseType": "IN_PROGRESS",
                "phaseStatus": "CLIENT_ERROR",
                "startTime": "2020-10-21T17:26:54.902000+00:00",
                "endTime": "2020-10-21T17:28:16.060000+00:00",
                "durationInSeconds": 81
            },
            {
                "phaseType": "FAILED",
                "phaseStatus": "RETRY",
                "startTime": "2020-10-21T17:28:16.060000+00:00",
                "endTime": "2020-10-21T17:29:39.709000+00:00",
                "durationInSeconds": 83
            },
            {
                "phaseType": "SUBMITTED",
                "startTime": "2020-10-21T17:29:39.709000+00:00"
            }
        ],
        "source": {
            "type": "GITHUB",
            "location": "https://github.com/strohm-a/<project-name>-graph.git",
            "gitCloneDepth": 1,
            "gitSubmodulesConfig": {
                "fetchSubmodules": false
            },
            "reportBuildStatus": false,
            "insecureSsl": false
        },
        "secondarySources": [],
        "secondarySourceVersions": [],
        "artifacts": {
            "location": ""
        },
        "secondaryArtifacts": [],
        "cache": {
            "type": "NO_CACHE"
        },
        "environment": {
            "type": "LINUX_CONTAINER",
            "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
            "computeType": "BUILD_GENERAL1_SMALL",
            "environmentVariables": [],
            "privilegedMode": false,
            "imagePullCredentialsType": "CODEBUILD"
        },
        "logConfig": {
            "cloudWatchLogs": {
                "status": "ENABLED"
            },
            "s3Logs": {
                "status": "DISABLED",
                "encryptionDisabled": false
            }
        },
        "buildTimeoutInMinutes": 60,
        "queuedTimeoutInMinutes": 480,
        "complete": false,
        "initiator": "<username>",
        "encryptionKey": "arn:aws:kms:<region-ID>:<account-ID>:alias/aws/s3",
        "buildBatchNumber": 4,
        "buildBatchConfig": {
            "serviceRole": "arn:aws:iam::<account-ID>:role/service-role/<project-name>",
            "restrictions": {
                "maximumBuildsAllowed": 100
            },
            "timeoutInMins": 480
        },
        "buildGroups": [
            {
                "identifier": "DOWNLOAD_SOURCE",
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T17:26:23.889000+00:00",
                    "buildStatus": "SUCCEEDED",
                    "primaryArtifact": {
                        "type": "no_artifacts",
                        "identifier": "DOWNLOAD_SOURCE"
                    },
                    "secondaryArtifacts": []
                }
            },
            {
                "identifier": "linux_small",
                "dependsOn": [],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T17:26:55.115000+00:00",
                    "buildStatus": "FAILED",
                    "primaryArtifact": {
                        "type": "no_artifacts",
                        "identifier": "linux_small"
                    },
                    "secondaryArtifacts": []
                }
            },
            {
                "identifier": "linux_medium",
                "dependsOn": [
                    "linux_small"
                ],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T17:26:54.594000+00:00",
                    "buildStatus": "STOPPED"
                }
            },
            {
                "identifier": "linux_large",
                "dependsOn": [
                    "linux_medium"
                ],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T17:26:54.701000+00:00",
                    "buildStatus": "STOPPED"
                }
            }
        ]
    }
}

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

Вывод

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

Содержит информацию о пакетной сборке.

id -> (строка)

Идентификатор пакетной сборки.

arn -> (строка)

ARN пакетной сборки.

startTime -> (метка времени)

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

endTime -> (метка времени)

Дата и время завершения пакетной сборки.

currentPhase -> (строка)

Текущая фаза пакетной сборки.

buildBatchStatus -> (строка)

Статус пакетной сборки.

sourceVersion -> (строка)

Идентификатор версии исходного кода, который нужно собрать.

resolvedSourceVersion -> (строка)

Идентификатор разрешенной версии исходного кода этой пакетной сборки.

  • Для CodeCommit, GitHub, GitHub Enterprise и BitBucket — идентификатор коммита.
  • Для CodePipeline — ревизия исходного кода, предоставленная CodePipeline.
  • Для Amazon S3 — это не применимо.

projectName -> (строка)

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

phases -> (список)

Массив объектов BuildBatchPhase, определяющих фазы пакетной сборки.

(структура)

Содержит информацию о стадии пакетной сборки.

phaseType -> (строка)

Имя фазы пакетной сборки. Допустимые значения:

COMBINE_ARTIFACTS

Артефакты выходных данных сборки объединяются и загружаются в местоположение вывода.

DOWNLOAD_BATCHSPEC

Спецификация пакетной сборки загружается.

FAILED

Одна или несколько сборок завершились ошибкой.

IN_PROGRESS

Пакетная сборка выполняется.

STOPPED

Пакетная сборка была остановлена.

SUBMITTED

Пакетная сборка была отправлена.

SUCCEEDED

Пакетная сборка выполнена успешно.

phaseStatus -> (строка)

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

FAILED

Фаза сборки завершилась ошибкой.

FAULT

Фаза сборки завершилась с ошибкой.

IN_PROGRESS

Фаза сборки еще выполняется.

STOPPED

Фаза сборки остановлена.

SUCCEEDED

Фаза сборки выполнена успешно.

TIMED_OUT

Фаза сборки истекла.

startTime -> (метка времени)

Когда началась фаза пакетной сборки в формате Unix time.

endTime -> (метка времени)

Когда закончилась фаза пакетной сборки в формате Unix time.

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

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

contexts -> (список)

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

(структура)

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

statusCode -> (строка)

Код состояния контекста фазы сборки.

message -> (строка)

Объяснение контекста фазы сборки. Может содержать ID команды и код возврата.

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-ссылка для клонирования хранилища, содержащего исходный код и файл 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 в OAUTH .
  • Для исходного кода в хранилище GitLab или самоуправляемом хранилище GitLab - HTTPS-ссылка для клонирования хранилища, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitLab на странице Авторизовать приложение выберите Авторизовать . Затем на странице Создать подключение GitLab выберите Подключиться к GitLab. (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете покинуть консоль CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение объекта auth в CODECONNECTIONS в объекте source.
  • Для исходного кода в хранилище Bitbucket - HTTPS-ссылка для клонирования хранилища, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к Bitbucket на странице Подтвердить доступ к вашей учетной записи выберите Предоставить доступ . (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете покинуть консоль CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth в 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 по сборке.

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 символов.

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-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 для доступа к исходному коду, который необходимо собрать.

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

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

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

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

reportBuildStatus -> (булево)

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

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

Статус сборки, вызванной webhook, всегда сообщается поставщику исходного кода.

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

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

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

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

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

secondarySourceVersions -> (список)

Массив объектов ProjectSourceVersion. Каждый объект ProjectSourceVersion должен быть одним из:

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

(структура)

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

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

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

location -> (строка)

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

sha256sum -> (строка)

Хеш SHA-256 артефакта сборки.

Вы можете использовать этот хеш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP .

md5sum -> (строка)

Хеш MD5 артефакта сборки.

Вы можете использовать этот хеш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP .

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

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

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

Информация о том, отключено ли шифрование для артефактов сборки.

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 -> (список)

Массив объектов BuildArtifacts, определяющих артефакты сборки для этой пакетной сборки.

(структура)

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

location -> (строка)

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

sha256sum -> (строка)

Хеш SHA-256 артефакта сборки.

Вы можете использовать этот хеш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP .

md5sum -> (строка)

Хеш MD5 артефакта сборки.

Вы можете использовать этот хеш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP .

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

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

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

Информация о том, отключено ли шифрование для артефактов сборки.

artifactIdentifier -> (строка)

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

bucketOwnerAccess -> (строка)

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

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

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

type -> (строка)

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

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

location -> (строка)

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

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

modes -> (список)

Массив строк, определяющих режимы локального кэша. Вы можете использовать один или несколько режимов локального кэша одновременно. Это используется только для кэша типа 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 -> (строка)

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

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

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

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 для сборок.
  • Для типа среды ARM_CONTAINER вы можете использовать до 4 ГБ памяти и 2 vCPU на процессорах на базе ARM для сборок.

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

  • Для типа среды LINUX_CONTAINER вы можете использовать до 16 ГБ памяти и 8 vCPU для сборок.
  • Для типа среды LINUX_GPU_CONTAINER вы можете использовать до 255 ГБ памяти, 32 vCPU и 4 графических процессора NVIDIA Tesla V100 для сборок.
  • Для типа среды 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)

Имя роли службы, используемой для сборок в пачке.

logConfig -> (structure)

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

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

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

status -> (строка)

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

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

groupName -> (строка)

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

streamName -> (строка)

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

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

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

status -> (строка)

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

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

location -> (строка)

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

encryptionDisabled -> (булево)

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

bucketOwnerAccess -> (строка)

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

buildTimeoutInMinutes -> (целое)

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

queuedTimeoutInMinutes -> (целое)

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

complete -> (булево)

Указывает, завершена ли пакетная сборка.

initiator -> (строка)

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

  • Если сборку запустил CodePipeline, имя пайплайна (например, codepipeline/my-demo-pipeline).
  • Если сборку запустил пользователь, имя пользователя.
  • Если сборку запустил плагин Jenkins для CodeBuild, строка CodeBuild-Jenkins-Plugin.

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

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

vpcId -> (строка)

ID Amazon VPC.

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

encryptionKey -> (строка)

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

Примечание

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

Можно указать либо Amazon Resource Name (ARN) CMK, либо, если доступно, псевдоним CMK (в формате alias/<alias-name>).

buildBatchNumber -> (длинное целое)

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

fileSystemLocations -> (список)

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

(структура)

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

type -> (строка)

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

location -> (строка)

Строка, которая указывает расположение файловой системы, созданной с помощью 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 -> (строка)

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

identifier -> (строка)

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

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

mountOptions -> (строка)

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

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

Содержит конфигурационную информацию о проекте пакетной сборки.

serviceRole -> (строка)

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

combineArtifacts -> (булево)

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

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

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

maximumBuildsAllowed -> (целое)

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

computeTypesAllowed -> (список)

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

(строка)

fleetsAllowed -> (список)

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

(строка)

timeoutInMins -> (целое)

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

batchReportMode -> (строка)

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

REPORT_AGGREGATED_BATCH

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

REPORT_INDIVIDUAL_BUILDS

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

buildGroups -> (список)

Массив объектов BuildGroup, определяющих группы сборки для пакетной сборки.

(структура)

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

identifier -> (строка)

Содержит идентификатор группы сборки.

dependsOn -> (список)

Массив строк, содержащих идентификаторы групп сборки, от которых зависит эта группа сборки.

(строка)

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

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

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

Объект BuildSummary, содержащий сводку текущей группы сборки.

arn -> (строка)

ARN пакетной сборки.

requestedOn -> (отметка времени)

Время начала сборки в формате Unix.

buildStatus -> (строка)

Статус группы сборки.

FAILED

Группа сборки завершилась неудачно.

FAULT

Группа сборки завершилась с ошибкой.

IN_PROGRESS

Группа сборки всё ещё выполняется.

STOPPED

Группа сборки остановлена.

SUCCEEDED

Группа сборки завершилась успешно.

TIMED_OUT

Группа сборки завершилась по истечении времени.

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

Объект ResolvedArtifact, представляющий основные артефакты сборки для группы сборки.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

secondaryArtifacts -> (список)

Массив объектов ResolvedArtifact, представляющих вторичные артефакты сборки для группы сборки.

(структура)

Представляет разрешенный артефакт сборки. Разрешенный артефакт — это артефакт, который был собран и развернут в конечном пункте назначения, например, в Amazon S3.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

priorBuildSummaryList -> (список)

Массив объектов BuildSummary, содержащих сводки предыдущих групп сборки.

(структура)

Содержит сводную информацию о группе сборки пакетной сборки.

arn -> (строка)

ARN пакетной сборки.

requestedOn -> (отметка времени)

Время начала сборки в формате Unix.

buildStatus -> (строка)

Статус группы сборки.

FAILED

Группа сборки завершилась неудачно.

FAULT

Группа сборки завершилась с ошибкой.

IN_PROGRESS

Группа сборки всё ещё выполняется.

STOPPED

Группа сборки остановлена.

SUCCEEDED

Группа сборки завершилась успешно.

TIMED_OUT

Группа сборки завершилась по истечении времени.

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

Объект ResolvedArtifact, представляющий основные артефакты сборки для группы сборки.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

secondaryArtifacts -> (список)

Массив объектов ResolvedArtifact, представляющих вторичные артефакты сборки для группы сборки.

(структура)

Представляет разрешенный артефакт сборки. Разрешенный артефакт — это артефакт, который был собран и развернут в конечном пункте назначения, например, в Amazon S3.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

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

Указывает, включена ли отладка сеанса для этой пакетной сборки. Дополнительную информацию см. в разделе Просмотр выполняемой сборки в Session Manager. Отладка сеанса пакетной сборки не поддерживается для пакетных сборок матрицы.

reportArns -> (список)

Массив, содержащий ARN созданных отчётов, полученных путём объединения отчётов из сборок, связанных с этой пакетной сборкой.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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